SMS

Send SMS

Sends an SMS from one of your organization's phone numbers.

post/v1/sms/send

Request

Request body

from_numberstring required

Sender, in E.164 format. Must be an SMS-enabled number owned by your organization.

to_numberstring required

Recipient, in E.164 format.

messagestring required

Message body.

Example request

{
  "from_number": "+14155550100",
  "to_number": "+14155550123",
  "message": "Your appointment is confirmed for 3pm tomorrow."
}

Response

Successful Response

statusstring required

Delivery status reported by the carrier, e.g. queued or sent.

Changes

No recorded changes to this operation across all 1 revision of this API.