VOICE API

Delivery Receipt

Go4Clients will send a delivery receipt (where applicable) for each SMS submission. In order for Go4Clients to return this result a Callback URL must be reported. Account Administrators can log into their Go4Clients Managed Messaging Platform account and add a Delivery Receipt Callback URL in the “My Profile > Settings” section.

HTTP Methods

The request parameters are sent via HTTP POST to the Delivery Receipt CallBack URL on the account. Go4Clients will be expecting a 200 OK response, or it will keep retrying until either the Delivery Receipt expires (up to 72 hours) or the maximum amount of attempts is reached (up to 10 attempts).

Request Parameters

The Go4Clients Delivery Receipt request includes the following parameters:

Parameters
messageId
String (Required)

The unique message ID reference assigned to each submitted SMS.

dlrDeliverInitTStamp
String-Date (Required)

Timestamp of when the delivery receipt is initially sent, used in the following format:
yyyy-MM-dd HH:mm:ss.SSS-z

Example
1
2015-08-25 14:26:57.555-0500
mblNetworkReceiveTStamp
String-Date (Required)

Timestamp where the message was received from the mobile network, used in the following format:
yyyy-MM-dd HH:mm:ss.SSS-z

Example
1
2015-08-25 14:26:57.555-0500
requestId
Number-Integer (Required)

An integer that represents a unique reference ID of the request (all transactions).

recipientNumber
String (Required)

The recipient MSISDN number where the initial message was sent.

deliverReceiptStatus
String-Enumerated

The Status related to the inbound delivery receipt.

errorCode
String (Required)

An integer representing the return code of the response / error. Please reference Response Codes table Anex A.

messagePrice
Number-Double

The price of the message (in U.S. Dollars).

mccmnc
Enum

Identifies the mobile network’s MCCMNC code in relation to the message, used in the following format: MCC/MNC

campaignUuid
String

Campaign name.

operatorName
String

Mobile network name.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
    "messageId": "73139043",
    "deliverInitTStamp": "2017-12-14",
    "mblNetworkReceiveTStamp": "2017-12-14",
    "requestId": null,
    "sourceNumber": "Random",
    "recipentNumber": "573178117399",
    "deliverReceiptStatus": "DELIVRD",
    "errorCode": "000",
    "messagePrice": 0.011,
    "mccmnc": "123/981",
    "campaignUuid": "Mi campaña con landing",
    "operatorName": "Telefonica Moviles Colombia SA"
}

3.3 Delivery Receipt Status Table

Receipt Status
DELIVERED

The message was delivered to the destination.

EXPIRED

The message validity period has expired.

DELETED

The message has been deleted.

UNDELIVERABLE

The message is undeliverable.

ACCEPTED

The message was accepted.

UNKNOWN

The message is in an invalid status / Unknown status.

REJECTED

The message was rejected.