トーク Bot リストの照会

    トーク Bot のリストを照会します。

    API の種類

    サーバー API

    Request URL

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

    HTTP Method

    GET

    Request Example

    
    GET https://apis.worksmobile.com/r/apiid/message/v1/bot
    

    Response

    呼び出しに成功するとHTTP 200コードとトークBotリスト情報を返します。

    プロパティ タイプ 説明
    bots array トーク Bot リスト
    bots[].botNo number トーク Bot 番号
    bots[].name string Bot 名
    bots[].i18nNames[] array 多言語名のリスト
    bots[].i18nNames[].language string 言語コード
    ●ja_JP
    ●ko_KR
    ●zh_CN
    ●zh_TW
    ●en_US
    bots[].i18nNames[].name string 各言語のトーク Bot 名
    bots[].photoUrl string トーク Bot プロフィール画像の URL
    bots[].i18nPhotoUrls[] array 各言語でのプロフィール画像リスト (URL)
    bots[].i18nPhotoUrls[].language string 言語コード
    ●ja_JP
    ●ko_KR
    ●zh_CN
    ●zh_TW
    ●en_US
    bots[].i18nPhotoUrls[].photoUrl string 画像の URL

    Response Example

    
    {
      "bots": [
        {
          "botNo": 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"
          }]
        }
      ]
    }
    

    Error Code

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