콘텐츠로 이동

수신 도메인 조회

Endpoint

[GET] 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 (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/v1/bzmc/consult/example-senderKey/receiveDomain' \
-H 'HT-Client-Id: example-id' \
-H 'HT-Client-Secret: example-secret'

curl -L -X GET 'https://kakao-api.happytalk.io/kakaoWebhook/v1/bzmc/consult/example-senderKey/receiveDomain' \
-H 'HT-Client-Id: example-id' \
-H 'HT-Client-Secret: example-secret'

Response (Json)

Parameter

Field Name Type Description
code Text 결과 코드
data array 수신 도메인 데이터 목록
isDirect boolean 전용선 도메인 여부
message Text 처리 실패 시 결과 메시지

Example

Success 
{
    "code":"200",
    "data":[
        {
            "modifiedAt":"2019-10-17 15:02:23",
            "domain":"https://happytalk.io",
            "createdAt":"2019-08-05 19:24:34"
        }
    ],
    "isDirect":false
}
Failure 
{
    "code": "9999",
    "message": "시스템에 문제가 발생하여 담당자가 확인하고 있는 경우"
}

Data Dictionary

Data Dictionary

None

Field Name Type Description
modifiedAt Text 최종수정일
domain Text 발신프로필 수신도메인
createdAt Text 등록일

Reference

코드 정의