Sign in

v1

latestOpenAPI 3.0.02026-07-265892227.1 KB
Sms

Get a list of sms sent

Retrieve a list of sms sent between two date.

get/sms/list

Query parameters

fromstring
Example:2020-10-15T12:09:49.355Z

A date in UTC timezone to filters data from, inclusively. Follows the Datetime ISO. The default value is the first day of this month.

tostring
Example:2020-10-15T12:09:49.355Z

A date in UTC timezone to filters data to, inclusively. Follows the Datetime ISO. The default value is now().

pagenumber
Example:2

The page number in the returned data. The default value is 1. Do use with 'perPage' query parameter to paginate properly.

perPagenumber
Example:5

The maximum number of results that will be return. The default value is 10. Do use with 'page' query parameter to paginate properly.

Headers

ApiKeystring required

Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.

MerchantIdstring required

Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.

Environment'live' | 'sandbox' required

Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.

Response

idstring required

unique identifier for the sms.

senderIdstring required

Identifier of the merchant that send the sms

senderNamestring required

name of the merchant that send the sms

destinationstring required

Number of the recipient with country code (+44...) or in international format (0044 ...)

smsCountnumber required

Number of Sms sent , depending on the message length (1 sms per 160 character)

messagestring required

Message content

statusstring required

Status of the sms

createdAtstring required

Datetime in UTC timezone at which the sms was created. Follows theDatetime ISO.

sentAtstring required

Datetime in UTC timezone at which the sms was sent. Follows theDatetime ISO.

receivedAtstring required

Datetime in UTC timezone at which the sms was received. Follows theDatetime ISO.

failureCauseSmsFailureCauseDto required

Example response

[
  {
    "id": "sms_QIVmCKgbOAcXm4BbVt15H",
    "senderId": "1",
    "senderName": "my_company",
    "destination": "+33600000000",
    "message": "My message",
    "status": "received",
    "createdAt": "2021-08-19 11:00:31.225+00",
    "sentAt": "2021-08-19 11:00:31.229+00",
    "receivedAt": "2021-08-19 11:00:32.225+00"
  }
]