Track multiple failover messsages with filters for a specific time range

RESPONSE PARAMETERS

KEY

DESCRIPTION

trackingId

the tracking Id of the Failover message

applicationName

The name of the application that was used to send this message.

campaign

The name of the campaign that this message was sent from.

country

The country of the recipient in ISO 3166-1 alpha 2 format.

smsId

The unique id of one SMS part included in the message. If the message is multipart then these values will be different for each part.

messageId

The id of the message (trackingId). All the parts of a multipart SMS have the same messageId.

groups

The groups that the recipient belongs to.

body

The message of the SMS.

operator

The operator of the recipient.

originatingService

The service that sent this message.

to

The recipient.

latency

The overall delivery latency of the message.

parts

The number of actual SMS parts.

part

The number of the current SMS part.

price

The cost of this SMS part.

label

The label of the SMS tracking.

status

Information about the Sms status.

status.date

The date that the status was reported.

status.status

The status of the SMS tracking. Check here for possible values.

status.reason

The reason of the status

status.reason.detailedStatus

The detailed status.
Possible values: Sent, Delivered, Undelivered, Failed, Undelivered on Handset, Unknown Number, Roaming, Call Barred, Unknown Status, Carrier Violation.
Check here for details.

status.reason.description

The description of the detailed status

from

The sender Id of the message

direction

The direction of the message. Possible values: "Inbound", "Outbound"

type

The type of the flow channel. Supported values: Sms or Viber

body.text

The text of the viber message.

body.action.caption

The displayed text on the button.

body.action.targetUrl

The action which should be executed, when the recipient clicks on the button.

status.name

The status of the SMS tracking. Check here for possible values.

status.reason.detailedStatus

The detailed status.
Possible values: Sent, Delivered, Undelivered, Failed, Undelivered on Handset, Unknown Number, Roaming, Call Barred, Unknown Status, Carrier Violation.
Check here for details.

status.reason.description

The description of the detailed status

order

The priority order of the channels used in the communication flow

ttl

Time range until message expires.

expireOnDelivery

If it's set to true then the service will set the status of the Delivered messages to Expired if the TTL value has passed and no Seen status has arrived. (Default value is false)

expiredOnDeliveryAt

The time of the seconds that the ttl will expire after the Delivered status.

failoverOnStatuses

Defines the status which will trigger the next channel.

terminationChannel

The selected channel to terminate the communication flow

totalPrice

The total price

originatingService

The name of the service used

applicationId

The application id used for the communication flow

Language