콘텐츠로 이동

사용자 차단

Endpoint

[POST] API URL 정보

https://patch-kakao-api.happytalk.io/kakaoWebhook/v3/bzc/profile/user/block

https://kakao-api.happytalk.io/kakaoWebhook/v3/bzc/profile/user/block

Introduce

Introduce 
사용자를 차단하는 API입니다. 
차단된 사용자의 메시지는 상담사에게 전달되지 않으며,
사용자에게는 1:1 채팅이 불가능하다는 안내 메시지가 자동 발송됩니다.

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

Body

Field Name Type (Length) Required Description
user_key Text(20) Y 사용자 키
sender_key Text(40) Y 발신프로필 키

Example

REST API Sample 
curl -L -X POST 'https://patch-kakao-api.happytalk.io/kakaoWebhook/v3/bzc/profile/user/block' \
-H 'Content-Type: application/json' \
-H 'HT-Client-Id: example-id' \
-H 'HT-Client-Secret: example-secret' \
-d '{"user_key":"example-user_key","sender_key":"example-sender_key"}'

curl -L -X POST 'https://kakao-api.happytalk.io/kakaoWebhook/v3/bzc/profile/user/block' \
-H 'Content-Type: application/json' \
-H 'HT-Client-Id: example-id' \
-H 'HT-Client-Secret: example-secret' \
-d '{"user_key":"example-user_key","sender_key":"example-sender_key"}'

Response (Json)

Parameter

Field Name Type Description
code Text 처리 결과 코드 (0은 정상 / 나머지는 오류)
message Text 처리 실패 시 결과 메시지

Example

Success 
{
    "code": 0
}
Failure 
{
    "code": -501,
    "message": "InvalidSenderException(senderKey: test-key)"
}

Data Dictionary

Data Dictionary

None

None

Reference

코드 정의