POST
/
sms
/
send
cURL
curl --request POST \
  --url https://api.simpu.co/sms/send \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "sms",
  "recipients": "2348023456789, 2348098765432",
  "sender_id": "Simpu",
  "content": "Hello! World. This is a test message.",
  "template_id": "674535b2b39158b9aae90188fcec23eb",
  "personalisation": [
    {
      "to": "2348023456789",
      "substitutions": {
        "name": "John Doe"
      }
    }
  ],
  "external_ref": "674535b2b39158b9aae90188fcec23eb",
  "is_trackable": false,
  "callback": "https://example.com/sms/delivery_report"
}'
{
  "id": "674535b2b39158b9aae90188fcec23eb",
  "recipients": [
    "2348023456789"
  ],
  "sender_id": "Simpu",
  "is_trackable": false,
  "content": "Hello! World. This is a test message.",
  "external_ref": "674535b2b39158b9aae90188fcec23eb",
  "callback": "https://example.com/sms/delivery_report",
  "template_id": "674535b2b39158b9aae90188fcec23eb",
  "personalisation": [
    {
      "to": "2348023456789",
      "substitutions": {
        "name": "John Doe"
      }
    }
  ],
  "created_datetime": "2024-06-28T23:56:38.128604+00:00",
  "updated_datetime": "2024-06-28T23:56:38.128604+00:00",
  "meta": {
    "method": "POST",
    "resource": "/send/sms",
    "estimate": {
      "available_balance": 1000.5,
      "charge": 3,
      "encoding": "UTF-8",
      "message_length": 160,
      "pages": 1
    }
  }
}

Authorizations

​
Authorization
string
header
required

An API key to authenticate requests

Body

application/json

SMS message object

​
recipients
string
required

Recipients of the SMS message, comma separated list of phone numbers

Example:

"2348023456789, 2348098765432"

​
sender_id
string
required

Sender ID of the SMS message

Maximum length: 11
Example:

"Simpu"

​
channel
enum<string>

Channel to send the SMS message

Available options:
sms,
whatsapp
Example:

"sms"

​
content
string

Content of the SMS message, this is required if a template ID is not specified

Example:

"Hello! World. This is a test message."

​
template_id
string

Template ID of the SMS message, this is required if content is not specified

Example:

"674535b2b39158b9aae90188fcec23eb"

​
personalisation
object[]

Personalisation of the SMS message, this is applicable if a template ID is specified

​
external_ref
string

This is a reference to the message in your system

Example:

"674535b2b39158b9aae90188fcec23eb"

​
is_trackable
boolean
default:false

This determines if links in the message should be tracked, links in the message will be replaced with trackable links

Example:

false

​
callback
string

This is the URL to receive delivery reports for the message test

Example:

"https://example.com/sms/delivery_report"

Response

SMS response

​
id
string
required

Unique ID of the SMS message

Example:

"674535b2b39158b9aae90188fcec23eb"

​
recipients
any[]
required

Recipients of the SMS message

Example:
["2348023456789"]
​
sender_id
string
required

Sender ID of the SMS message

Maximum length: 11
Example:

"Simpu"

​
is_trackable
boolean
required

This determines if links in the message should be tracked

Example:

false

​
content
string

Content of the SMS message

Example:

"Hello! World. This is a test message."

​
external_ref
string

This is a reference to the message in your system

Example:

"674535b2b39158b9aae90188fcec23eb"

​
callback
string

This is the URL to receive delivery reports for the message

Example:

"https://example.com/sms/delivery_report"

​
template_id
string

Template ID of the SMS message

Example:

"674535b2b39158b9aae90188fcec23eb"

​
personalisation
object[]

Personalisation of the SMS message

​
created_datetime
string

Date and time the SMS was created

Example:

"2024-06-28T23:56:38.128604+00:00"

​
updated_datetime
string

Date and time the SMS token was last updated, if any

Example:

"2024-06-28T23:56:38.128604+00:00"

​
meta
object