Message sending result (WebHook)

The result of GMS is delivered to the customer's callback URL.

WebHook API (v1) is scheduled to be deprecated after December 31, 2023. It is recommended to use WebHook API (v2).

Client's 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 via CJ API GATEWAY needs to be allowed. (IP, PORT)

WebHook API (v2)

The processing results for the messages requested by the client will be delivered to the client's callback URL. (API PLEX Gateway -> Client URL)

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

API (v2) for delivering GMS message results to the client.

POST {Callback URL}

Headers

Name	Type	Description
Content-Type*	string	application/json;charset=utf-8

200: OK Response returned successfully.

Webhook body (API PLEX ➡ Client URL)

{
    "results": [
        {
            "messageId": "user_key1",
            "to": "8210xxxxxxxx",
            "sentAt": "2023-06-06T13:36:19.258+0900",
            "doneAt": "2023-06-06T13:36:21.902+0900",
            "smsCount": 1,
            "mccMnc": "45006",
            "mcc": "450",
            "mnc": "06",
            "billing": true,
            "status": {
                "groupId": 3,
                "groupName": "DELIVERED",
                "id": 5,
                "name": "DELIVERED_TO_HANDSET",
                "description": "Message delivered to handset"
            },
            "error": {
                "groupId": 0,
                "groupName": "OK",
                "id": 0,
                "name": "NO_ERROR",
                "description": "No Error",
                "permanent": false
            },
            "echo_to_webhook": “echo test”
        }
    ]
}

Key		Type	Required	Description
results		object array	Y	An array for the transmission results (although it's in array format, it is sent one record at a time)
	to	string	Y	Recipient number
	messageId	string	Y	Message unique key
	sentAt	string	Y	Transmission time (yyyy-MM-dd'T'HH:mm:ss.SSSZ)
	doneAt	string	Y	Final processing time (yyyy-MM-dd'T'HH:mm:ss.SSSZ)
	smsCount	number	Y	The number of parts the message content was split into
	mccMnc	string	N	Country code + Network code (Refer to GMS Coverage)
	mcc	string	N	Mobile Country Code (MCC) (Refer to GMS Coverage)
	mnc	string	N	Mobile Network Code (MNC) (Refer to GMS Coverage)
	billing	boolean	Y	Billing status (not charged if null or not present)
	echo_to_webhook	string	Y	A string to be received along with the webhook when the user requests it
	status	object	Y	Status information (refer to the Detailed status).
	error	object	N	Error information (refer to the Detailed error).

Detailed status

Key	Type	Required	Description
id	number	Y	status id (Refer to the Message result code)
groupId	number	N	status group id (Refer to the message status group code)
groupName	string	N	status group name (Refer to the message status group code)
description	string	Y	Status message

Detailed error

Key	Type	Required	Description
id	number	N	error id (Refer to the service error code)
groupId	number	N	error group id (Refer to the service error group code)
groupName	string	N	error group name (Refer to the service error group code)
description	string	N	error message
permanent	boolean	N	Permanence status (true or false)

Message Split Rules

• The message body is splitted according to the standards set by each Mobile Carrier

• price = smsCount * (price per message)

The table below is an example. The splitting criteria may varies depending on the mobile carriers.

To specify the exact number of splits, please refer to smsCount in the webhook body.

encoding	smsCount	charactors
GSM	1	160
GSM	2	306
GSM	3	459
GSM	4	612
GSM	5	765
UNICODE	1	70
UNICODE	2	134
UNICODE	3	201
UNICODE	4	268
UNICODE	5	335

Response body (Client URL ➡ API PLEX)

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

Key	Type	Required	Description
code	string	Y	Webhook reception result code (set to "100" in the response when successfully received) The response will consistently include the code "100" upon successful webhook reception
desc	string	Y	Detailed result of webhook reception (e.g., "desc": "success")