콘텐츠로 이동

시스템 메시지 조회

Endpoint

[GET] API URL 정보

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

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

Introduce

Introduce 
발신프로필 키를 기준으로, 상태가 정상(A)인 시스템 메시지를 조회하거나,
시스템 메시지 ID로 특정 메시지를 조회하는 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 발신프로필 키
id Number N 시스템 메시지 아이디

Example

REST API Sample 
curl -L -X GET 'https://patch-kakao-api.happytalk.io/kakaoWebhook/v3/bzmc/sm?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/sm?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 SystemMessage[] 결과 목록
message Text 처리 실패 시 결과 메시지

Example

Success 
{
    "code": "200",
    "data": []
}

{
    "code": "200",
    "data": [
        {
            "id": 175,
            "name": "system-message-sample",
            "status": "A",
            "createdAt": "2019-10-31 18:26:12",
            "modifiedAt": "2019-10-31 18:26:33",
            "inspectStatus": "APR",
            "inspectRequestAt": "2019-10-31 18:26:28",
            "inspectedAt": "2019-10-31 18:26:33",
            "messages": [
                {
                    "messageType": "ST",
                    "content": "1:1채팅을 요청하셨습니다.",
                    "buttons": []
                }
            ],
            "comments": [
                {
                    "id": 2892,
                    "content": null,
                    "userName": "검수자",
                    "createdAt": "2019-10-31 18:26:33",
                    "status": "APR"
                }
            ]
        }
    ]
}
Failure 
{
    "code": "507",
    "message": "발신프로필(발신채널) 또는 발신프로필 그룹이 유효하지 않습니다"
}

Data Dictionary

Data Dictionary

None

Field Name Type Description
id Number 시스템 메시지 아이디
name Text 시스템 메시지 이름
status Text 메시지 상태 (A: 정상, T: 중지, S: 차단)
createdAt Text 등록일
modifiedAt Text 수정일
inspectStatus Text 검사 상태 (REG: 등록, REQ: 검수요청, APR: 승인, REJ: 반려)
inspectRequestAt Text 검수 요청일
inspectedAt Text 검수일
messages Message[] 시스템 메시지 목록
comments Comment[] 검사 결과 및 문의 목록
Field Name Type Description
messageType Text 시스템 메시지 타입 (예: ST, S1, S2 등)
content Text 내용
buttons Button[] 메시지 하단 버튼 목록
Field Name Type Description
id Number 아이디
content Text 내용
userName Text 작성자
createdAt Text 등록일
status Text 상태 (APR: 승인, REJ: 반려, INQ: 문의)
Field Name Type Description
ordering Number 버튼 노출 순서
linkType Text 시스템 메시지 버튼 링크 타입 (예: WL, AL, BK, MD)
linkName Text 버튼 이름
linkMobile Text 모바일 웹링크주소
linkPc Text PC 웹링크주소
linkIos Text iOS 앱링크주소
linkAndroid Text Android 앱링크주소
Name Description
ST 상담시작
S1 상담불가
S2 상담부재
S3 무응답종료
S4 상담대기
S5 금칙어 상담불가: 버튼 사용 불가
ED 상담종료
ER 응답실패
BL 사용자차단: 버튼 사용 불가
SB 봇전환: 버튼 사용 불가
Name Description
WL 웹링크
AL 앱링크
BK 봇키워드
MD 메시지전달

Reference

코드 정의