Send an outbound message to a PSTN phone number.

Properties

send_sms

objectRequired

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

stringRequired

Phone number to send SMS message to in e.164 format

send_sms.from_number

stringRequired

Phone number SMS message will be sent from

send_sms.body

stringRequired

Body of the text message

send_sms.region

stringDefaults to Chosen based on account preferences or device location

Region of the world to originate the message from

send_sms.tags

string[]

Array of tags to associate with the message to facilitate log searches

Variables

Set by the method:

• send_sms_result: (out) success | failed.

Examples

SMS

MMS

Send a text-only message:

YAMLJSON

version: 1.0.0
sections:
  main:
    - send_sms:
        from_number: "+155512312345"
        to_number: "+15555554321"
        body: "Hi, I hope you're well."