Bots
특정 Bot의 정보를 조회하기 위해 다음과 같은 API를 사용합니다.
표Bots API 리스트| 구분 | API 명 | 설명 |
|---|---|---|
| 정보 조회 | bots.info | 특정 Bot의 정보 조회 |
bots.info
Bot의 정보를 조회합니다.
Request
Request Syntax
코드예제bots.info Request Syntax
curl -X GET https://api.kakaowork.com/v1/bots.info \
-H "Authorization: Bearer {YOUR_APP_KEY}" \
-H "Content-Type: application/json;charset=utf-8"
| 메서드 | 요청 URL |
|---|---|
| GET | https://api.kakaowork.com/v1/bots.info |
Request Header
Request Header에 대한 상세는 다음과 같습니다.
표bots.info Request Header| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| Authorization | String | 필수 |
Bearer {YOUR_APP_KEY}- {YOUR_APP_KEY}: Bot 등록 요청 후에 획득한 인증키(App Key) |
| Content-Type | String | 선택 |
application/json 또는 application/x-www-form-urlencoded |
Request Elements
요구하는 파라미터가 없습니다.
Response
Response Syntax
코드예제bots.info Response Syntax
{
"success": true,
"info": { /* ... bot entity ... */ }
}
Response Elements
Response Elements에 대한 상세는 다음과 같습니다.
표bots.info Response Elements| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| success | Boolean | 필수 |
API 호출 실행 결과 |
true: 성공, info 필드와 함께 반환 |
|||
false: 실패, error 필드와 함께 반환 |
|||
| Object | 선택 |
Bot의 정보 - API 호출 성공( true)일 경우 제공 |
|
| title | String | 필수 |
Bot 타이틀 |
| status | String | 필수 |
Bot 활성화 여부 |
activated: 활성 |
|||
deactivated: 비활성 |
|||
| Object | 선택 |
API 실행 오류 정보 - API 호출 실패( false)일 경우 제공 |
|
| code | String | 필수 |
오류 상황을 구분하는 코드 |
invalid_parameter: 제공된 파라미터의 값이 올바르지 않음 |
|||
invalid_authentication: 제공된 인증키가 유효하지 않음 |
|||
invalid_representation: 유효하지 않은 포맷의 Body 데이터 |
|||
api_not_found: 요청 API의 URL 혹은 HTTP 메서드와 다름 |
|||
unauthorized: 인증키가 제공되지 않음 |
|||
internal_server_error: 정의되지 않은 서버 오류 발생 |
|||
too_many_requests: API 사용 한도가 초과됨 |
|||
expired_authentication: 제공된 인증키가 만료됨 |
|||
invalid_content_type: 요청이 API가 요구하는 Content Type과 다름 |
|||
missing_parameter: 필요한 파라미터 값이 제공되지 않았음 |
|||
| message | String | 필수 |
오류 원인에 대한 설명 |