Search failover trackings

Track multiple failover messages with filters for a specific time range.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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)

KEYDESCRIPTION
contentArray of tracking objects (see below).
totalPagesTotal number of pages.
totalElementsTotal number of trackings.
numberCurrent page index (0-based).
sizePage size.
numberOfElementsNumber of items in this page.
firstTrue if this is the first page.
lastTrue 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)

KEYDESCRIPTION
Root level
trackingIdThe tracking Id of the failover flow.
messagesArray of message objects (one per step: Sms, Viber, or Voice).
terminationChannelThe channel that ended the flow. Values: Sms, Viber, Voice.
statusOverall flow status. Values: Queued, InProgress, Succeeded, Failed.
totalPriceTotal cost of the flow.
originatingServiceName of the service that sent the flow (e.g. failover).
applicationIdApplication id used for the flow.
createdAtWhen the flow was created (ISO 8601).
updatedAtWhen the flow was last updated (ISO 8601).
Per message (all types)
typeChannel type. Values: Sms, Viber, Voice.
orderOrder of this step in the failover sequence.
failoverOnStatusesArray of statuses that would trigger the next channel.
createdAtWhen this message was created (ISO 8601).
SMS message
messageIdId of the SMS message (same for all parts of a multipart SMS).
smsIdId of this SMS part (differs per part in multipart).
fromSender id.
toRecipient number.
bodySMS text.
countryRecipient country (ISO 3166-1 alpha-2).
operatorRecipient operator.
statusSMS delivery status.
status.nameStatus name. See SMS status values in the API reference.
status.reasonReason details.
status.reason.detailedStatusDetailed status (e.g. Sent, Delivered, Undelivered, Failed, Undelivered on Handset, Unknown Number, Roaming, Call Barred, Carrier Violation).
status.reason.descriptionHuman-readable description.
status.updatedDateWhen this status was reported (ISO 8601).
partCurrent part number (multipart SMS).
partsTotal number of parts (multipart SMS).
latencyDelivery latency (ms).
priceCost of this SMS (or part).
labelLabel of the SMS.
ttlTTL in minutes (1–1440).
Viber message
trackingIdTracking id of this Viber message.
fromSender name.
toRecipient number.
bodyViber message content.
body.textText of the message.
body.imageUrlImage URL (if present).
body.actionButton/action (if present).
body.action.captionButton label.
body.action.targetUrlButton URL.
body.viberFileFile attachment (if present).
body.viberVideoVideo attachment (if present).
statusViber delivery status.
status.nameStatus name (e.g. QUEUED, DELIVERED, SEEN, EXPIRED, FAILED, UNDELIVERED).
status.reasonReason details.
status.reason.detailedStatusDetailed status.
status.reason.descriptionHuman-readable description.
status.updatedDateWhen this status was reported (ISO 8601).
countryRecipient country (ISO 3166-1 alpha-2).
priceCost of this Viber message.
inboundUrlCallback URL for inbound messages (if set).
labelLabel of the Viber message.
ttlTTL in minutes (0.5–1440).
expireOnDeliveryIf true, the message could be expired after delivery when TTL had passed and no Seen status was received. Default: false.
expiredOnDeliveryAtWhen the message was expired after delivery (ISO 8601). Present only when expireOnDelivery was true and the message expired.
Voice message
messageIdId of the voice message.
fromCaller.
toDestination.
countryDestination country.
statusVoice call status.
durationCall duration.
priceCost of the call.
answeredByWho 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"
    }
  ]'
Query Params
string

Start of the time range (e.g. 2025-05-05T15:00Z).

string

End of the time range (e.g. 2025-07-25T19:00Z)

int32
Defaults to 10

Page size. Default: 10. Must be ≥ 1.

int32
Defaults to 0

Page index (0-based). Default: 0.

Body Params
string
required

Field to filter on. Values: type, to, status, terminationChannel

string

Operator. Default: is. Values: is, is_not; for to also contains, starts_with, ends_with. Case-insensitive.

string
required

Value to compare. For type / terminationChannel: Sms, Viber, Voice. For status: Queued, Succeeded, Failed, InProgress. For to: any string.

Headers
string
Defaults to Bearer {access_token}
string
Defaults to application/json
Responses

Language
LoadingLoading…
Response
Choose an example:
application/json