トーク Bot の修正

    登録されているトーク Bot の情報を修正します。

    各パラメータの説明はトークBotのドメイン登録API を参照してください。

    useGroupJoin を true から false に変更した場合、チーム/グループトークルームおよび 1:N トークルームに招待された Bot は退室します。

    useDomainScope が true の時に domainIds のリストを変更した場合、リストから外れたドメインでは Bot が削除されます。

    メッセージ受信サーバーに空の文字列を設定するとメッセージ受信サーバー情報が削除され、 callback を送信しません。

    注意

    • Bot 名に改行文字を入れると空白として処理されます。
    • セキュリティ上の理由から callbackURL に自己署名された証明書は利用できません。
    • 利用可能なルート認証局のリストは CA リストを参照してください。

    API の種類

    サーバー API

    Request URL

    https://apis.worksmobile.com/r/{API ID}/message/v1/bot/{botNo}

    HTTP Method

    PUT (Content-Type: application/json; charset=UTF-8)

    Path Parameters

    パラメーター 必須 説明
    botNo Y 修正するトーク Bot 番号

    Request

    common

    パラメーター タイプ 必須 説明
    name string Y トーク Bot 名
    最大 100 文字
    photoUrl string Y トーク Bot プロフィール画像の URL(PNG 形式、HTTPS のみ可能)。
    最大 1000 文字
    description string Y トーク Bot の説明
    最大 100 文字
    managers array<string> Y トーク Bot 担当者の アカウントリスト (1 人は必須。最大 3 人まで)。
    submanagers array<string> N トーク Bot 副担当者の アカウントリスト(最大 3 人まで)。
    useGroupJoin boolean N トークルームへの招待形式
    ● true: 複数人のトークルームに招待可
    ● false: 1:1 トークのみ可 (既定)
    useDomainScope boolean N トーク Bot の利用範囲
    ● true: 指定ドメインのみ
    ● false: 全ドメイン (既定)
    domainIds array<number> N useDomainScopeがtrueの場合は必須で、ドメインリストを指定
    1個以上が必須。
    useCallback boolean N callback の利用
    ● true: On
    ● false: Off(既定値)
    callbackUrl string N メッセージ受信サーバーの URL
    useCallback が true の場合は必須。HTTPSのみ可。
    callbackEvents array<string> N メンバーが送信可能なメッセージタイプ
    useCallbackがtrueの場合は必須。
    ● "text": テキスト
    ● "location": 位置情報
    ● "sticker": スタンプ
    ● "image": 画像
    ● "file": ファイル

    multi language

    パラメーター タイプ 必須 説明
    i18nNames[] array N 多言語名のリスト
    i18nNames[].language string Y 言語コード
    ●ja_JP
    ●ko_KR
    ●zh_CN
    ●zh_TW
    ●en_US
    i18nNames[].name string Y 各言語のトーク Bot 名
    最大 100 文字
    i18nPhotoUrls[] array N 各言語でのプロフィール画像リスト (URL)
    i18nPhotoUrls[].language string Y 言語コード
    ●ja_JP
    ●ko_KR
    ●zh_CN
    ●zh_TW
    ●en_US
    i18nPhotoUrls[].photoUrl string Y 画像の URL
    最大 1000 文字
    i18nDescriptions[] array N 各言語での説明リスト
    i18nDescriptions[].language string Y 言語コード
    ●ja_JP
    ●ko_KR
    ●zh_CN
    ●zh_TW
    ●en_US
    i18nDescriptions[].description string Y 説明
    最大 100 文字

    Request Example

    simple

    
PUT https://apis.worksmobile.com/r/apiid/message/v1/bot/123
{
  "name": "echo bot",
  "photoUrl": "https://developers.worksmobile.com/favicon.png",
  "description": "WorksMobile's A.I. conversation enabled bot",
  "managers": ["manager@example.com", "manager2@example.com"]
}
    detail 
    
PUT https://apis.worksmobile.com/r/apiid/message/v1/bot/123
{
  "name": "echo bot",
  "i18nNames": [{
    "language": "ko_KR",
    "name": "에코봇"
  }, {
    "language": "ja_JP",
    "name": "エコボッ"
  }],
  "photoUrl": "https://developers.worksmobile.com/favicon.png",
  "i18nPhotoUrls": [{
    "language": "ko_KR",
    "photoUrl": "https://developers.worksmobile.com/favicon.png"
  },{
    "language": "ja_JP",
    "photoUrl": "https://developers.worksmobile.com/favicon.png"
  }],
  "description": "WorksMobile's A.I. conversation enabled bot",
  "i18nDescriptions": [{
    "language": "ko_KR",
    "description": "웍스모바일의 A.I 대화가 가능한 봇"
  },{
    "language": "ja_JP",
    "description": "ワークスモバイルのA.I対話が可能なボット"
  }],
  "managers": ["manager@example.com", "manager2@example.com"],
  "submanagers": ["submanager@example.com"],
  "useGroupJoin": true,
  "useDomainScope": false,
  "useCallback": true,
  "callbackUrl": "https://xxx",
  "callbackEvents": ["text", "location", "sticker", "image", "file"]
}

    Response

    呼び出しに成功すると HTTP 200 コードを返します。

    Error Code

    呼び出しに失敗するとエラーコードとエラーメッセージを返します。
    エラーコードはトーク Bot REST APIエラーコードを参照してください。