Failover Statuses

Failover Service statuses

The overall status of the Failover flow depends on the statuses of the channels you use in the flow.

There are 4 statuses for the Failover service:

Queued — The flow has been accepted and is queued for processing.
InProgress — The Failover message is being sent. This is the status until one of the channels reaches a final status.
Succeeded — At least one channel in the flow reached a successful outcome (e.g. Viber Delivered or SMS Delivered).
Failed — All attempted channels failed, or the flow failed (e.g. no next step, insufficient balance, server error).

When one of the channels reaches a final status, the Failover status becomes either Succeeded or Failed.

Examples:

You send Viber first; it is not delivered, but the failover to SMS is delivered → Failover status is Succeeded.
You send Viber and SMS; the Viber message is delivered → Failover status is Succeeded.
You send Viber and SMS; both are not delivered → Failover status is Failed.

VOICE	VIBER	SMS	FAILOVER
Completed	none	none	Succeeded
Busy	Delivered	none	Succeeded
Busy	UNDELIVERED	DELIVERED	Succeeded
Busy	UNDELIVERED	UNDELIVERED	Failed
Busy	UNDELIVERED	FAILED	Failed
NoAnswer	DELIVERED	none	Succeeded
NoAnswer	UNDELIVERED	DELIVERED	Succeeded
NoAnswer	UNDELIVERED	UNDELIVERED	Failed
NoAnswer	UNDELIVERED	FAILED	Failed
Failed	DELIVERED	none	Succeeded
Failed	UNDELIVERED	DELIVERED	Succeeded
Failed	UNDELIVERED	UNDELIVERED	Failed
Failed	UNDELIVERED	FAILED	Failed
Unsent	DELIVERED	none	Succeeded
Unsent	UNDELIVERED	DELIVERED	Succeeded
Unsent	UNDELIVERED	UNDELIVERED	Failed
Unsent	UNDELIVERED	FAILED	Failed
Terminated	DELIVERED	none	Succeeded
Terminated	UNDELIVERED	DELIVERED	Succeeded
Terminated	UNDELIVERED	UNDELIVERED	Failed
Terminated	UNDELIVERED	FAILED	Failed

When the Failover status is Failed, the statusCode parameter gives more detail. It can be 0, 1, 2, or 3 (as a string in the API), depending on the reason:

statusCode	Description
0	Server error — check your authentication and request.
1	Insufficient balance — top up your account.
2	No next step — the flow had no next step configured.
3	Not failover triggered — the status that arrived was not one of the statuses that trigger the next channel.

Viber Service statuses

Viber message status	Description
QUEUED	Message is being processed.
DELIVERED	Message was successfully delivered.
SEEN	Message was seen by the recipient on their device.
UNDELIVERED	Message could not be delivered.
EXPIRED	Message expired (not delivered within the specified time).
FAILED	Message failed (e.g. not accepted by the platform).
UNSENT	Message was not sent.

SMS statuses

SMS status	Description
Queued	Message has been queued and will be sent.
Sent	Message was processed by the gateway (non-final status).
Delivered	The SMS was sent and delivered to the recipient.
Undelivered	A delivery receipt indicated the message was not delivered (e.g. carrier filtering, handset unavailable).
Failed	The SMS was not sent because the gateway could not process it.
Unsent	The message was not sent (e.g. rejected due to low balance).

Voice statuses

Voice message status	Description
Completed	The Voice message was delivered and answered.
Busy	The Voice message was delivered; the destination was busy and did not answer.
NoAnswer	The Voice message was delivered; the destination did not answer the call.
Failed	The Voice message could not be sent due to an internal error.
Unsent	The Voice message could not be initiated due to insufficient balance.
Terminated	The Voice message ended due to insufficient balance.