get
https://connect.routee.net/failover/tracking/
Retrieve tracking information for Failover messages
RESPONSE PARAMETERS
| 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 can be expired after delivery when TTL has 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). |