상담사 그룹 목록 조회 API
1. API 개요
인증된 사이트에 설정된 상담사 그룹 목록을 조회하는 API입니다.
이 API를 통해 다음 정보를 확인할 수 있습니다.
•
상담사 그룹 ID
•
그룹 이름
•
그룹 순서
•
생성 및 수정 시간
2. 사전 조건 / 권한
•
콜브릿지 계정 필수
•
API Access Token 발급 필요
3. API 정보
Method / Endpoint
Header
이름 | 타입 | 필수 | 기본값 | 설명 |
Authorization | string | O | Bearer {ACCESS_TOKEN} 형식으로 전달 |
4. Request
이 API는 요청 파라미터가 없습니다.
Request Example
cURL
curl -X GET "https://bnd.happytalk.io/api/openapi/counselor-groups" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
JavaScript
복사
5. Response
Response 정보
•
Status Code: 200 OK
•
Content-Type: application/json
Response Body Example
json
{
"code": "OK",
"timestamp": 1705388400,
"message": "상담사 그룹 목록 조회 성공",
"total": 3,
"items": [
{
"id": 1,
"siteId": 921004322052,
"title": "일반 상담팀",
"idx": 1,
"createdAt": "2025-01-16T10:00:00",
"updatedAt": "2025-01-16T15:00:00"
}
]
}
JavaScript
복사
Resonse Field명
이름 | 타입 | 필수 | 기본값 | 설명 |
code | string | O | - | 응답 코드 (예: OK) |
timestamp | Long | O | - | 응답 일시 (Unix timestamp, 초 단위) |
message | string | x | - | 응답 메시지 |
total | Integer | x | - | 조회된 상담사 그룹 수 |
items | Array | x | - | 상담사 그룹 목록 |
items[] (상담사 그룹 객체)
이름 | 타입 | 필수 | 기본값 | 설명 |
id | Long | O | - | 그룹 ID |
siteId | Long | O | - | 사이트 ID |
title | string | x | - | 그룹명 |
idx | Integer | O | - | 그룹 정렬 순서 |
createdAt | Long | O | - | 생성 시각 (ISO 8601, 예: 2025-01-16T10:00:00) |
updatedAt | Long | x | - | 수정 시각 (ISO 8601, 예: 2025-01-16T15:00:00) |
6. 에러 / 예외처리
오류 응답 본문의 “code"와 "message" 속성에서 오류에 대한 더 구체적인 세부 정보를 확인할 수 있습니다.
HTTP 상태명 | Error Code | Message | 설명 |
401 Unauthorized | UNAUTHORIZED | API Key가 유효하지 않습니다. | API Key 미전송 또는 인증 실패 |
500 Internal Server Error | E500.counselorgroup.db_connection_error | 데이터베이스 연결 오류가 발생했습니다. | DB 연결 실패 |
500 Internal Server Error | E500.counselorgroup.internal_error | 내부 서버 오류가 발생했습니다. | 예기치 않은 서버 오류 |