콘텐츠로 이동

발신프로필 조회

Endpoint

[GET] API URL 정보

https://patch-kakao-api.happytalk.io/kakaoWebhook/v3/bzmc/sender

https://kakao-api.happytalk.io/kakaoWebhook/v3/bzmc/sender

Introduce

Introduce 
발신프로필 키를 기준으로, 채널명, 상담톡 사용 여부, 상태 정보 등을 조회하는 API입니다.

Request (Query)

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

Query Parameter

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

Example

REST API Sample 
curl -L -X GET 'https://patch-kakao-api.happytalk.io/kakaoWebhook/v3/bzmc/sender?senderKey=example-senderkey' \
-H 'HT-Client-Id: example-id' \
-H 'HT-Client-Secret: example-secret'

curl -L -X GET 'https://kakao-api.happytalk.io/kakaoWebhook/v3/bzmc/sender?senderKey=example-senderkey' \
-H 'HT-Client-Id: example-id' \
-H 'HT-Client-Secret: example-secret'

Response (Json)

Parameter

Field Name Type Description
code Text 결과 코드
data Sender 발신프로필 정보 (성공 시)
message Text 오류 메시지 (실패 시 존재)

Example

Success 
{
    "code": "200",
    "data": {
        "senderKey": "888333777290a111671004948870064990eeecee",
        "uuid": "@비즈메시지테스트프로필",
        "name": "비즈메시지_test",
        "status": "A",
        "block": false,
        "dormant": false,
        "profileStatus": "A",
        "createdAt": "2024-06-01 00:00:00",
        "modifiedAt": "2024-06-01 00:00:00",
        "categoryCode": "00000000001",
        "bizchat": false,
        "brandtalk": false,
        "brandMessage": true,
        "committalCompanyName": "",
        "channelKey": "base",
        "businessProfile": true,
        "businessType": "BUSINESS",
        "unsubscribePhoneNumber": "080-0000-0000",
        "unsubscribeAuthNumber": null,
        "profileSpamLevel": "정상",
        "profileMessageSpamLevel": "정상",
        "clearBlockUrl": "https://bzm.kakao.com/a/bb/ccc"
    }
}
Failure 
{
    "code": "508",
    "message": "요청한 데이터가 존재하지 않습니다."
}

Data Dictionary

Data Dictionary

None

Field Name Type Description
senderKey Text(40) 발신프로필 키
uuid Text(20) 카카오톡 채널
name Text(20) 카카오톡 채널 프로필명
status Text(1) 상태 (A: 정상)
block boolean 발신프로필 차단 여부
dormant boolean 발신프로필 휴면 여부
profileStatus Text(1) 채널 상태 (A: activated, C: deactivated, B: block, E: deleting)
createdAt Text(19) 등록일
modifiedAt Text(19) 최종 수정일
categoryCode Text(11) 카테고리 코드
unsubscribePhoneNumber Text(13) 무료수신거부 전화번호
unsubscribeAuthNumber Text(10) 무료수신거부 인증번호
bizchat boolean 상담톡 사용 여부
brandtalk boolean 브랜드톡 사용 여부 (추후 제거 예정)
brandMessage boolean 브랜드 메시지 사용 여부
committalCompanyName Text(100) 위탁사 이름 (상담톡 관련)
channelKey Text(20) 메시지 발송 결과 수신 채널키
businessProfile boolean 카카오톡 채널 비즈니스 인증 여부
businessType Text(50) 카카오톡 채널 비즈니스 인증 타입
profileSpamLevel Text 채널 스팸 상태 (정상, 경고, 영구제외)
profileMessageSpamLevel Text 메시지 스팸 상태 (정상, 경고, 활동제한)
clearBlockUrl Text 알림톡 차단 해제 링크

Reference

코드 정의