send_sms
send_sms
Send an outbound message to a PSTN phone number.
Properties
send_sms
An object that accepts the following properties. Supports both SMS and MMS messages. See message types below for the properties specific to each type.
Message types
The send_sms object accepts the following properties depending on the message type:
SMS
MMS
send_sms.to_number
Phone number to send SMS message to in e.164 format
send_sms.from_number
Phone number SMS message will be sent from
send_sms.body
Body of the text message
send_sms.region
Region of the world to originate the message from
send_sms.tags
Array of tags to associate with the message to facilitate log searches
send_sms.status_callback
URL to receive delivery status callbacks for the outbound message (e.g., queued, sent, delivered, failed). Default is not set. See Status callbacks below.
Variables
Set by the method:
- send_sms_result: (out)
success|failed.
Status callbacks
Status callbacks are advisory
Status callbacks are asynchronous, best-effort HTTP notifications: delivery can be delayed or fail silently — if your server is unreachable, the callback simply never arrives. Don’t gate time-critical or business-critical actions solely on receiving one. Confirm state via the REST API before acting, or use a transport with visible failure modes — see Status callback reliability.
When status_callback is set, SignalWire sends an HTTP POST to that URL each time the outbound
message transitions to a new state. Callback delivery is independent of SWML execution: the document
continues as soon as the message is accepted, and delivery-state callbacks fire afterwards.
The callback uses the same payload as other outbound messages sent through SignalWire.
See the Message status callback
webhook page for the full field reference and the list of possible status values.
Examples
SMS
MMS
Status callbacks
Send a text-only message: