GET/bots

Bot リストを取得する。
各 Bot の詳細情報は Bot の取得 で確認する

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

bot.read
bot

HTTP Request

GEThttps://www.worksapis.com/v1.0/bots

Query Parameters

ParameterTypeDescription
cursor string 

リストのカーソル値 (URL エンコードする)


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 
count integer 

取得数


required
default : 50
minimum : 1
maximum : 100
example : 60
format : int64 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
bots array (bots) 

トーク Bot リスト

 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

bots

PropertyTypeDescription
botId integer 

Bot ID


required
format : int64 
botName string 

Bot 名


required
maxLength : 100 
photoUrl string 

Bot プロフィール画像が保存されたURL (PNG 形式、640x640 サイズ推奨、HTTPS のみ許容)


required
maxLength : 1000 
i18nBotNames array (i18nBotNames) 

Bot の多国語名


minItems : 0 
i18nPhotoUrls array (i18nPhotoUrls) 

Bot の多国語画像 URL


minItems : 0 

i18nBotNames

PropertyTypeDescription
language string 

多国語言語コード


required
Allowed values : ja_JP, ko_KR, en_US, zh_CN, zh_TW 
botName string 

Bot名


required
maxLength : 100 

i18nPhotoUrls

PropertyTypeDescription
language string 

多国語言語コード


required
Allowed values : ja_JP, ko_KR, en_US, zh_CN, zh_TW 
photoUrl string 

Bot のプロフィール画像が保存された URL


required
maxLength : 1000 

responseMetaData

PropertyTypeDescription
nextCursor string 

次のリストが存在する場合のカーソル値


required 

Response Example

example

1{2  "bots": [3    {4      "botId": 2000001,5      "botName": "Example Bot",6      "photoUrl": "https://example.com/favicon.png",7      "i18nBotNames": [8        {9          "language": "en_US",10          "botName": "Example bot"11        }12      ],13      "i18nPhotoUrls": [14        {15          "language": "en_US",16          "photoUrl": "https://example.com/favicon.png"17        }18      ]19    }20  ],21  "responseMetaData": {22    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="23  }24}