AppBazaar
...
Connect Applet
Dial Whom in the Connect Applet
5 min
in the 'dial whom' section of connect applet, you can configure an incoming call to a group, add static numbers or provide a url from where you can get a number to be dialed by the way of an http get request the following are the query parameters of the get request if you choose to return numbers from a url note that only some of this list may be passed to your application depending on what stage of the flow you have placed the applet query parameters parameter name description callsid unique identifier of the call callfrom in case of an outgoing call, it’ll be set to the number from which the call is made in case of an incoming call, it’ll be set to the number from which the call is received callto in case of an outgoing call, it’ll be set to the number being dialed out in case of an incoming call, it’ll be set to the number where the call landed callstatus the status of the call depends on what stage it is at possible values 'queued', 'ringing', 'in progress', 'completed', 'busy', 'failed', 'no answer', 'canceled' direction the direction of the call possible values ‘incoming’ or ‘outbound dial’ created timestamp when the call is created dialcallduration value in seconds from the time the 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 endtime 1970 01 01 05 30 00 // unix time (also known as posix time or epoch time) note that this would be a constant value and you may instead trigger our call details api a few minutes after the call has been completed to get accurate information calltype scenario value ivr only, no connect applet call attempt call conversation happened completed the client hung up during connect applet client hangup connect applet, no agent picked up incomplete went to voicemail applet voicemail dialwhomnumber displays the number of the agent who was dialed to last from in 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 case of an incoming call, it is the exophone on which the call landed in case of an outgoing call, it is the number on which the call was made to currenttime current server time (format yyyy mm dd hh\ mm\ ss) these parameters will be passed if certain conditions are met as described below parameter name description dialcallstatus this will denote what happened with the second leg of the call for subsequent requests to your connect application url (in case of multiple attempts) or if the previous applet itself was “connect” this is to provide you information about the call status of the previous attempt particularly in case your application url returns comma separated numbers (n1, n2 … ) 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 customfield 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 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 note some of these parameters like digits will only be passed in the first request of ‘dial whom’ and subsequent requests (if any) will contain the result of the previous connect applet attempt deprecated parameters the following parameters have been deprecated and are no longer supported some of these values might be passed inadvertently and applications should not rely on them anymore recordingavailableby forwardedfrom processstatus tenant id flow id numbers expected response your application url response must have only the phone number in the response body and nothing else have comma separated numbers, in case you wish to provide multiple numbers content type to be set as ‘text/plain’ with http code set as 200 for example +919900xxxxxx +919900xxxxxx,+919800xxxxxx note please provide numbers in e 164 format if the previous attempted number didn’t connect, ‘fetch numbers after every call attempt’ comes into play this option will be checked by default as shown above and your application url will be requested subsequently after an attempt for giving the flexibility of dynamically controlling the number(s) to be dialed out you can return the same set of numbers as well, and exotel will attempt each unique number once, all the returned number(s) have been attempted at least once (in case no one picks up), it’ll transition to the next applet you can also choose to uncheck this option in this case, your application url can be configured to return number(s) to be dialed in a single request and exotel will attempt all the numbers provided one by one until someone picks up or all attempts are exhausted we recommend you to use this method unless you have a use case to dynamically return numbers based on each call attempt fallback url this parameter is optional and is valid if you configure the connect applet to return numbers using your application endpoint (set under primary url) scenarios when we will request your fallback url to return numbers if your primary url responds with a non 200 http code (like 4xx, 5xx) if your primary url is not reachable and times out (doesn’t respond within 10 seconds) scenarios where fallback url will not be triggered if your application url responds with http code 200 but doesn’t return any numbers if your application url responds with http code 200 but returns invalid numbers or values
🤔
Have a question?
Our knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.