Skip to main content
POST
sms.send-configured

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
to
string
required

Recipient phone number, personal data sent for delivery.

Pattern: ^\+[1-9]\d{1,14}$
body
string
required

Text to send, at most 1600 UTF-16 code units.

Required string length: 1 - 1600
senderLabel
string
required

Your registered sender label, not a phone number.

Required string length: 1 - 32
Pattern: ^[A-Za-z0-9]{1,32}$
route
enum<string>
default:transactional

Transactional or promotional delivery route.

Available options:
transactional,
promotional
encoding
enum<string>
default:normal

Normal alphabet or Unicode encoding.

Available options:
normal,
unicode
flash
boolean
default:false

Whether to display a flash message.

dltEntityId
string

Your registered delivery entity identifier; unsupported sources decline it.

Required string length: 1 - 64
dltTemplateId
string

Your own registered delivery template identifier.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9_-]+$
scheduleAt
string

Scheduled local time, YYYY-MM-DD HH:mm:ss; requires scheduleTimezone.

Required string length: 1 - 19
Pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$
scheduleTimezone
string

The configured time zone of the sending account.

Required string length: 1 - 64

Response

The result

status
string
required

Accepted for delivery or scheduled delivery.

Allowed value: "queued"
ref
string

Reference to what this call created. Pass it as ref to sms.status.