post
https://connect.routee.net/failover
RESPONSE PARAMETERS
| KEY | DESCRIPTION |
|---|---|
| trackingId | The tracking Id of the failover message. |
| type | The type of the flow channel. Supported values: Sms, Viber, Voice. |
| from | The sender id (SMS step). |
| to | The recipient number. |
| ttl | Time (in minutes) until the message expires. SMS: integer, 1–1440 (max 24 hours). Viber: decimal (1 decimal place), 0.5–1440.0 (max 24 hours). |
| expireOnDelivery | When true, delivered messages are treated as expired after TTL passes if no Seen status is received (enforced by the messaging provider). Viber only. Default: false. |
| message | Details for the failover message. |
| body | The text of the SMS message. |
| flash | Indicates if the message is a flash SMS. |
| label | The label for the message. SMS: in message. Viber: step-level, max 350 characters. |
| transcode | If true/false, the message body will/will not be transcoded. If omitted, the application-level setting is used. |
| order | The order of the step in the failover sequence. |
| failoverOnStatuses | Array of status strings that trigger the next channel. SMS: FAILED, UNDELIVERED (default: Undelivered, Failed). Viber: EXPIRED, FAILED, UNDELIVERED (default: Expired, Failed, Undelivered). Voice: Busy, NoAnswer (default). Case-insensitive. |
| dialPlans | Voice only. Combination of action verbs to execute. |
| dialPlans.verbs | Array of SAY and PLAY verbs. See possible values in the API reference. |
| senderInfoTrackingId | Viber only. The unique sender id (e.g. from Routee Platform → Applications). |
| inboundUrl | Viber only. Callback URL for inbound messages. |
| text | Viber. The text of the message. Max 1000 characters. Use [~{labelName}] for personalized content. |
| imageUrl | Viber. Image URL. Max 1000 characters; must be https. Recommended size: 400KB for optimal delivery. |
| viberFile | Viber. File attachment. |
| viberFile.fileName | File name. Max 25 characters. |
| viberFile.fileType | File type. Supported types include: doc, docx, rtf, pdf, txt, xls, xlsx, csv, odt, ods, and others (see API validation). |
| viberFile.fileUrl | File URL. Max 1000 characters; must be https. Recommended file size: 600KB for optimal delivery. |
| action | Viber. Button/action for the message. |
| action.caption | Button text. 1–30 characters. |
| action.targetUrl | Button target URL. Max 1000 characters; must be a valid URL. |
| callback | Callback (webhook) configuration. See Callbacks (Webhook). |
| callback.strategy | When the URL is called: on every status change (OnStep) or when a final status is reached (OnCompletion). |
| callback.url | URL to which the callback payload is posted. See Failover Callbacks for details. |