トーク Bot のテナント登録

    トーク Bot のテナント登録

    トーク Bot をテナントに登録します。
    実際にトーク Bot を利用するためには、テナント登録に加えて各ドメインへの登録も必要です。
    トーク Bot のドメイン登録は registerBotDomain API を使用します。

    トーク Bot の利用範囲はドメイン単位で指定できます。
    既定値は「全ドメイン」です。特定ドメインのみに利用範囲を制限することもできます。

    トーク Bot 登録は多言語に対応しています。
    Bot 名、画像、説明文を多言語で登録することができ、Bot 利用時はメンバーの言語設定に合わせた表示が適用されます。

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

    注意

    • トーク Bot は最大 300 個まで登録できます。
    • Bot 名に改行文字を入れると空白として処理されます。

    API の種類

    サーバー API

    Request URL

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

    HTTP Method

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

    Request

    パラメーター タイプ 必須 説明
    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 多言語名。
    最大 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

    {
      "name": "echo bot",
      "i18nNames": [{
        "language": "ko_KR",
        "name": "에코봇"
      }, {
        "language": "ja_JP",
        "name": "エコー Bot"
      }],
      "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

    呼び出しに成功するとトーク Bot 番号を返します。

    プロパティ タイプ 説明
    code number ● 200: 成功
    ● 400番台: クライアントリクエストエラー
    ● 500番台: 想定外のエラー/サーバー内部エラー
    message string コードについての詳細メッセージ。
    botNo number 登録されたトーク Bot 番号。

    Response Example

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