Exotel Support Center

Parameter Name

Description

CallSid

Unique identifier of the call

Direction

The direction of the call. Possible values: ‘incoming’ or ‘outbound-dial’

Created

Timestamp when the call is created (format: yyyy-mm-dd hh:mm:ss)

DialCallDuration

Value in seconds from the time call is triggered to the second leg of the call till it is over (including conversation time). This value can be set to zero depending on the previous applet and if there’s no second leg in the call flow.

StartTime

Timestamp when the call is started (format: yyyy-mm-dd hh:mm:ss)

DialWhomNumber

Shows the number of the agent who was dialed at last

From

In the case of an incoming call, it is the number of the caller. In the case of an outgoing call, it is the number of the first leg of the call.

To

 In the case of an incoming call, it is the ExoPhone into which the call came. In the case of an outgoing call, it is the number to which the call was made.

CurrentTime

Current server time (format: yyyy-mm-dd hh:mm:ss)

Parameter Name                

Description

DialCallStatus

This will denote what happened with the second leg of the call if the previous applet was “connect”.

Possible values: 'completed', 'busy', 'no-answer', 'failed', 'canceled'

digits

‘digits’ will be passed if there was a 'Gather' or ‘IVR’ applet before this applet and will be equal to the input digits that were entered. NOTE: This parameter comes with a double quote (") before and after the number. You'll have to trim() this parameter for double quotes (") to get the actual digits.

RecordingUrl

This will be populated if the previous applet was "voicemail". It will contain the URL of the voicemail recording. There could be a delay before the recording can be accessed depending on the length of the recording file.

Parameter

Description

fetch_after_attempt

Optional;
default = false

This parameter will indicate if, after each unsuccessful dial attempt within connect, the parameters should be fetched again including destination numbers.

• `false` will indicate a dial attempt to happen based on the initial response. No subsequent hits to the URL.

• `true` will indicate if connect parameters including a number to dial should be fetched again (hit the configured URL again) if the dial attempt is unsuccessful.

NOTE: If 2 subsequent fetch results contain exactly the same set of destination numbers, Exotel will not make any subsequent attempts even if fetch_after_attempt is set to true.

Request:
GET /<customer-url>
Apart from standard request params, it’ll include <connect> params from previous dial attempts.
Response:
<Same as above>

destination

Mandatory

Array of JSON block

• contact_uri - Phone number of the user in EE.164 format, or the SIP URIs if VOIP calling is enabled. DND checks would apply as applicable by the platform. The dial will happen in the order they appear in the array.

If any SIP URI is provided, state_management parameter value will be ignored and state management will be done by default.

If any contact_uri is already added to the Exotel dashboard as a user number, state_management parameter value will be ignored and state management will be done by default.

Ex:

"destination": [

        {

            "contact_uri": "+9198765xxxxx"

        },

        {

            "contact_uri": "sip:gauravjfb55d386"

        },

        {

            "contact_uri": "+9197864xxxxx"

        }

    ]

*The dial will happen in the order they appear in the array.

Optional;

default = false

Allows the state management to be done on the ‘destination’ numbers. Can be:

• false (default) - Numbers will not be checked for busy status before allowing calls on those numbers

• true - Numbers will be checked for busy status before allowing calls on those numbers

outgoing_phone_number

Optional;
default = Incoming ExoPhone

ExoPhone is to be used for dialing out in E.164 format.

Validations:

• The ExoPhone added should be present in your account.

• Restrictions will depend on telecom regulations i.e. another call can only be dial-ed out from the same telecom circle/region. For example, outgoing ExoPhone cannot be set to Delhi whereas Incoming ExoPhone is in Bangalore.

NOTE: If ExoPhone is not present in your account ExoPhone is unable to dial out i.e. if the above validation fails, then the call would be dial-ed out using the same ExoPhone as the first leg (where the incoming call landed).

Optional;

default = false

recording

Optional

JSON block containing the recording related attributes. Currently these are record and channels.

• record: Record the conversation of your call. Can be:

  • true - Call conversation will be recorded

  • false (default) - Call conversation will not be recorded

• channels: Number of audio channels to be present in the final recording

  • single (default)- Record both legs of the call in a single channel of the recording file

  • dual - Record the caller and the callee into separate channels of the recording file

Ex;

{

    "recording": {

        "record": true,

        "channels": "single"

    }

}

max_ringing_duration

Optional;

default = 30

Value in seconds to limit the ringing duration. This can be increased up to 60 seconds.

max_conversation_duration

Optional;

default = 900 (15 minutes)

Value in seconds to limit the conversation duration. This can be increased up to 75 minutes (4500 s).

music_on_hold

Optional;

default = default_tone

Possible Values:

• default_tone: Exotel default music on hold as present here.

• operator_tone: Audio returned by the operator on the dialing channel as is.

• custom_tone: Audio URL as provided in the response.

Sample Values:

{

“type”: “default_tone”

}

{

“type”: “operator_tone”

}

{

"type": "custom_tone",

"value": "<audio_url>"

}