Send a Failover OTP message

post

https://connect.routee.net/failover-otp/otp/send-failover

Send an OTP with a flow of steps (e.g. ViberOtp then Sms). Each step carries its own content.
Optional callback.url receives webhooks with the same JSON shape as tracking.

Response status: Succeeded (single-step flow), InProgress (multi-step — first channel accepted, failover may follow),
or Failed (no channel accepted). HTTP 200 is returned even when status is Failed.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

RESPONSE PARAMETERS

KEY	DESCRIPTION
flowId	Flow UUID. Use for tracking (`GET /otp/failover/{flowId}`). Null when `status` is `Failed`.
status	`InProgress` (multi-step — first channel accepted), `Succeeded` (single-step), or `Failed`.
type	`Viber` or `Sms` — channel that succeeded. Null when `Failed`.
flow	Echo of request steps; the sent step includes `trackingId` (message token).
createdAt	ISO-8601 timestamp.
error	Present when `status` is `Failed`.
statusCode	When `Failed`: 0 server error, 1 insufficient balance, 2 no next step, 3 failover not triggered.

Body Params

flow

array of objects

required

length ≥ 1

flow*

type

string

enum

required

ViberOtp or Sms

Allowed:

required

E.164 recipient (Sms)

order

integer

required

≥ 1

Step order in the flow (1, 2, …). Must be unique.

ttl

integer

required

≥ 0

Time to live in seconds (message validity and failover timing)

trackingId

string | null

Set in response on the step that was sent (message token)

failoverOnDelivered

boolean

Defaults to false

ViberOtp only. When true, trigger next channel ttl seconds after Viber Delivered

label

string

Campaign or tracking label

from

string

Sms sender ID

message

object

Sms step — required with at least body

senderInfoTrackingId

string

ViberOtp — Routee Viber OTP sender tracking id

templateId

string

ViberOtp — template UUID from GET /otp/templates

templateLang

string

Defaults to en

string

ViberOtp — OTP code (4–10 characters)

templateType

string

Required for non-basic templates (e.g. with_business_name, with_validity)

businessName

string

validityTime

string

pinType

string

actionName

string

codeReason

string

callback

object

Responses

401

Invalid or expired Bearer token

403

Missing Bearer credentials

422

Request validation failed

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

RESPONSE PARAMETERS

200Send accepted (check status for outcome)