ServiceBlog

메시지 발송 결과 (WebHook)

카카오 메세징 API의 결과값을 고객사 callback URL로 전달합니다.

WebHook API

고객사가 요청한 메시지에 대한 처리 결과를 고객사의 callback URL로 전달합니다. (API PLEX ➡ 고객사 URL)

고객사 callback URL 정보는 서비스 신청 시 입력하거나 [서비스 콘솔 / 연동 정보 / Callback URL]에서 수정할 수 있습니다.

고객사 callback URL에 대한 API PLEX의 접근을 허용해야 합니다. (IP(43.202.205.42, 52.78.51.46), PORT)

고객사 server에서 webhook을 수신하지 못하였을 시 10회 까지 재시도합니다.

카카오 API 처리 결과를 {Callback URL}로 전달하는 API

POST {Callback URL}

Webhook body (API PLEX ➡ 고객사)

{
    "results": [
        {
            "code": "F",
            "desc": "기타",
            "request_date": "2023-05-01 00:00:00.000",
            "done_date": "2023-05-01 00:00:00.000",
            "msg_key": "user_key_1",
            "echo_to_webhook": "echo test",
            "failback": {
                "code": "F",
                "desc": "기타",
                "dest": "ETC",
                "done_date": "2023-05-01 00:00:00.000",
                "api_unique_id": "sms-standard",
                "message_type": "SMS"
            }
        }
    ]
}

전송되는 webhook body 형식

키
타입
설명

results

object array

발송결과에 대한 배열 (배열 형식이지만 1건씩 전송됨)

msg_key

string

메시지 고유 키 (발송 요청 시 사용한 메시지 고유 키 또는 API PLEX가 부여한 키)

code

string

발송 결과 코드 (카카오 결과 코드 참조)

desc

string

발송 결과 코드 상세 (카카오 결과 코드 참조)

request_date

string

접수 시간 (yyyy-MM-dd HH:mm:ss.SSS)

done_date

string

최종 처리 시간 (yyyy-MM-dd HH:mm:ss.SSS)

echo_to_webhook

string

사용자가 요청 시 입력한 webhook을 받을 때 함께 받을 string

failback

object

사용자가 요청한 failback에 대한 결과 object (Failback 참조)

api_unique_id

string

사용자가 요청한 failback service의 고유 id

message_type

string

사용자가 요청한 message type (SMS, LMS, MMS)

카카오 결과 코드

code
설명

0

성공

t

메시지가 비어있음

k

메시지가 존재하지않음

1

발신 프로필 키가 유효하지않음

V

메시지와 템플릿 비교 실패

L

메시지 길이 제한 오류

M

템플릿을 찾을 수 없음

U

메시지가 템플릿과 일치하지않음

A

카카오톡 미사용자

9

최근 카카오톡을 미사용자

E

미지원 클라이언트 버전

2

서버와 연결되어있지않은 사용자

B

알림톡 차단을 선택한 사용자

5

메시지 발송 후 수신여부 불투명

6

메시지 전송결과를 찾을 수 없음

H

카카오 시스템 오류

I

전화번호 오류

J

050 안심번호 발송불가

C

메시지 일련번호 중복

D

5초 이내 메시지 중복 발송

8

메시지를 전송할 수 없는 상태

f

메시지포멧 오류

F

기타 오류

S

발신번호 검증 오류

G

카카오 측 서비스 장애

Response body (고객사 ➡ API PLEX)

{
    "code": "100",
    "desc": "success"
}
키
타입
필수
설명

code

string

Y

webhook 수신 결과 코드 (정상 수신시 "100") 정상적으로 webhook 수신 시 응답에 code를 “100”으로 고정하여 발송

desc

string

Y

webhook 수신 결과 상세 (ex: "desc":"success")

Last updated

Was this helpful?