You can choose to configure the Connect applet parameters using the flow builder itself or control it dynamically through a URL. However, you'll need to configure the transitions (next applet) while building the flow irrespective.
If you choose to configure the parameters dynamically using your application URL, you can set a ‘Primary URL’ for handling the requests. You can also set a ‘Fallback URL’ (optional) which will be contacted in case something goes wrong with your ‘Primary URL’.
If an application URL is set for Connect applet, Exotel will makes a GET request to the URL with the call details as URL-encoded HTTP query parameters.
The following are the parameters of the GET request. Note that only some of this list may be passed to your application - depending on what stage of the flow you have placed the Connect applet.
This value will indicate the version of connect applet parameters against which your endpoint’s response will be validated.
Current Version: 1.0
Unique identifier of the call
In case of outgoing call, it’ll be set to the number from which the call is made. In case of incoming call, it’ll be set to the number from which the call is received
In case of outgoing call, it’ll be set to the number being dialed out. In case of incoming call, it’ll be set to the number where the call landed.
Direction of the call. Possible values: ‘incoming’ or ‘outbound-dial’
Timestamp when the call is created (format : yyyy-mm-dd hh:mm:ss)
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 previous applet and if there’s no second leg in the call flow.
Timestamp when the call is started (format : yyyy-mm-dd hh:mm:ss)
1970-01-01 05:30:00 // Unix time (also known as POSIX time or epoch time)
Shows the number of the agent who was dialed to last
Flow id associated with the call
In case of incoming call, it is the number of the caller. In case of outgoing call, it is the number of first leg of the call.
In case of incoming call it is the ExoPhone into which the call came. In case of outgoing call, it is the number into which the call was made to.
Current server time (format : yyyy-mm-dd hh:mm:ss)
*These parameters will be passed if certain conditions are met as described below:
This will denote what happened with the second leg of the call if previous applet was “connect”.
‘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.
If the call was initiated via API, the value that was passed in CustomField in the API call will be set here.
|RecordingUrl||This will be populated if previous applet was "voicemail". It will contain the URL of the voicemail recording. There could be delay before the recording can be accessed depending on the length of the recording file.|
This is the response Exotel will expect to the GET request from your Connect Application URL. The response will decide what parameters will be set while executing Connect during the call flow.
"value":"This text would be spoken out to the callee"
This parameter will indicate if after each unsuccessful dial attempt within connect, the parameters should be fetched again including destination numbers.
Indicates the destination(s) to dial out.
“numbers”: [“+622131921111”, “+622131921112”]
ExoPhone to be used for dialing out in E.164 format.
NOTE: If ExoPhone is not present in your acor ExoPhone is unable to dial out i.e. if above validation fails, then the call would be dial-ed out using the same ExoPhone as the first leg (where the incoming call landed).
true/false; Record the call or not
default = single
To record the caller and callee in separate channels in the recording file.
Value in seconds to limit the ringing duration to. This can be increased up to 60 seconds.
Value in seconds to limit the conversation duration to. This can be increased up to 75 minutes (4500 s).
Use this option to dial the numbers in-parallel (simultaneously). This will dial all the numbers returned under the destination parameter.
|dial_passthru_event_url||Optional;||The URL passed here will be requested for dial start and dial end events. For more details on request, refer to this.|
Play a recording to the number that is being called
“value”: “hello, this is a sample text”
Configuration for audio file supported in this playback are:
Sample Rate = 8 kHz
Bit depth = 16 bit
Bit rate = 128 kbps
Channel = mono
File Format = wav
*Above set of parameters can also be controlled through the dashboard if one opts to configure the Connect applet using the flow builder instead of Application URL.
Cases where Fallback URL will be triggered are:
Primary URL does not return HTTP 200 OK
Primary URL doesn’t return within timeout period (5 seconds)
Primary URL returns invalid response:
Content-Type should be application/json
Mandatory parameters are present
audio_url / text should be http/https and returns 200 HTTP code
Transition to next applet
Below transitions are to be set in the call flow builder to decide what to execute next.
After the call conversation ends: The applet set here will be triggered if a conversation occurs.
If nobody answers: The applet set here will be triggered if we dial the number and conversation doesn’t occur. If no applet is present in "we didn't dial anyone", it will fallback to this.
We didn’t dial anyone: The applet set here will be triggered if we don’t dial. Cases when this can occur:
If both Primary and Fallback URL endpoint times out or returns non-2xx response code.
If both Primary and Fallback URL endpoint doesn’t return a valid payload.
If number to dial returned is in invalid format.
If empty number (destination) is returned in the response
Authored-By: Sarthak Singhal, Product Manager, Exotel