콘텐츠로 이동

배정 가능 상담원 조회

Endpoint

[POST] API URL 정보

https://patch-bnd.happytalk.io/user/api/chat-rooms/direct-counselors

https://bnd.happytalk.io/user/api/chat-rooms/direct-counselors

Request (Json)

None

Body

Field Name Type (Length) Required Description Default
token String Y 고객사 토큰
status_filter status_filter N 상담원 상태 필터 (ALL / LOGGED_IN / LOGGED_OUT / AVAILABLE / UNAVAILABLE) ALL
auth_code_filter auth_code_filter N 상담원 권한 필터 (COUNSELOR / MANAGER / ADMIN)
name_filter String N 상담원 이름 부분 검색
page_no Int N 페이지 번호 (1부터 시작) 1
limit Int N 페이지당 데이터 개수 (1~100) 10
sort sort N 정렬 필드 (counselorAuth: 권한순 / counselorName: 이름순) counselorAuth
order order N 정렬 방향 (ASC / DESC) DESC

Example

REST API Sample 
curl --location --request POST 'https://patch-bnd.happytalk.io/user/api/chat-rooms/direct-counselors' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token" : "고객사 토큰",
    "status_filter" : "ALL",
    "page_no" : 1,
    "limit" : 10
}'

curl --location --request POST 'https://bnd.happytalk.io/user/api/chat-rooms/direct-counselors' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token" : "고객사 토큰",
    "status_filter" : "ALL",
    "page_no" : 1,
    "limit" : 10
}'

Response (Json)

Parameter

Field Name Type Description
result String success : 성공 , fail : 실패
data Object 응답 데이터
counselors Object[] 배정 가능 상담원 목록
counselor_id Long 상담원 ID
counselor_auth counselor_auth 상담원 권한 코드
counselor_name String 상담원명
counsel_status counsel_status UI 표시용 상담원 상태
is_login Boolean 로그인 여부
room_ing_counselor_cnt Int 진행중 상담방 개수
room_wait_counselor_cnt Int 대기중 상담방 개수
total Int 전체 상담원 수 (페이징 무관)

Example

Success 
{
    "result": "success",
    "data": {
        "counselors": [
            {
                "counselor_id": 53175,
                "counselor_auth": "3|5",
                "counselor_name": "김상담",
                "counsel_status": "AVAILABLE",
                "is_login": true,
                "room_ing_counselor_cnt": 5,
                "room_wait_counselor_cnt": 2
            }
        ],
        "total": 1
    }
}

Fail

Failure

Fail Code 정보

Data Dictionary

Data Dictionary
Type Description
ALL 전체 상담원
LOGGED_IN 로그인한 상담원만
LOGGED_OUT 로그아웃한 상담원만
AVAILABLE 상담 가능한 상담원만
UNAVAILABLE 상담 불가 상담원만
Type Description
COUNSELOR 상담사
MANAGER 매니저
ADMIN 관리자
Type Description
counselorAuth 권한순
counselorName 이름순
Type Description
ASC 오름차순
DESC 내림차순
Type Description
3 상담사
3|5 매니저
3|5|7 관리자
Type Description
AVAILABLE 상담 가능 (기본 상태)
MEAL_TIME 식사시간
BREAK_TIME 휴식시간
UNAVAILABLE 상담 불가 (근무관리 휴식시간 또는 상담하기 권한 없음)