このAPIのサポートはまもなく終了します。最新バージョンもしくは他のAPIを利用してください。

    トーク Bot の修正

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

    トーク Bot のトークルームへの招待形式を指定できます。
    既定値は「1:1 トークのみ可」です。「複数人のトークルームに招待可」を指定することもできます。

    useGroupJoin の値を変更して「複数人のトークルームに招待可」の設定を解除すると、チーム/グループトークルームおよび 1:N トークルームに招待された Bot は退室します。

    トーク Bot の利用可能なドメインを変更すると、ドメインリストから外れたドメインでは、Bot が自動的に削除されます。

    注意

    • Bot 名に改行文字を入れると空白として処理されます。

    API の種類

    サーバー API

    Request URL

    https://apis.worksmobile.com/{API ID}/message/updateBot/v4

    HTTP Method

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

    Request

    パラメーター タイプ 必須 説明
    botNo number Y 修正するトーク Bot 番号
    name string Y トーク Bot 名。
    最大 100 文字
    i18nNames[] array N 多言語名のリスト。
    i18nNames[].language string Y 言語コード。
    ●ko_KR
    ●ja_JP
    ●zh_CN
    ●zh_TW
    ●en_US
    i18nNames[].name string Y トーク Bot 名。
    最大 100 文字
    photoUrl string Y トーク Bot プロフィール画像の URL (PNG 形式, HTTPS のみ可能)。
    最大 1,000 文字
    i18nPhotoUrls[] array N 多言語の画像の URL リスト。
    i18nPhotoUrls[].language string Y 言語コード。
    ●ko_KR
    ●ja_JP
    ●zh_CN
    ●zh_TW
    ●en_US
    i18nPhotoUrls[].photoUrl string Y 画像の URL。
    最大 1,000 文字
    description string Y トーク Bot の説明。
    最大 100 文字
    i18nDescriptions[] array N 多言語のトーク Bot の説明リスト。
    i18nDescriptions[].language string Y 言語コード。
    ●ko_KR
    ●ja_JP
    ●zh_CN
    ●zh_TW
    ●en_US
    i18nDescriptions[].description string Y トーク Bot の説明。
    最大 100 文字
    managerList array<string> Y トーク Bot 担当者の LINE WORKS アカウントリスト (1 人は必須。最大 3 人まで)。
    submanagerList array<string> N トーク Bot 副担当者の LINE WORKS アカウントリスト(最大 3 人まで)。
    useGroupJoin boolean N トークルームへの招待形式。
    ● false: 1:1 トークのみ可 (既定)
    true: 複数人のトークルームに招待可
    useDomainScope boolean N トーク Bot を利用可能なドメインの範囲。
    ●false: 全ドメインで利用可 (既定)
    ●true: 指定ドメインのみ利用可
    domainIdList array<number> N useDomainScope が true の場合、ドメインリストを指定。
    1 個以上が必須。

    Request Example

    {
      "botNo": 123,
      "name": "echo bot",
      "i18nNames": [{
        "language": "ko_KR",
        "name": "에코봇"
      }, {
        "language": "ja_JP",
        "name": "エコー Bot"
      }],
      "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": "ワークスモバイルの AI とトーク可能な Bot"
      }],
      "managerList": ["manager@example.com", "manager2@example.com"],
      "submanagerList": ["submanager@example.com"],
      "useGroupJoin": true,
      "useDomainScope": false
    }
    

    Response

    呼び出しに成功すると code 200 を返します。

    {"code": 200, "message": "OK"}