콘텐츠로 이동

상담원 직접 배정

Endpoint

[PUT] 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 고객사 토큰
chat_room_ids String[] Y 변경할 상담방 ID 목록 (최소 1개, 최대 50개)
counselor_id Int Y 배정할 상담원 ID (양의 정수)

Example

REST API Sample 
curl --location --request PUT 'https://patch-bnd.happytalk.io/user/api/chat-rooms/direct-counselors' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token" : "고객사 토큰",
    "chat_room_ids" : ["68b6b174b9121Zj7lf0lCo2xMr9KSp", "abc123def456789012345678901234"],
    "counselor_id" : 53176
}'

curl --location --request PUT 'https://bnd.happytalk.io/user/api/chat-rooms/direct-counselors' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token" : "고객사 토큰",
    "chat_room_ids" : ["68b6b174b9121Zj7lf0lCo2xMr9KSp", "abc123def456789012345678901234"],
    "counselor_id" : 53176
}'

Response (Json)

응답 해석 안내

result는 API 호출 자체의 처리 여부를 의미하며 (인증·검증 통과 시 항상 success), 실제 상담방별 처리 결과는 data.items[]로 전달됩니다.
따라서 result: "success"이더라도 success_count: 0 / 모든 items[].success: false 인 전체 실패 케이스가 존재할 수 있으니, 클라이언트는 반드시 success_count 와 items[].success / items[].message 를 함께 확인하세요.
전체 실패의 대표 사유: 상담방이 다른 사이트 소속, 카카오 오픈빌더 사용중, 상담방이 종료/삭제 상태 등.

Parameter

Field Name Type Description
result String API 호출 처리 여부 (success : 정상 처리 / fail : 인증·파라미터 오류 등)
data Object 응답 데이터
success_count Int 성공 건수 (items 중 success=true 합산)
fail_count Int 실패 건수 (items 중 success=false 합산)
items Object[] 상담방별 처리 결과 목록
chat_room_id String 상담방 ID
success Boolean 성공 여부
message String 실패 사유 (성공 시 null)

Example

전체 성공 
{
    "result": "success",
    "data": {
        "success_count": 3,
        "fail_count": 0,
        "items": [
            { "chat_room_id": "68b6b174b9121Zj7lf0lCo2xMr9KSp", "success": true, "message": null },
            { "chat_room_id": "abc123def456789012345678901234", "success": true, "message": null },
            { "chat_room_id": "ghi789jkl012345678901234567890", "success": true, "message": null }
        ]
    }
}
부분 성공 
{
    "result": "success",
    "data": {
        "success_count": 2,
        "fail_count": 1,
        "items": [
            { "chat_room_id": "68b6b174b9121Zj7lf0lCo2xMr9KSp", "success": true, "message": null },
            { "chat_room_id": "abc123def456789012345678901234", "success": true, "message": null },
            { "chat_room_id": "ghi789jkl012345678901234567890", "success": false, "message": "카카오 오픈빌더 사용 중인 상담방입니다." }
        ]
    }
}
전체 실패 (상담방 검증 사유)

API 호출 자체는 정상 처리되었으나(result: "success"), 요청한 모든 상담방이 검증 단계에서 실패한 케이스입니다. 클라이언트는 success_count: 0 과 items[].message 로 판별합니다.

{
    "result": "success",
    "data": {
        "success_count": 0,
        "fail_count": 2,
        "items": [
            { "chat_room_id": "68b6b174b9121Zj7lf0lCo2xMr9KSp", "success": false, "message": "카카오 오픈빌더 사용 중인 상담방입니다." },
            { "chat_room_id": "abc123def456789012345678901234", "success": false, "message": "이미 종료된 상담방입니다." }
        ]
    }
}

Fail

Failure

Fail Code 정보

Data Dictionary

Data Dictionary

None

None