Send a Failover Message

RESPONSE PARAMETERS

KEY

DESCRIPTION

trackingId

The tracking Id of the failover message

type

The type of the flow channel. Supported values: Sms, Viber or Voice

from

The name of the sender id.

to

The recipient number.

ttl

Time range until message expires.

expireOnDelivery

If it's set to true then the service will set the status of the Delivered messages to Expired if the TTL value has passed and no Seen status has arrived. (Default value is false)

message

Details for the Failover message

body

The text of the message

flash

Indicates if the message is flash SMS.

label

The label that was given to the message.

transcode

If “transcode” is set to true/false, then the message body will be/not be transcoded.If the “transcode” parameter is not set, then the application level setting will be used

order

The order of the specific channel in the Failover sequence

failoverOnStatuses

Defines the status which will trigger the next channel. Values for SMS channel can be: Undelivered, Failed Values for Viber channel can be: Expired, Failed, Undelivered. Values must be comma separated. The statuses are not case-sensitive Default values for SMS: Undelivered, Failed Default values for Viber: Expired, Failed, Undelivered The statuses are not case-sensitive

dialPlans

A combination of action verbs to be executed.

dialPlans.verbs

The array of SAY and PLAY verbs. Check here for possible values.

senderInfoTrackingId

The unique sender id. You can find it at: Routee Platform-applications page.

inboundUrl

The defined callback URL that will receive the inbound messages. Check here for details.

text

The text of Viber message. The maximum number of characters supported in a Viber message is 1000 characters. Use [~{labelName}] in order to send personalized messages, by using the labels of your contacts. [Text only messages are billed as Transactional. All the other message types are charged as Promotional]

imageUrl

The URL of the image. (recommended image size: 400KB for optimal delivery; image url length: max 1000 characters; only valid and secure URL starting with https:/)

viberFile

Represents the file of the viber message.

viberFile.fileName

File name of the viber message.

viberFile.fileType

File type of the viber message.

viberFile.fileUrl

The Url of the of the viber message file. (recommended file size: 600KB for optimal delivery)

action

Details for the button used in the Viber message

caption

The displayed text on the button (1-30 characters).

targetUrl

The target URL of the Viber action.

callback

Details for the callback functionality, more information at Callbacks (Webhook) ]

strategy

When the URL will be called. Two possible values: on every status change (OnStep) or when a final status arrives (OnCompletion).

url

Defines the URL in which a payload with the information about the request will be posted. Check (here) [docs/failover-callbacks] for details

Language