Sign in

v1

latestOpenAPI 3.0.02026-07-265892227.1 KB
Sms

Retrieve number of sms sent

Retrieve number of sms sent between two date

get/sms/count

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().

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

fromstring date-time required

Starting Date. Follows the Datetime ISO.

tostring date-time required

Ending Date. Follows the Datetime ISO.

countnumber required

Number of sms send during the period

Example response

{
  "from": "2021-08-15T12:09:49.355Z",
  "to": "2021-08-20T12:09:49.355Z"
}