send_sms

Send an outbound message to a PSTN phone number.

send_sms

objectrequired

An object that accepts the send_sms parameters.

send_sms Parameters

SMS

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

string

Default: 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

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.media

string[]required

Array of media URLs to include in the message

send_sms.body

string

Optional text to accompany the media

send_sms.region

string

Default: 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

Send a text-only message:

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."
        }
      }
    ]
  }
}

MMS

Send a message with media attachment:

YAML

version: 1.0.0
sections:
  main:
    - send_sms:
        from_number: "+155512312345"
        to_number: "+15555554321"
        media: ["https://example.com/image.jpg"]
        body: "Check out this image!"

JSON

{
  "version": "1.0.0",
  "sections": {
    "main": [
      {
        "send_sms": {
          "from_number": "+155512312345",
          "to_number": "+15555554321",
          "media": [
            "https://example.com/image.jpg"
          ],
          "body": "Check out this image!"
        }
      }
    ]
  }
}