Message sending result (WebHook)

The results of the Kakao Messaging API are delivered to the client's callback URL.

WebHook API

The processing results for messages requested by the client are delivered to the client's callback URL. (API PLEX ➡ client URL)

Client callback URL information can be entered during service application or modified in [Service Console / Integration Information / Callback URL].

Access to the client's callback URL by API PLEX must be allowed. (IP, PORT)

If the client's server fails to receive the webhook, it will be retried up to 10 times.

API that delivers Kakao API processing results to the specified {Callback URL}

POST {Callback URL}

200: OK Response returned successfully

Webhook body (API PLEX ➡ Client URL)

{
    "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 format

key			type	description
results			object array	An array for the sending result (although in array format, it is sent one by one)
	msg_key		string	Message unique key (the key used in the sending request or assigned by API PLEX)
	code		string	Sending result code (Refer to Kakao result codes)
	desc		string	Sending result code description (Refer to Kakao result codes)
	request_date		string	Time of acceptance (yyyy-MM-dd HH:mm:ss.SSS)
	done_date		string	Time of final processing (yyyy-MM-dd HH:mm:ss.SSS)
	echo_to_webhook		string	The string to be received along with the webhook when the user requests it.
	failback		object	The result object for the failback requested by the user (refer to Failback)
		api_unique_id	string	The unique ID of the failback service requested by the user
		message_type	string	The message type requested by the user (SMS, LMS, MMS)

Kakao result code

code	description
0	Success
t	The message is empty
k	The message does not exist
1	The sender profile key is not valid
V	Comparison failure between the message and the template
L	Message length limit error
M	Cannot find the template
U	The message does not match the template
A	non-kakaoTalk user
9	KakaoTalk user who didn't used the service recently
E	Unsupported client version
2	User not connected to the server
B	User who selected to block notifications for Alim Talk
5	Uncertain whether the message was received after sending
6	Cannot find the message transmission result
H	Kakao system error
I	Phone number error
J	Unable to send to 050 Safe Numbers
C	Duplicate message serial number
D	Duplicate sending of messages within 5 seconds
8	Unable to send messages
f	Message format error
F	Other error
S	Sender number verification error
G	Kakao service outage

Response body (Client URL ➡ API PLEX)

{
    "code": "100",
    "desc": "success"
}

key	type	required	description
code	string	Y	Webhook reception result code (send response with "100" for normal reception)
desc	string	Y	Webhook reception result details (e.g., "desc":"success")