Incoming Status

This API is used by Sprint to send Incoming Status to the client.

Requirement

After sending a message, you will receive a delivery status containing the following parameters. Before that, the client must create an endpoint that can be accessed by Sprint to send a delivery status

This section explains the request parameters and provides example JSON requests for message delivery status updates.

Description Parameter Request

FIELD	TYPE ALLOWED	DESCRIPTION
status	JSON Object	Details information from statuses
message_id	String	ID generated from the message sending API
provider_message_id	String	Unique message ID provided by the provider.
recipient_id	String	Unique identifier of the message recipient.
status	Integer	Message status: -3 Failed, -2 Undelivered, -1 Unsent, 0 Pending, 1 Sent, 2 Delivered, 3 Read
tid	String	Transaction ID generated during the sending process.
times	Integer	Format = Unix Timestamp from user's access period
timestamp	Timestamp	Format = Date Time indicates the user's access period.

Sample JSON Request

{
    "status": {
        "message_id": "317077fd-xxxx-xxxx-xxxx-xxxxxxxx",
        "provider_message_id": "",
        "recipient_id": "628xxxxxxxx",
        "status": 2,
        "tid": "8498d7e4-xxxx-xxxx-xxxx-xxxxxxxx",
        "times": 0,
        "timestamp": "2023-11-10T12:38:08.168309367+07:00"
    }
}