Message Delivery Flow

Our eDM delivery service offers HTTP POST method for sending email messages.

Upon receiving a send request through our X Lead platform, we promptly issue a reference id. This immediate feedback serves as an acknowledgment to your system, confirming that we have successfully received the request and queued it for processing.

After processing, we will provide the status of your request through your callback URL. The response may indicate a valid send with the corresponding number of quota to deduct, or it may be an invalid submission due to reasons such as insufficient quota, an invalid email address, or the email being in the unsend list.

Once the message has been submitted to our email gateway, our service extends an additional callback feature. This focuses on the response from the recipient's email server that we relay this information back to you through your callback URL, and this is crucial for understanding the success rate of your sent messages and for troubleshooting any issues related to message delivery.

Our system is designed to keep you thoroughly informed throughout the entire process. From the moment your message is dispatched from our platform, we ensure that each step is communicated back to you for effective tracking.

Here is the complete flow of the delivery and report operation.

Callback URL is the URL you provided to us (setup in dashboard) in order to listen to our updates in below format :

Field	Description
rc	return code
rm	return message with detail explanation, if any
ref_id	reference id that we returned during your original API call
status	submission or delivery status of your API request

There are 2 tiers of callbacks :

1st Callback (Usage Report)

This is an update on the status of your send request. If the request is successfully validated, you will receive a callback (rc = 100) confirming that it has been accepted, along with the number of quota required for this send request. The message will then be sent to the recipient's email server, and quota will be deducted accordingly.

rc = 100 (quota will be deducted)

Status	Description
SMD	A valid send, message has been put to gateway for delivery

Sample Callback Payload (Valid Request)

In the event of a failure (rc = -100), you may encounter the following scenarios with corresponding status.

rc = -100 (quota will not be deducted)

Status	Description
IE	Incorrect email address
IUL	In unsend list, message did not send out
IP	Insufficient quota

Sample Callback Payload (Invalid Request)

2nd Callback (Delivery Report)

When our system receives an update from the carrier, we will initiate a callback to your side to provide this status update. The update may include the following scenarios.

rc = 100 (Must be 100)

Status	Description
DELIVRD	carrier has successfully delivered to the recipient's device
EXPIRED	message is not delivered as processing exceeded the validity period
UNDELIV	undelivered due to unreachable destination, network issues, or recipient's device being turned off
REJECTD	rejected due to invalid content, blacklisted, or policy restrictions
UNKNWN	carrier cannot determine the final delivery status of the message

Sample Callback Payload (Handheld Received)

Sample Callback Payload (Cannot Deliver)

NOTE

You must first log into your account dashboard and set up this Callback URL in order to receive our status update of messages delivery.

There are 2 tiers of callbacks :#

Sample Callback Payload (Valid Request)#

Sample Callback Payload (Invalid Request)#

Sample Callback Payload (Handheld Received)#

Sample Callback Payload (Cannot Deliver)#

There are 2 tiers of callbacks :

Sample Callback Payload (Valid Request)

Sample Callback Payload (Invalid Request)

Sample Callback Payload (Handheld Received)

Sample Callback Payload (Cannot Deliver)