sms@v1

Send SMS.


Version	`sms@v1`
Runs in	`inbound-call` and your own branches · `api-initiated` and `inbound-sms` · `hangup`, `postHangup` and `events.ready`

Parameters

Name	Type	Required	Default	Description
`from`	string			Sender phone number or alphanumeric sender ID accepts `${{ }}`
`to`	array of phone number (E.164)	yes		1..10 items · accepts `${{ }}`
`body`	string	yes		Message text 1..3200 characters
`nature`	`MARKETING`, `ALERTING`		`"MARKETING"`	Message nature accepts `${{ }}`
`forceGSM`	boolean		`false`	Force GSM 7-bit encoding accepts `${{ }}`

Every parameter that accepts ${{ }} can be computed from an expression.

Examples

Short example

- action: sms@v1
  params:
    to: # array of targets
      - ${{ call.fromNumber }}
    body: Thank you for calling us!

You can also personalize the sender

Make sure you request the sender name in your account https://app.callr.com/account/limits (SMS SENDERS)

- action: sms@v1
  params:
    from: MyCompany
    to:
      - ${{ call.fromNumber }}
      - "+33639984242"
    body: Thank you for calling us!

Full example with defaults

- action: sms@v1
  params:
    # from: MyCompany # optional: sender ID (2..11 characters) or phone number
    to: # 1..10 phone numbers (required)
      - ${{ call.fromNumber }}
    body: Thank you for calling us! # 1..3200 characters (required)
    nature: MARKETING # MARKETING|ALERTING
    forceGSM: false # force GSM 7-bit encoding

Result

Set result: $myVariable to keep it. SIDs of the SMS sent, one per target (an invalid target, or one that failed, is skipped), or false when no target is valid, the other parameters are invalid or the account is not allowed to send SMS

Type: array of string or false

[
  "73DCC544"
]