POST
/
sms
[
  {
    "id": "sms_QIVmCKgbOAcXm4BbVt15H",
    "senderId": "1",
    "senderName": "my_company",
    "destination": "+33600000000",
    "smsCount": "7",
    "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",
    "failureCause": "{\"FailureCause\": \"not_delivered\",\n    \"message\":\"Le message a été envoyé mais n'a pas pu être délivré.\"\n  }"
  }
]

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

Body

application/json
​
destinations
string[]
required

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

Example:

"[\"+3300000000\",\"+330000001\"]"

​
message
string
required

Message content

Example:

"my message"

​
senderName
string
required

Merchant name

Example:

"my company"

​
webhookUrl
string
deprecated

Webhook Url

Example:

"https://my.webhook.target"

Response

201
application/json
​
id
string
required

unique identifier for the sms.

Example:

"sms_QIVmCKgbOAcXm4BbVt15H"

​
senderId
string
required

Identifier of the merchant that send the sms

Example:

"1"

​
senderName
string
required

name of the merchant that send the sms

Example:

"my_company"

​
destination
string
required

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

Example:

"+33600000000"

​
smsCount
number
required

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

Example:

"7"

​
message
string
required

Message content

Example:

"My message"

​
status
string
required

Status of the sms

Example:

"received"

​
createdAt
string
required

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

Example:

"2021-08-19 11:00:31.225+00"

​
sentAt
string
required

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

Example:

"2021-08-19 11:00:31.229+00"

​
receivedAt
string
required

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

Example:

"2021-08-19 11:00:32.225+00"

​
failureCause
object
required

Object describing the failure

Example:

"{\"FailureCause\": \"not_delivered\",\n \"message\":\"Le message a été envoyé mais n'a pas pu être délivré.\"\n }"