GET
/
sms
/
list

Headers

ApiKey
string
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.

MerchantId
string
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
enum<string>
required

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

Available options:
live,
sandbox

Query Parameters

from
string

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

to
string

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

page
number

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

perPage
number

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

Response

200 - application/json
id
string
required

unique identifier for the sms.

senderId
string
required

Identifier of the merchant that send the sms

senderName
string
required

name of the merchant that send the sms

destination
string
required

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

smsCount
number
required

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

message
string
required

Message content

status
string
required

Status of the sms

createdAt
string
required

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

sentAt
string
required

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

receivedAt
string
required

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

failureCause
object
required

Object describing the failure

Retrieve number of sms sentSend Sms