Sign in

v1

latestOpenAPI 3.0.02026-07-244771176.5 KB
Reporting

Get Message/Campaign Information

This will return information about the campaign, including the message, list etc. It will not however return individual messages with populated variables or tracking links. To retrieve final individual messages use get-sms-delivery-status.

post/get-sms.json

Response

Successful response

message_idinteger

Numeric ID assigned to the message that was sent

send_atstring date-time

Date and time that message was sent from your account. Returned in ISO8601 format YYYY-MM-DD HH:MM:SS in UTC Timezone.

recipientsinteger

Number of recipients message was sent to

costnumber double

Total cost of all messages. Returned as value per account currency to 3 decimal places 0.000

smsinteger

Total number of message parts delivered. If the message is longer than 160 characters this will return count of all parts. Eg. if a 180 character message is delivered to 2 recipients. Value returned will be 4.

messagestring

Content of message sent

liststring

ID and name of list delivered to