GET/bots/{botId}

봇에 대한 상세 정보를 조회한다.

Authorization

oauth2

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

Scope

bot
bot.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/bots/{botId}

Path Parameters

ParameterTypeDescription
botId integer 

봇 ID


required
example : 2000001
format : int64 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
botId integer 

봇 ID


format : int64
readOnly : true 
botName string 

봇 이름


required
maxLength : 100 
photoUrl string 

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


required
maxLength : 1000 
description string 

봇 설명


required
maxLength : 100 
administrators array (string) 

봇 담당자 계정


required
minItems : 1
maxItems : 3
uniqueItems : true 
subadministrators array (string) 

봇 부담당자 계정


minItems : 0
maxItems : 3
uniqueItems : true 
allowDomains array (integer) 

봇을 사용 가능한 도메인 목록


minItems : 0
uniqueItems : true 
enableCallback boolean 

봇 이벤트 수신 여부


default : false 
channelEvents array (string) 

수신할 봇 메시지방 이벤트 종류

  • "message": 메시지 이벤트
  • "join": bot이 1:N 메시지방에 초대
  • "leave": bot이 1:N 메시지방에서 퇴장
  • "joined": 사용자가 1:N 메시지방에 입장
  • "left": 사용자가 1:N 메시지방에서 퇴장
  • "postback": postback 이벤트
  • "begin": 1:1 메시지방에 입장
  • "end": 1:1 메시지방에서 퇴장

default : message,join,leave,joined,left,postback
minItems : 0
uniqueItems : true 
callbackEvents array (string) 

수신할 봇 메시지 이벤트 종류

  • "text": 텍스트
  • "location": 위치 정보
  • "sticker": 스티커
  • "image": 이미지
  • "file": 파일
  • "audio": 오디오
  • "video": 비디오

minItems : 0
uniqueItems : true 
callbackUrl string 

고객사의 봇 이벤트 수신 서버. HTTPS만 허용된다.


maxLength : 1000 
enableGroupJoin boolean 

1:N 메시지방 참여 가능 여부


default : false 
defaultRichmenuId string 

모든 사용자에게 적용되는 기본 리치 메뉴 ID

 
i18nBotNames array (i18nBotNames) 

봇의 다국어 이름


minItems : 0 
i18nDescriptions array (i18nDescriptions) 

봇의 다국어 설명


minItems : 0 
i18nPhotoUrls array (i18nPhotoUrls) 

봇의 다국어 이미지


minItems : 0 
createdTime string 

봇 생성 시간 (YYYY-MM-DDThh:mm:ssTZD)


format : date-time
readOnly : true 
modifiedTime string 

봇 수정 시간 (YYYY-MM-DDThh:mm:ssTZD)


format : date-time
readOnly : true 

i18nBotNames

PropertyTypeDescription
language string 

다국어 언어 코드


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

봇 이름


required
maxLength : 100 

i18nDescriptions

PropertyTypeDescription
language string 

다국어 언어 코드


required
Allowed values : ko_KR, ja_JP, en_US, zh_CN, zh_TW 
description 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 

Response Example

example

1{2  "botId": 2000001,3  "botName": "Example bot",4  "photoUrl": "https://example.com/favicon.png",5  "description": "WorksMobile's A.I. conversation enabled bot",6  "administrators": [7    "d191e339-3299-44e6-7a44-04d9cb01a5e0"8  ],9  "subadministrators": [10    "e417a131-a56d-44a4-5304-033e16fca8d1"11  ],12  "allowDomains": [13    1000000114  ],15  "enableCallback": true,16  "channelEvents": [17    "message",18    "join",19    "leave",20    "joined",21    "left",22    "postback",23    "begin",24    "end"25  ],26  "callbackEvents": [27    "text",28    "location",29    "sticker",30    "image",31    "file",32    "audio",33    "video"34  ],35  "callbackUrl": "https://example.com/callback",36  "createdTime": "2022-08-08T01:12:05+09:00",37  "modifiedTime": "2022-08-09T01:12:05+09:00",38  "enableGroupJoin": true,39  "defaultRichmenuId": "40001",40  "i18nBotNames": [41    {42      "language": "en_US",43      "botName": "Example bot"44    }45  ],46  "i18nDescriptions": [47    {48      "language": "en_US",49      "description": "Example description"50    }51  ],52  "i18nPhotoUrls": [53    {54      "language": "en_US",55      "photoUrl": "https://example.com/favicon.png"56    }57  ]58}