Perform a voice 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.
(ex [email protected]:55080)

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.

dialPlans

A combination of action verbs to be executed.

dialPlans.verbs

The array of SAY, PLAY, DIAL and COLLECT verbs. Check here for possible values.

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.
The default value is to wait for the network to terminate the call.

createdAt

The time the conversation was created.

maxDuration

The maximum duration.

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