API Reference

Send SMS

post
https://api.naxai.com/sms/send

Send SMS

Body Params
string
length ≤ 64

An identifier for the batch sending.

to
array of strings
required
length between 1 and 1000

A list of phone numbers (max 1000)

to*
string
required
length ≤ 2000

The message content. Can be a text or unicode content depending on 'type'.

string
length ≤ 15

The name or number the message should be sent from (Sender ID), can be omitted if Sender Service Id is used.

uuid

The Sender Service Id to use when sending the message, when used override the from value.

string
enum
Defaults to text
Allowed:
integer

Date and time when the message must be sent in Unix time (epoch).

integer
5 to 4320

If set, the system will stop trying to deliver the message at this point. Validity period longer than 72h (4320 minutes) is not supported. Value in minutes.

string
length ≤ 128

An optional idempotency key ( max 128 characters long and supported characters: a-zA-Z0-9_- ).

string
length ≤ 128

Your own reference used to identify message up to 128 characters. If set, the reference will be added in the delivery report.

uuid

Used to set specific delivery window outside of which messages won't be delivered. See 'Calendars' to define Time Windows

integer
1 to 30

Number of max parts allowed when sending messages.

boolean
Defaults to false

If set, the message is truncated to the maxParts value.

Headers
string
Defaults to 2023-03-25

The version of API, by default use the last version.

Responses

Updated 7 months ago

Language
Credentials
OAuth2
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago