콘텐츠로 이동

수신 도메인 저장

Endpoint

[POST] API URL 정보

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

https://kakao-api.happytalk.io/kakaoWebhook/v1/bzmc/consult/{sender_key}/receiveDomain

Introduce

Introduce 
발신프로필 키를 기준으로, 메시지 수신 메뉴의 API에서 사용할 수신 도메인을 등록 또는 수정하는 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 (Length) Required Description
domain Text Y 고객사 수신 도메인 URL

Example

REST API Sample 
curl -L -X POST 'https://patch-kakao-api.happytalk.io/kakaoWebhook/v1/bzmc/consult/example-senderKey/receiveDomain' \
-H 'Content-Type: application/json' \
-H 'HT-Client-Id: example-id' \
-H 'HT-Client-Secret: example-secret' \
-d '{"domain":"https://happytalk.io"}'

curl -L -X POST 'https://kakao-api.happytalk.io/kakaoWebhook/v1/bzmc/consult/example-senderKey/receiveDomain' \
-H 'Content-Type: application/json' \
-H 'HT-Client-Id: example-id' \
-H 'HT-Client-Secret: example-secret' \
-d '{"domain":"https://happytalk.io"}'

Response (Json)

Parameter

Field Name Type Description
code Text 결과 코드 (200: 정상)
message Text 처리 실패 시 결과 메시지 (실패 시만 반환)

Example

Success 
{
    "code": "200"
}
Failure 
{
    "code": "405",
    "message": "유효하지 않은 허브파트너 수신도메인입니다."
}

Data Dictionary

Data Dictionary

None

None

Reference

코드 정의