Webhook 전송 이벤트

Webhook Header

필드명	설명	필수	예시
Pb-Webhook-Type	Webhook 유형	○	KAKAO.STATE
Pb-Webhook-MID	이벤트 식별값	○	016120000002-1777d55c2c41492ab06826d
Pb-Webhook-Corpnum	팝빌 사업자번호	○	6798700433
Content-Type	Webhook 메시지 Body 타입	○	application/json
Authorization	Base64 인코딩한 BASIC 인증정보	-	Basic VEVTVDoxMjM= └ HTTP 인증 사용하는 경우 추가 항목
X-Api-Key	API Key 인증정보	-	TESTAPIKEY └ HTTP 인증 사용하는 경우 추가 항목

팝빌은 기본으로 제공되는 Header 필드 외 프로그램 공급사 운영환경에 맞춘 커스텀 필드 지원이 가능합니다.
커스텀 필드 추가가 필요한 경우 기술지원센터(1600-9854)로 문의주시기 바랍니다.

Webhook Body

필드명	타입	길이	필수	비고
corpNum	String	10	○	팝빌회원 사업자번호
receiptNum	String	18	○	접수번호
requestNum	String	36	-	전송요청번호
serialNum	Number	-	○	일련번호
state	Number	1	○	알림톡/친구톡 전송상태 코드 : 0 / 1 / 2 / 3 / 4 중 반환 └ 0 : 접수 └ 1 : 대기중 └ 2 : 처리중 └ 3 : 완료 └ 4 : 취소 ※ 전송상태 코드 상태 값은 작아지지 않음
result	Number	3	-	알림톡/친구톡 전송결과 코드 └ 상태코드가 3 인 경우, result 값이 존재 └ [카카오톡 상태코드] 바로가기
altResult	Number	3	-	대체문자 전송결과 코드 └ [카카오톡 상태코드] 바로가기
receiptDT	String	14	○	접수일시 (형식 : yyyyMMddHHmmss)
reserveDT	String	14	-	예약일시 (형식 : yyyyMMddHHmmss)
resultDT	String	14	○	알림톡/친구톡 전송결과 수신일시 (형식 : yyyyMMddHHmmss)
sendDT	String	14	-	알림톡/친구톡 전송일시 (형식 : yyyyMMddHHmmss)
altResultDT	String	14	-	대체문자 전송결과 수신일시 (형식 : yyyyMMddHHmmss)
altSendDT	String	14	-	대체문자 전송일시 (형식 : yyyyMMddHHmmss)
sendNum	String	20	○	발신번호
contentType	Number	1	○	카카오톡 전송유형 : 1 / 2 / 3 중 반환 └ 1 : 알림톡 └ 2 : 친구톡 텍스트 └ 3 : 친구톡 이미지
receiveNum	String	20	○	수신번호
eventType	String	-	○	이벤트 유형 : "RESULT" / "MANUAL" 중 반환 └ "RESULT" : 팝빌 시스템에서 카카오톡 전송 결과 확인하여 자동으로 Webhook 실행한 경우 └ "MANUAL" : 팝빌 사이트에서 사용자가 수동으로 Webhook 실행한 경우
eventDT	String	14	○	이벤트 실행일시 (형식 : yyyyMMddHHmmss)
interOPRefKey	String	20	-	파트너 지정 키 └ 대량/동보전송시 파트너가 개별건마다 입력한 값

전송완료

발신자가 보낸 카카오톡 메시지가 수신자에게 전송에 성공한 시점에 실행됩니다.

{
    "corpNum": "1234567890",
    "receiptNum": "022111411593500001",
    "serialNum": 1,
    "state": 3,
    "result": 100,
    "receiptDT": "20221114115935",
    "resultDT": "20221114115937",
    "sendDT": "20221114115937",
    "sendNum": "07043042991",
    "contentType": 2,
    "receiveNum": "01042847884",
    "eventType": "RESULT",
    "eventDT": "20221114115938"
}

전송실패

발신자가 보낸 카카오톡 메시지가 수신자에게 전송에 실패한 시점에 실행됩니다.

{
    "corpNum": "1234567890",
    "receiptNum": "022111412023600001",
    "serialNum": 1,
    "state": 3,
    "result": 802,
    "receiptDT": "20221114120236",
    "resultDT": "20221114120236",
    "sendNum": "1599-7709",
    "contentType": 2,
    "receiveNum": "01011112222",
    "eventType": "RESULT",
    "eventDT": "20221114120238"
}

예약취소

발신자가 예약한 카카오톡 메시지를 취소한 시점에 실행됩니다.

{
    "corpNum": "1234567890",
    "receiptNum": "022111412161400001",
    "serialNum": 1,
    "state": 4,
    "receiptDT": "20221114121615",
    "reserveDT": "20221115121600",
    "resultDT": "20221114121632",
    "sendNum": "1599-7709",
    "contentType": 2,
    "receiveNum": "01011112222",
    "eventType": "RESULT",
    "eventDT": "20221114121632"
}