콘텐츠로 이동

상담시간 조회

Endpoint

[GET] API URL 정보

https://patch-kakao-api.happytalk.io/kakaoWebhook/v2/bzmc/consult/{sender_key}/time
https://kakao-api.happytalk.io/kakaoWebhook/v2/bzmc/consult/{sender_key}/time

Introduce

Introduce
발신프로필 키를 기준으로, 카카오톡 채널에 저장된 상담시간을 조회하는 API입니다.

Request (Query)

Field Name Type Required Description
HT-Client-Id Text Y 고객센터에서 발급 받은 key
HT-Client-Secret Text Y 고객센터에서 발급 받은 token

Path Parameter

Field Name Type Required Description
sender_key Text Y 발신프로필 키

Example

REST API Sample
curl -L -X GET 'https://patch-kakao-api.happytalk.io/kakaoWebhook/v2/bzmc/consult/example-senderkey/time' \
-H 'HT-Client-Id: example-id' \
-H 'HT-Client-Secret: example-secret'
curl -L -X GET 'https://kakao-api.happytalk.io/kakaoWebhook/v2/bzmc/consult/example-senderkey/time' \
-H 'HT-Client-Id: example-id' \
-H 'HT-Client-Secret: example-secret'

Response (Json)

Parameter

Field Name Type Description
code Text 처리 결과 코드 (200은 정상 / 나머지는 오류)
week_timetable Json[] 요일 별 상담 시간 목록
message Text 처리 실패 시 결과 메시지

Example

Success
{
    "code": "200",
    "week_timetable": []
}
{
    "code": "200",
    "week_timetable": [
        {
            "day": "mon",
            "start_at": "0900",
            "end_at": "1800"
        },
        {
            "day": "wed",
            "start_at": "0900",
            "end_at": "1800"
        },
        {
            "day": "fri",
            "start_at": "0900",
            "end_at": "1800"
        },
        {
            "day": "sat",
            "start_at": "0800",
            "end_at": "1200"
        }
    ]
}
Failure
{
    "code": "508",
    "message": "요청한 데이터가 존재하지 않습니다."
}

Data Dictionary

Data Dictionary

None

Field Name Type Description
day Text(3) 요일 (영어 3자 표기, ex. mon)
start_at Text(4) 상담 시작 시간
end_at Text(4) 상담 종료 시간

Reference

코드 정의