Skip to main content

send_sms

Send an outbound message to a PSTN phone number.

Parameters

NameTypeDefaultDescription
to_numberRequiredstringPhone number to send SMS message to in e.164 format
from_numberRequiredstringPhone number SMS message will be sent from
bodyRequired, unless media is includedstringBody of the message
mediaRequired, unless body is includedstring[]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

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