v1

latestOpenAPI 3.1.02026-07-24700259.3 KB
SMS

Send SMS

Send an SMS message to one or more numbers, up to a maximum of 100 numbers.

post/sms/send

Request body

destinationstring[] required

An array of SMS numbers to send the message to (Maximum: 100 numbers). Numbers should include the country code of the recipient, and can optionally start with a plus symbol (+).

senderstring

The message will be sent from this number (must be in e.164 format). Leave empty to use the default sender number. If the source and destination are located in different countries, a shared number in the recipient's country will be used for sending.

contentstring required

The content of the SMS. If more than 160 characters, will be sent as multiple units.

Example request

{
  "destination": [
    "+12025550959"
  ]
}

Response

SMS Sent

request_idstring required

Example response

{
  "data": {
    "statuses": {
      "queued": 1
    },
    "total_sent": 1,
    "messages": [
      {
        "destination": "+12025550959",
        "message_id": "d6b0e06d-f031-4485-8e92-8141816b3a22",
        "status": "queued"
      }
    ]
  },
  "request_id": "13ab6f3a-ddea-11eb-b4ce-1002b51e60a4"
}