Same lifecycle as POST /failover, but Viber steps are template-only (BM transactional compliance).
Allowed step types: Sms, Viber (template), Voice. Free-form Viber message body and client
label are rejected with 400. Template fields on POST /failover are also rejected with 400.
Response includes flowKind: transactional and echoes template fields (including seq) on Viber steps.
JSON body: only flow (required) and optional callback. accountId and applicationId are not in the body;
they are set from integration headers.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
RESPONSE PARAMETERS
| KEY | DESCRIPTION |
|---|---|
| trackingId | The tracking Id of the failover message. |
| flowKind | Always transactional for flows created with this endpoint. See Failover Callbacks. |
| type | The type of the flow channel. Supported values: Sms, Viber, Voice. |
| from | The sender id (SMS or Voice step). |
| to | The recipient number (SMS/Viber) or destination (Voice). |
| ttl | Time (in minutes) until the message expires. SMS: integer, 1–1440 (default 1200). Viber: decimal (max one decimal place), 0.5–1440.0 (default 10). Voice steps do not use ttl. |
| 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. |
| message | SMS only. Details for the SMS message (body, flash, label, transcode, urlShortener). |
| body | The text of the SMS message. |
| flash | Indicates if the message is a flash SMS. |
| label | The label for the SMS message (max 350 characters). Not accepted on Viber steps for this endpoint. |
| transcode | If true/false, the SMS body will/will not be transcoded. If omitted, the application-level setting is used. |
| 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). |
| templateId | Viber only — transactional. Approved Rakuten BM template UUID (echoed from request). |
| templateLang | Viber only — transactional. Template language code (e.g. en). |
| templateParams | Viber only — transactional. Placeholder values object (echoed from request). OTP templates require pin. |
| deliveryScope | Viber only — transactional. PRIMARY_DEVICE or ALL_DEVICES. |
| seq | Viber only — transactional. Sequence number; always present in create response (client value or generated). |
| inboundUrl | Viber only. Callback URL for inbound messages. |
| 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. |
| createdAt | When the flow was created (ISO 8601). |
Transactional Viber steps do not use promotional fields such as message.text, imageUrl, action, or viberFile. Use templateId, templateLang, and templateParams instead. Sending free-form Viber content on this endpoint returns 400.
Validation error or business rule failure (e.g. template on wrong endpoint, insufficient balance).
Forbidden — missing role or scope.
Unknown sender info or related resource not found.