Exotel Support Center

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, 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 the previous dial attempts.

Response:
<Same as above>

destination

Mandatory

Indicates the destination(s) to dial out.

Sample:

“destination”: { 

  “numbers”: [“+622131921111”, “+622131921112”]

}

outgoing_phone_number

Optional;
default = Incoming ExoPhone

ExoPhone 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 where Incoming ExoPhone is in Bangalore.

• Both the first leg and the second leg ExoPhones can be connected on the same server.

NOTE: If ExoPhone is not present in your account or the 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).

NOTE: Consult with exotel support to use this feature.

record

Optional; 
default = false

true/false; Record the call or not

recording_channels

Optional;

default = single

To record the caller and callee in separate channels in the recording file.

Possible values:

• single

• dual

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 to. 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>"

}

Use this option to dial the numbers in parallel (simultaneously). This will dial all the numbers returned under the destination parameter.

"parallel_ringing": {

       "activate": true,

       "max_parallel_attempts": 5

}

max_parallel_attempts value can be between 1-10. Default: 5

*Please note this feature is chargeable and consult with your Account Manager or email to [email protected] before using this parameter.

Play a recording to the number that is being called

{

“playback_to”: “both”,

“type”: “audio_url”,

“value”: “http://...mp3”

}

OR

{

“playback_to”: “both”,

“type”: “text”,

“value”: “hello, this is a sample text”

}

OR

{

“playback_to”: “callee”,

“type”: “audio_url”,

“value”: “http://...mp3”

}

OR

{

“playback_to”: “callee”,

“type”: “text”,

“value”: “hello, this is a sample text”

}

Sample Rate = 8 kHz

Bit depth = 16 bit

Bit rate = 128 kbps

Channel = mono

File Format = wav

Note: If the file name returned in case of `audio_url` is the same, it will be cached by our servers. Kindly, provide dynamic file names if the audio to be played is different each time.