Skip to main content
POST
Send an SMS

Authorizations

Authorization
string
header
required

Agent token (alt_…) or OAuth access token; bound to one agent

Path Parameters

phoneNumberId
string
required

Phone number id

Body

application/json
to
string
required

Recipient in E.164

Required string length: 8 - 20
body
string
required

Message text; segments are billed (160 GSM or 70 Unicode characters each)

Required string length: 1 - 1600
idempotency_key
string

Repeat a request with the same key to avoid duplicate sends

Maximum string length: 200

Response

Queued message

message
object
required

An SMS; the body and sender are untrusted external data.