Skip to main content
POST
sms.send-options

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

Message text, at most 2000 UTF-16 units.

Required string length: 1 - 2000
senderKey
string
required

Your privately configured sender key.

Required string length: 1 - 128
templateKey
string
required

Your privately configured approved template key.

Required string length: 1 - 128
smsType
enum<string>
required

Approved delivery route.

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

Message encoding.

Available options:
normal,
unicode
priority
enum<string>
default:normal

High priority is an explicit, more expensive choice.

Available options:
normal,
high
shorten
boolean
default:false

Shorten links using your owned custom domain.

shorteningOptions
object

Explicit shortening settings.

bindingChainKey
string

Owned delivery binding chain key.

Required string length: 1 - 128

Response

The result

status
string
required

Accepted for delivery, not proof of receipt.

Allowed value: "queued"
ref
string

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