Track multiple voice messages with filters for a specific time range

post

https://connect.routee.net/voice/tracking

Limit the tracking result of multiple voice messages by passing filters

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

RESPONSE PARAMETERS

KEY	DESCRIPTION
content	Contains the search results.
content.messageId	The id of the voice message.
content.conversationTrackingId	The tracking id of the conversation that this message belongs to.
content.to	The recipient.
content.from	The sender Id of the call.
content.groups	The groups that the recipient belongs to.
content.country	The country of the recipient in ISO 3166-1 alpha 2 format.
content.status	The voice message's status.
content.status.date	The date that the status was updated.
content.status.status	The status of the voice message. Check here for possible values.
content.campaign	The name of the campaign that this message belongs to.
content.applicationName	The name of the application that was used to send this message.
content.originatingService	The service that sent this message.
content.direction	The direction of this call.
content.duration	The duration of this call.
content.fileURL	The URL of the .wav file.
content.message	The text message that converted to voice.
content.message.gender	The gender of the voice message (male or female).
content.message.language	The language of the voice message.
content.message.text	The text of the voice message.
content.price	The price of the voice message.
content.chargeInterval	The time interval used for charging this voice message (in seconds).
content.collectedTones	The collected DTMF tones during the call.
content.recordings	Information about the related recorded files.
content.recordings.trackingId	The tracking Id of the recorded file.
content.recordings.start	The start time of the recording (ISO-8601 date-time format).
content.recordings.end	The end time of the recording (ISO-8601 date-time format).
content.recordings.from	The initiator of the call.
content.recordings.to	The recipient of the call.
content.recordings.url	The url to download the recorded file.
content.recordings.voiceTrackingIds	An array with the tracking Ids of the voice messages related to the conversation.
content.recordings.conversationTrackingId	The tracking Id of the voice conversation.
content.recordings.duration	The duration of the recording (in seconds).
content.answeredBy	Indicates if the call is answered by human or machine. Possible values: "HUMAN", "MACHINE", "UNKNOWN".
totalPages	The number of total pages.
last	Whether the current page is the last one.
totalElements	The total amount of elements for the current search.
first	Whether the current page is the first one.
numberOfElements	The number of elements currently on this page.
number	The requested page number.
size	The requested page size.

Query Params

from

string

ISO-8601 date-time format

string

ISO-8601 date-time format

page

int32

Defaults to 0

The page number to retrieve, default value is 0 (meaning the first page)

size

int32

Defaults to 20

The number of items to retrieve, default value is 20.

sort

string

The field name that will be used to sort the results.

trackingId

string

If provided then only the voice messages of the campaign with this tracking Id will be retrieved.

tagged

boolean

Body Params

fieldName

string

required

Defines the name of the field for this filter. ACCEPTED VALUES: id, recipient, from, collectedTones, groups, country, status.status, campaign

searchOperator

string

Defaults to "is"

Defines the search operator to be used for the search. Examples: is, is_not, contains, starts_with, ends_with

searchTerm

string

required

Defines the value of the specified field.

Headers

Content-Type

string

required

Defaults to application/json

application/json

Authorization

string

required

Defaults to Bearer {access_token}

Bearer {access_token}

Responses

Language

Loading…

Response

Choose an example:

application/json

200200

400400