Sign in

v1

latestOpenAPI 3.0.02026-07-265892227.1 KB
Sms

Send Sms

Send Sms to different destinations.

post/sms

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.

Request body

destinationsstring[] required

Array of destinations number with country code (+44...) or in international format (0044 ...)

messagestring required

Message content

senderNamestring required

Merchant name

webhookUrlstring

Webhook Url

Example request

{
  "message": "my message",
  "senderName": "my company",
  "webhookUrl": "https://my.webhook.target"
}

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"
  }
]