send_sms

Send an outbound message to a PSTN phone number.

Name	Type	Default	Description
send_smsRequired	object	-	An object that accepts the send_sms parameters.

send_sms Parameters

Name	Type	Default	Description
to_numberRequired	string		Phone number to send SMS message to in e.164 format
from_numberRequired	string		Phone number SMS message will be sent from
bodyRequired, unless media is included	string		Body of the message
mediaRequired, unless body is included	string[]		Array of media URLs to include in the message
regionOptional	string	picked based on account preferences or device location	Region of the world to originate the message from
tagsOptional	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

Send an SMS

YAML

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

JSON

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