GET/bots

등록되어 있는 봇 목록을 조회한다.
등록된 봇이 50개를 초과할 때는 이전 조회 결과에서 받은 cursor 파라미터를 입력하여 다음 봇 목록을 계속해서 조회할 수 있다.
각 봇의 상세 정보는 봇 상세 정보 조회에서 확인할 수 있다.

Authorization

oauth2

OAuth 2.0 인증.
자세한 인증 방식은 인가·인증을 참고한다.

Scope

bot.read
bot

HTTP Request

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

Query Parameters

ParameterTypeDescription
cursor string 

다음 목록 조회 시 사용하는 커서값


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 
count integer 

목록 조회 개수


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) 

봇 정보

 
responseMetaData object (responseMetaData) 

응답과 관련된 메타 데이터

 

bots

PropertyTypeDescription
botId integer 

봇 ID


required
format : int64 
botName string 

봇 이름


required
maxLength : 100 
photoUrl string 

봇 프로필 이미지가 저장된 URL(PNG 형식, 640x640 크기 권장, HTTPS만 허용)


required
maxLength : 1000 
i18nBotNames array (i18nBotNames) 

봇 다국어 이름


minItems : 0 
i18nPhotoUrls array (i18nPhotoUrls) 

봇 다국어 이미지 URL


minItems : 0 

i18nBotNames

PropertyTypeDescription
language string 

다국어 언어 코드


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

봇 이름


required
maxLength : 100 

i18nPhotoUrls

PropertyTypeDescription
language string 

다국어 언어 코드


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

봇 프로필 이미지가 저장된 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}