Send a SMS

post

https://api.liguelead.com.br/v1/sms

This endpoint is responsible for receiving requests to send SMS messages. SMS processing is performed asynchronously. Upon receiving a request, the service immediately responds with a 200 OK status, indicating that the request has been received and queued; delivery happens afterwards.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

title

string

Title used to identify the sms delivery.

message

string

required

length ≤ 1600

Message that will be sent. At most 1,600 characters. Accents are removed and characters outside letters, digits, spaces and common punctuation (emoji included) are dropped before sending; credits are counted on that text: 1 up to 160 characters, ceil(length / 152) above.

phones

array of strings

required

length between 1 and 10000

An array of phone numbers as strings. Brazilian numbers are accepted with or without the country code (5511999999999, +5511999999999 or 11999999999); prefer the form with it. Without it, 10 or 11 digits are a national number and get 55 in front, area code 55 included (55991234567 is sent as 5555991234567). Each number may contain only digits, +, (, ) and -, and must have 10 to 16 digits. At most 10,000 numbers per request: a longer list is a 422. A body over 250 KB, around 15,000 numbers, is refused before that, with a 413.

phones*

is_flash

boolean

Defaults to false

Defines whether the message will be sent via Flash.

group_id

string

deprecated

Deprecated. Accepted for compatibility and ignored: it has no effect on the send. When present it must be a string, or the request is a 422.

webhook_url

uri

length ≤ 512

Optional. URL that receives the status events (campaign.status) of this send instead of the app's webhook URL, in the same model as the Twilio StatusCallback. It is called exactly as written, query string included, so it can carry your own identifiers (for example ?order=123). Replies and button postbacks keep going to the app's webhook URL. Must use http or https, have a public hostname without underscores and be at most 512 characters; private and reserved addresses are refused. No authentication header is sent to it.

Response

Language

Credentials

Loading…

Response

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

application/json

200SMS accepted successfully