Failover endpoints — which API to use

Routee provides three send APIs for multi-channel Failover. They share the same idea — ordered steps, failover when a channel does not succeed — but differ in what you can put on Viber steps, which channels are supported, and how you track results.

Use this page to pick the right endpoint before you integrate.

---

Quick decision guide

July 1, 2026: Template-based transactional Viber in Failover must use POST /failover/transactional, not the standard endpoint.

---

All send endpoints at a glance

API reference: Standard · Transactional · OTP

How-to guides: Standard · Transactional

---

Side-by-side comparison

---

Standard Failover

Endpoint: POST https://connect.routee.net/failover

Choose this when you send promotional or session Viber content — text, images, action buttons, files, or video — and want Sms and/or Voice as backup channels.

Typical scenarios

• Abandoned-cart reminder: Viber rich message → SMS if undelivered
• Promotional offer with image and CTA → Voice call as last step
• Session-style Viber chat notifications with free-form body

Viber rules

• Use the message object (text, imageUrl, action, etc.)
• Do not send BM transactional template fields — they are rejected (400)

Not for: OTP codes (use Failover OTP) or BM transactional templates (use Transactional Failover).

---

Transactional Failover

Endpoint: POST https://connect.routee.net/failover/transactional

Choose this when Viber steps must use approved Rakuten BM transactional templates (compliance), and you may still fall back to Sms or Voice.

Typical scenarios

• Order shipped / delivered notification with approved template → SMS backup
• Appointment reminder (template) → Voice if Viber expires
• Account alert that must not use promotional Viber formatting

Viber rules

• Required: templateId, templateLang, senderInfoTrackingId
• Optional: templateParams, deliveryScope, seq
• Free-form Viber message and client label are rejected (400)

Prerequisite: Rakuten Viber transactional templates

Not for: OTP with Viber OTP templates (use Failover OTP) or promotional rich media (use Standard Failover).

---

Failover OTP

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

Choose this when the payload is a verification code delivered via Viber OTP templates and/or SMS — not general notifications or promotional Viber.

Typical scenarios

• Login / 2FA: ViberOtp first → SMS if Expired / Failed / Undelivered
• Password reset with dedicated OTP templates
• Payment confirmation code with optional SMS fallback

Flow step types

• ViberOtp — senderInfoTrackingId, templateId, pin, optional templateType and related fields
• Sms — message.body (and optional from)

Differences from Standard / Transactional

• Separate service and base URL (/failover-otp)
• No Voice steps
• Tracking uses flowId and /failover-otp/otp/failover/… (not /failover/tracking)
• Template list: GET /failover-otp/otp/templates

Not for: Marketing messages, BM transactional notifications, or Voice failover.

---

Standard vs Transactional (same Failover service)

Both use https://connect.routee.net, the same tracking URLs, and the same callback model. Only Viber step shape differs:

Sending the wrong shape to the wrong endpoint always returns 400 — the APIs are intentionally strict so compliant traffic uses the right path.

---

Scenario examples

---

Tracking & callbacks (summary)

Full endpoint list: Resource Overview

---

Related documentation