Send SMS

post

https://api.callr.com/v2.0/sms

Send an SMS. If accepted, the SMS will cycle through the following statuses:

created
pending
sent
remote-queued
delivered

At any time, the SMS can be in the following statuses:

error: was not accepted
failed: rejected by the carrier
expired: was not delivered to the recipient

Query Params

string

required

SMS recipient

from

length between 0 and 11

The SMS sender. If empty, a value will be automatically set depending on the destination. Otherwise, the sender must be either a phone number, or an alphanumeric sender (with at least one character - 11 chars maximum). Custom SMS senders must be approved by our team and downstream carriers. You can request a custom sender on https://app.callr.com.

encoding

string

enum

By default, we automatically detect the encoding based on the characters used in the body. If you want to force the encoding, you can use this field. The SMS body will be processed according to the encoding specified. Depending on the encoding, messages may be split into parts of 153 (GSM 03.38) or 67 (UNICODE) characters. Please note that some countries only support GSM encoding.

Allowed:

trafficType

string

enum

Defaults to marketing

Traffic type of an SMS message. Carriers require this to be set to either marketing or alerting.

Allowed:

Body Params

text

string

required

length between 1 and 3200

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202SMS accepted

400Bad Request

401Unauthorized

403Forbidden

405Method Not Allowed

500Internal Server Error