웹훅 이벤트
카카오톡 전송에서 발생하는 웹훅 이벤트입니다.
실제 고객사 서버로 전송된 웹훅 이벤트 정보는 [Webhook 실행내역 확인] 을 참고하여 주시기 바랍니다.
웹훅 헤더
| 순번 | 변수명 | 필수 | 설명 | 예시 |
|---|---|---|---|---|
| Pb-Webhook-Type | Y | Webhook 유형 | KAKAO.STATE | |
| Pb-Webhook-MID | Y | 이벤트 식별값 | 016120000002-1777d55c2c41492ab06826d | |
| Pb-Webhook-Corpnum | Y | 팝빌 사업자번호 | 6798700433 | |
| Content-Type | Y | Webhook 메시지 Body 타입 | application/json | |
| Authorization | N | Base64 인코딩한 BASIC 인증정보 |
Basic VEVTVDoxMjM=
HTTP 인증 사용하는 경우 추가 항목
|
|
| X-Api-Key | N | API Key 인증정보 |
TESTAPIKEY
HTTP 인증 사용하는 경우 추가 항목
|
팝빌은 기본으로 제공되는 Header 필드 외 프로그램 공급사 운영환경에 맞춘 커스텀 필드 지원이 가능합니다.
커스텀 필드 추가가 필요한 경우 팝빌 기술지원센터(1600-9854)로 문의주시기 바랍니다.
전송 상태
카카오톡 전송에서 발생하는 웹훅 이벤트입니다.
알림톡 이벤트 발생시점은 [알림톡] 에서 브랜드 메시지 이벤트 발생시점은 [브랜드 메시지]에서 확인 가능합니다.
| 이벤트 유형 | 설명 |
|---|---|
| RESULT | 카카오톡 전송결과 (전송완료, 전송실패, 예약취소) |
팝빌 사이트에서 “Webhook 실행” 버튼을 클릭하여 웹훅을 전송하는 경우, eventType으로 “MANUAL”이 반환됩니다.
RESULT - 전송결과
발신자가 보낸 카카오톡 메시지가 수신자에게 전송완료/전송실패/예약취소 된 시점에 실행됩니다.
이벤트 본문
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| corpNum | string | 10 | Y | 팝빌회원 사업자번호 | |
| receiptNum | string | 18 | Y | 접수번호 | |
| requestNum | string | 36 | N | 요청번호 | |
| serialNum | number | - | Y | 일련번호 | |
| state | number | 1 | Y | 상태코드 | |
| result | number | 3 | N |
카카오 결과코드
{state} = 3 경우 카카오톡 전송결과 확인 가능
|
|
| altResult | number | 3 | N | 통신사 결과코드 | |
| receiptDT | string | 14 | Y |
접수일시
형식 : yyyyMMddHHmmss
|
|
| reserveDT | string | 14 | N |
예약일시
형식 : yyyyMMddHHmmss
|
|
| resultDT | string | 14 | Y |
전송결과 수신일시
형식 : yyyyMMddHHmmss
|
|
| sendDT | string | 14 | N |
전송일시
형식 : yyyyMMddHHmmss
|
|
| altResultDT | string | 14 | N |
대체문자 전송결과 수신일시
형식 : yyyyMMddHHmmss
|
|
| altSendDT | string | 14 | N |
대체문자 전송일시
형식 : yyyyMMddHHmmss
|
|
| sendNum | string | 20 | Y | 발신번호 | |
| contentType | number | - | Y |
카카오톡 유형
1알림톡
4알림톡 이미지
5알림톡 강조표기
6브랜드 메시지 텍스트
7브랜드 메시지 이미지
8브랜드 메시지 와이드
9브랜드 메시지 리스트
10브랜드 메시지 캐러셀
11브랜드 메시지 동영상
12브랜드 메시지 커머스
13브랜드 메시지 캐러셀 커머스
|
|
| receiveNum | string | 20 | Y | 수신번호 | |
| eventType | string | - | Y |
이벤트 유형
RESULT
|
|
| eventDT | string | 14 | Y |
이벤트 실행일시
형식 : yyyyMMddHHmmss
|
|
| interOPRefKey | string | 20 | N |
파트너 지정 키
카카오톡 대량/동보전송시 파트너가 개별건마다 입력한 값
|
이벤트 예시
{
"corpNum": "1234567890",
"receiptNum": "022111411593500001",
"serialNum": 1,
"state": 3,
"result": 100,
"receiptDT": "20221114115935",
"resultDT": "20221114115937",
"sendDT": "20221114115937",
"sendNum": "07043042991",
"contentType": 2,
"receiveNum": "01011112222",
"eventType": "RESULT",
"eventDT": "20221114115938"
}