Search failover trackings

RESPONSE PARAMETERS

Paginated list. Top-level keys describe the page; content is an array of tracking objects with the same structure as the GET tracking response.

Pagination (root level)

KEY	DESCRIPTION
content	Array of tracking objects (see below).
totalPages	Total number of pages.
totalElements	Total number of trackings.
number	Current page index (0-based).
size	Page size.
numberOfElements	Number of items in this page.
first	True if this is the first page.
last	True if this is the last page.

Each tracking in content has the same shape as the GET tracking response (trackingId, messages, terminationChannel, status, totalPrice, etc.). Response parameters for those objects:

Response parameters (each item in `content`)

KEY	DESCRIPTION
Root level
trackingId	The tracking Id of the failover flow.
messages	Array of message objects (one per step: Sms, Viber, or Voice).
terminationChannel	The channel that ended the flow. Values: Sms, Viber, Voice.
status	Overall flow status. Values: Queued, InProgress, Succeeded, Failed.
totalPrice	Total cost of the flow.
originatingService	Name of the service that sent the flow (e.g. failover).
applicationId	Application id used for the flow.
createdAt	When the flow was created (ISO 8601).
updatedAt	When the flow was last updated (ISO 8601).
Per message (all types)
type	Channel type. Values: Sms, Viber, Voice.
order	Order of this step in the failover sequence.
failoverOnStatuses	Array of statuses that would trigger the next channel.
createdAt	When this message was created (ISO 8601).
SMS message
messageId	Id of the SMS message (same for all parts of a multipart SMS).
smsId	Id of this SMS part (differs per part in multipart).
from	Sender id.
to	Recipient number.
body	SMS text.
country	Recipient country (ISO 3166-1 alpha-2).
operator	Recipient operator.
status	SMS delivery status.
status.name	Status name. See SMS status values in the API reference.
status.reason	Reason details.
status.reason.detailedStatus	Detailed status (e.g. Sent, Delivered, Undelivered, Failed, Undelivered on Handset, Unknown Number, Roaming, Call Barred, Carrier Violation).
status.reason.description	Human-readable description.
status.updatedDate	When this status was reported (ISO 8601).
part	Current part number (multipart SMS).
parts	Total number of parts (multipart SMS).
latency	Delivery latency (ms).
price	Cost of this SMS (or part).
label	Label of the SMS.
ttl	TTL in minutes (1–1440).
Viber message
trackingId	Tracking id of this Viber message.
from	Sender name.
to	Recipient number.
body	Viber message content.
body.text	Text of the message.
body.imageUrl	Image URL (if present).
body.action	Button/action (if present).
body.action.caption	Button label.
body.action.targetUrl	Button URL.
body.viberFile	File attachment (if present).
body.viberVideo	Video attachment (if present).
status	Viber delivery status.
status.name	Status name (e.g. QUEUED, DELIVERED, SEEN, EXPIRED, FAILED, UNDELIVERED).
status.reason	Reason details.
status.reason.detailedStatus	Detailed status.
status.reason.description	Human-readable description.
status.updatedDate	When this status was reported (ISO 8601).
country	Recipient country (ISO 3166-1 alpha-2).
price	Cost of this Viber message.
inboundUrl	Callback URL for inbound messages (if set).
label	Label of the Viber message.
ttl	TTL in minutes (0.5–1440).
expireOnDelivery	If true, the message could be expired after delivery when TTL had passed and no Seen status was received. Default: false.
expiredOnDeliveryAt	When the message was expired after delivery (ISO 8601). Present only when expireOnDelivery was true and the message expired.
Voice message
messageId	Id of the voice message.
from	Caller.
to	Destination.
country	Destination country.
status	Voice call status.
duration	Call duration.
price	Cost of the call.
answeredBy	Who answered (e.g. human, machine).

Example request

curl -X POST \
  'https://connect.routee.net/failover/tracking?dateStart=2025-05-05T15:00Z&dateEnd=2025-07-25T19:00Z&page=0&size=20' \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "fieldName": "to",
      "searchOperator": "is",
      "searchTerm": "+3069xxxxxxxx"
    },
    {
      "fieldName": "type",
      "searchOperator": "is_not",
      "searchTerm": "Voice"
    }
  ]'

Response parameters (each item in content)

Example request

Response parameters (each item in `content`)