トーク Bot リストの照会

    登録されているトーク Bot のリストを照会します。

    API の種類

    サーバー API

    Request URL

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

    HTTP Method

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

    Request

    なし

    Response

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

    プロパティ タイプ 説明
    code number ● 200: 成功
    ● 400 番台: クライアントリクエストエラー
    ● 500 番台: 想定外のエラー / サーバー内部エラー
    message string 詳細メッセージ。
    botList array 登録されたトーク Bot のリスト。
    botList[].botNo number トーク Bot 番号。
    botList[].name string Bot 名。
    botList[].i18nNames[] array 多言語名のリスト。
    botList[].i18nNames[].language string 言語コード。
    ●ko_KR
    ●ja_JP
    ●zh_CN
    ●zh_TW
    ●en_US
    botList[].i18nNames[].name string 多言語名。
    botList[].photoUrl string トーク Bot プロフィール画像の URL。
    botList[].i18nPhotoUrls[] array 多言語の画像の URL リスト。
    botList[].i18nPhotoUrls[].language string 言語コード。
    ●ko_KR
    ●ja_JP
    ●zh_CN
    ●zh_TW
    ●en_US
    botList[].i18nPhotoUrls[].photoUrl string 画像の URL。

    Response Example

    {
      "code": 200,
      "message": "OK",
      "botList": [
        {
          "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"
          }]
        }
      ]
    }