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. Must not be empty, including after variable expansion.
send_sms.from_number
Phone number SMS message will be sent from. Must not be empty, including after variable expansion.
send_sms.body
Body of the text message. Must not be empty, including after variable expansion.
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.successmeans the message was accepted for sending (the submission returned an HTTP 2xx status); delivery can still fail later, so use status callbacks to track it.failedcovers execution errors, such as a missing body or phone number after variable expansion, and any other HTTP status. A document that fails validation stops before this method runs, so the method sets neither variable. - send_sms_response_code: (out) The HTTP status code returned when the message was submitted, stored as a string (for example,
"200"). It’s"0"when no HTTP status was received. It’s only updated when the message is submitted, so after an execution error that happens before submission it may still hold a value from an earliersend_sms. It isn’t a message ID, a delivery status, or a carrier error code.
Status callbacks
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: