Sms

The Sms command can be used to send an SMS message to a phone number during a phone call.

🚧

International SMS is disabled by default.

Nesting Rules

No actions can be nested within Sms and Sms cannot be nested in any other actions.

Example

[
   {
      "Sms" : {
          "to" : "+18475722071",
          "from" : "+17113334444",
          "text" : "Hello from FreeClimb!",
          "notificationUrl" : "http://myapp.com/message-status-notification"
      }
   }
]

Notes

Outbound SMS messages from the customer must be originated by a valid FreeClimb phone number. This must be a purchased incoming phone number assigned to the account that is originating the SMS message.


Command Attributes

Sms supports the following attributes that modify its behavior:

Attribute

Description

to

E.164 representation of the phone number to which the message will be sent.

from

E.164 representation of the phone number to use as the sender.

text

Text contained in the message.

notificationUrl

When the message changes status, this URL will be invoked using HTTP POST with the messageStatus parameters.


to

REQUIRED

Type: E.164 phone number
Default: null

E.164 representation of the phone number to which the message will be sent. Must be within FreeClimb's service area and E.164 formatting (e.g., +18003608245). For trial accounts, this number must be verified.


from

REQUIRED

Type: E.164 phone number
Default: null

E.164 representation of the phone number to use as the sender. This must be an Incoming number you have purchased from FreeClimb.


text

REQUIRED

Type: string
Default: null

Text contained in the message.


notificationUrl

OPTIONAL

Type: absolute URL
Default: null

When the message changes status, this URL will be invoked using HTTP POST with the messageStatus parameters.

🚧

This is a notification only; any PerCL returned will be ignored.