Message sending result (WebHook)

The results of SMS, LMS, and MMS are delivered to the client's callback URL.

The processing results for messages requested by the client are sent to the customer's client 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 for delivering the processing results of Biz Message SMS, LMS, MMS to {Callback URL}

POST {Callback URL}

200: OK Response returned successfully

Webhook Body Example (API PLEX ➡ Client URL)

{
    "results": [
        {
            "code": "0",
            "desc": "성공",
            "dest": "LGU",
            "request_date": "2022-10-22 13:52:40.000",
            "done_date": "2022-10-22 13:52:44.390",
            "msg_key": "4b68ca16-7aa8-4a17-b74c-2b8e4adb13f8",
            "echo_to_webhook": "echo test",
            "message_type": “MMS”
        }
    ]
}

Webhook body format

key		type	required	description
results		object array	Y	An array for the sending result (although in array format, it is sent one by one)
	msg_key	string	Y	Message unique key (the key used in the sending request or assigned by API PLEX)
	code	string	Y	Sending result code (Refer to Message result codes)
	desc	string	N	Sending result code description (Refer to Message result codes)
	dest	string	N	Final destination Mobile carrier (SKT, KT, LGU)
	request_date	string	Y	Time of acceptance (yyyy-MM-dd HH:mm:ss.SSS)
	done_date	string	Y	Time of final processing (yyyy-MM-dd HH:mm:ss.SSS)
	echo_to_webhook	string	Y	The string to be received along with the webhook when the user requests it.
	message_type	string	Y	The message type requested by the user (SMS, LMS, MMS)

Message result codes

code	description
G410	API PLEX → Source service request failed
G430	Source service → API PLEX result reception failed (timeout)
d	Blocked duplicate recipient numbers upon reception
e	Internal server error
q	Duplicated keys in messages
p	Blocked duplicate message bodies
0	Success
1	Transmission time exceeded
5	No reception of carrier results
8	Mobile device is busy
9	Out of coverage area
A	Exceeded the limit for storing messages on the mobile device
E	Power off
2	Invalid phone number/Non-subscriber
B	Temporary service suspension on the mobile device
C	Other issues with the mobile device
D	Call rejection
F	Others
G	Internal format error
H	Carrier format error
I	Unsupported device for SMS/MMS service
J	Unable to reach the recipient's host
K	Message deletion processed by the carrier
L	Carrier unable to process the message
M	Wireless network transmission failure
S	Spam message
V	Exceeded content size limit
U	Invalid content
o	timeout

Response Body (Client URL ➡ API PLEX)

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

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