v1

latestOpenAPI 3.1.02026-08-0416027.2 KB

Send SMS

A simple send SMS API

post/sms/send

Request body

tostring[] required

This represents the destination phone number. The phone number(s) must be in the international format (Example: 23490126727). You can also send to multiple numbers. To do that put numbers in an array (Example: [ '234somenumber', '234anothenumber' ]).

messagestring required

Text message being sent.

sender_namestring required

Represents the sender of the message. This Sender ID must have been requested via the dashboard or use "Sendchamp" as default

routestring required

Here you can specify a route you want your SMS to go through. dnd, non_dnd or international

Response

200

codeinteger

{"stackTrail":"paths:/sms/send:post:responses:200:content:application/json:schema:properties:errors","oasType":"schema","type":"unknown"}

messagestring

statusstring

Example response

{
  "code": 200,
  "data": {
    "id": "MN-SMS-ad51fcd1-8257-4fc5-b6df-11cf2ddcdfac",
    "phone_number": "2348134844186",
    "reference": "MN-SMS-ad51fcd1-8257-4fc5-b6df-11cf2ddcdfac",
    "status": "processing"
  },
  "message": "processing",
  "status": "success"
}