トーク Bot のテナント登録

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

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

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

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

    メッセージ受信サーバーは HTTPS のみ利用可能です。空の文字列を設定するとメッセージ受信サーバー情報が削除され、 callback を送信しません。
    メンバーが送信可能なメッセージタイプは callbackEventList で指定します。
    指定したメッセージタイプ以外の項目はグレーアウトして、メンバーから送信できません。

    注意

    • トーク Bot は最大 300 個 (フリープランでは 10 個) まで登録できます。
    • Bot 名に改行文字を入れると空白として処理されます。
    • callbackUrlは, セキュリティ上の理由から自己署名された証明書は利用できません。
    • 利用可能なルート認証局のリストは, CA リストを参照してください。

    API の種類

    サーバー API

    Request URL

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

    HTTP Method

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

    Request

    common

    パラメーター タイプ 必須 説明
    name string Y トーク Bot 名
    最大 100 文字
    photoUrl string Y トーク Bot プロフィール画像の URL(PNG 形式, 640×640 サイズを推奨します, HTTPS のみ可能)
    最大 1000 文字
    description string Y トーク Bot の説明
    最大 100 文字
    managers array<string> Y トーク Bot 担当者の LINE WORKS アカウントリスト (1 人は必須。最大 3 人まで)
    submanagers array<string> N トーク Bot 副担当者の LINE WORKS アカウントリスト(最大 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

    
    POST https://apis.worksmobile.com/r/apiid/message/v1/bot
    {
      "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
    
    POST https://apis.worksmobile.com/r/apiid/message/v1/bot
    {
      "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 とトーク Bot 番号を返します。

    プロパティ タイプ 説明
    botNo number 登録されたトーク Bot 番号

    Response Example

    
    {
      "botNo": 123
    }
    

    Error Code

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