콘텐츠로 이동

상담시간 저장

Endpoint

[POST] 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 (Json)

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

Path Parameter

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

Body

Field Name Type Required Description
week_timetable Json[] Y 요일 별 상담 시간 목록

Description

week_timetable 주의사항 
1. 상담을 사용할 요일만 목록에 포함하여 전송합니다.  
   ex. 월, 수, 금 08:30~17:30만 상담 운영 시 → `week_timetable`에 월, 수, 금 3개의 요일만 포함  
2. 종료 시간이 시작시간보다 이전일 경우 → 다음날 종료 시간까지 상담시간으로 설정됩니다.  
   ex. 월 08:00~06:00으로 설정하면 → 월 08:00~화 06:00로 적용

Example

REST API Sample 
curl -L -X POST 'https://patch-kakao-api.happytalk.io/kakaoWebhook/v2/bzmc/consult/example-sender-key/time' \
-H 'Content-Type: application/json' \
-H 'HT-Client-Id: example-id' \
-H 'HT-Client-Secret: example-secret' \
-d '{"week_timetable":[{"day":"mon","start_at":"0000","end_at":"0000"},{"day":"tue","start_at":"0000","end_at":"0000"},{"day":"wed","start_at":"0000","end_at":"0000"},{"day":"thu","start_at":"0000","end_at":"0000"},{"day":"fri","start_at":"0000","end_at":"0000"},{"day":"sat","start_at":"0000","end_at":"0000"},{"day":"sun","start_at":"0000","end_at":"0000"}]}'

curl -L -X POST 'https://kakao-api.happytalk.io/kakaoWebhook/v2/bzmc/consult/example-sender-key/time' \
-H 'Content-Type: application/json' \
-H 'HT-Client-Id: example-id' \
-H 'HT-Client-Secret: example-secret' \
-d '{"week_timetable":[{"day":"mon","start_at":"0000","end_at":"0000"},{"day":"tue","start_at":"0000","end_at":"0000"},{"day":"wed","start_at":"0000","end_at":"0000"},{"day":"thu","start_at":"0000","end_at":"0000"},{"day":"fri","start_at":"0000","end_at":"0000"},{"day":"sat","start_at":"0000","end_at":"0000"},{"day":"sun","start_at":"0000","end_at":"0000"}]}'

Response (Json)

Parameter

Field Name Type Description
code Text 처리 결과 코드
time Text 처리 시간 (예: 2025-04-18T16:07:39.407275)
message Text 처리 실패 시 결과 메시지

Example

Success 
{
    "code": "200",
    "time": "2025-04-18T16:07:39.407275"
}
Failure 
{
    "code": "508",
    "message": "요청한 데이터가 존재하지 않습니다."
}

Data Dictionary

Data Dictionary
Field Name Type Description
day Text(3) 요일 (영어 3자 표기, ex. mon, tue, wed)
start_at Text(4) 상담 시작 시간 (00:00~23:59, ex. 0830 = 오전 8시 30분, 24시간 상담시 "0000")
end_at Text(4) 상담 종료 시간 (00:00~23:59, ex. 1800 = 오후 6시, 24시간 상담시 "0000")

None

Reference

코드 정의