Retrieve Conversation by TrackingId

Retrieve tracking information for conversation

RESPONSE PARAMETERS

KEY

DESCRIPTION

trackingId

The id of the conversation.

direction

The direction of the conversation (inbound or outbound)

from

The sender Id of the conversation

to

The recipient of the conversation.

to.phone

A valid phone number (mobile or landline).

to.sip

A valid SIP URI.

to.viber

A valid phone number with Viber App installed (e.g. 306971234567)

dialPlanUrl

The url that contains a combination of action verbs to be executed.

callback

Defines the notification callback information for the progress of Voice conversation.

callback.url

The URL that will be called when an update occurs.

callback.strategy

When the URL will be called. Two possible values: on every status change (OnChange) or when a final status arrives (OnCompletion).

hangupDelay

The time to wait for the call to be answered.

maxDuration

The maximum duration.

createdAt

The time the conversation was created.

recordings

Information about the related recorded files.

recordings.trackingId

The tracking Id of the recorded file.

recordings.start

The start time of the recording (ISO-8601 date-time format).

recordings.end

The end time of the recording (ISO-8601 date-time format).

recordings.from

The initiator of the DIAL.
(the recipient of the conversation)

recordings.to

The recipient of the DIAL.

recordings.url

The url to download the recorded file.

recordings.voiceTrackingIds

An array with the tracking Ids of the voice messages related to the conversation.

recordings.conversationTrackingId

The tracking Id of the voice conversation.

recordings.duration

The duration of the recording (in seconds).

machineDetection

It is used to detect if the call is answered by human or machine and define the desired actions (in case of machine).

machineDetection.strategy

The strategy to follow when a machine has been detected. Possible values: "Hangup" (terminate the call) or "Continue" (give another dialplan to execute).

machineDetection.eventUrl

The URL that Routee will POST to when a machine is detected (only for "Continue" strategy). A valid dialplan is expected as response.

Language