UTC connector

note this connector only supports domestic calling if you want to enable international calling, please reach out to your account manager this exotel connector enables a leadsquared agent to have incoming call intimation, visualize the call details and provide click2call capabilities on the crm portal a seamless integration for enhanced agent productivity and better experience, also allows users to configure multiple telephony accounts on a single connector use cases integrate multiple instances/accounts of exotel ( eg if multiple contact centres in different regions you can now configure each of them as separate tabs) integrate multiple telephony providers – if customers are using more than one telephony service provider, they can now integrate all of them into one place integration features click to call place outbound calls to customers from leadsquared directly call pop up all calls take place in a call pop up that has all information related to the call call log api to pass leadsquared utc call log api url call timer api this api is exposed to configure time based usage for click to call this will enable users to make calls only during preset timings prerequisites in order to have a successful integration with the leadsquared account, you must complete the following tasks sign up for an exotel account verify your account through phone or email get your account kyc verified purchase exophone(vn) to be used by leadsquared users/agents for outbound calls lead must be created in leadsquared crm installation/ configuration leadsquared portal navigate to apps>apps marketplace on the leadsquared portal, search for the universal telephony connector and click install add/ modify connector click configure hover the cursor over the settings click the add new connector button enter a name for the new connector, then click add virtual number copy the vn purchased from the exotel portal, add the same in the virtual number field ( prefix with country code followed by eg +91 ) connector config / call timer this api is exposed to configure the connector and schedule time based usage for click to call which will enable users to make calls only during preset timings this api is responsible for configuring the time limit of each call made by leadsquared call timer = true / false by default, it will be set to false if set to true, then only honour the following three parameters (else, ignore) call start timer time in format hh\ mm\ ss allow calling from this time on a day default value = 00 00 00 call end timer time in format hh\ mm\ ss stop calling from this time of the day default value = 23 59 59 call allowed days array of strings to take input as \[monday, tuesday, wednesday, thursday, friday, saturday, sunday] by default allow all 7 days this can be configured via the leadsquared app available on https //my exotel com/{ accsid} /apps#available apps note api key token base 64 value will be fetched only on clicking 'update' the same value needs to be copied onto leadsquared connector click2call settings call route url to be copied from leadsquared connector >> lead route v2 and configured under call route url on exotel >> app bazaar >> leadsquared connector(utc) kindly configure the leadroutev2 url do not use call route api which is depreciated only configure the url without query parameters (?caller id=\<phonenumber of caller/lead>\&agentinfo=\<pass true to retrieve entire agent information>) as mentioned eg call route url for the above screenshot would be https //telephony in21 leadsquared com/1/api/telephony/leadroutev2/247ce167766855cc81588d6c7bf92cd526/2ef86c44 06b8 41eb a4e9 759ccc459e0a agent popup url to be copied from leadsquared utc connector >> agent pop up api and configured under pop up url on exotel >> app bazaar >> leadsquared connector(utc) click on the ‘enable’ checkbox and save, the remaining options as pre configured on lsq portal enable the "show phone call popup" checkbox in leadsquared user profile settings(https //in21 leadsquared com/settings/myprofile) call log url to be copied from leadsquared utc connector >> call log api and configured under call log url on exotel >> app bazaar >> leadsquared connector(utc) click 2 call url for sgp stamp (domestic) https //api cocreate exotel com/v1/leadsquared/outbound/call/connect?agentnumber=@agentnumber\&customernumber=@customernumber\&virtualnumber=@virtualnumber url for all mumbai stamp accounts and international sgp accounts = https //api lsq cocreate exotel com/v1/leadsquared/outbound/call/connect?agentnumber=@agentnumber\&customernumber=@customernumber\&virtualnumber=@virtualnumber custom headers base64 value of exotel api token/ key + accsid (exotel acc id) (available on the leadsquared app on exotel appbazaar) http method get post coc config( optional ) this endpoint is responsible for enabling the leadsquared integration( already invoked by the connector app, no need to call separately) url for singapore stamp (domestic) https //api cocreate exotel com/v1/coc auth/{accsid}/config url for all mumbai stamp accounts and international sgp accounts = https //api lsq cocreate exotel com/v1/ coc auth/{accsid}/config sample http request curl location request post https //api cocreate exotel com/v1/coc auth/{accsid}/config (for singapore stamp domestic accounts) https //api lsq cocreate exotel com/v1/coc auth/{accsid}/config (for mumbai stamp and international accounts) request header contenttype application/json api key exotel api key api token exotel api token body parameters field mandatory default description calllogapiurl yes nil string; lsq utc call log api url agentpopupurl yes nil string; lsq utc agent popup api url callrouteurl yes nil string; lsq utc call route api url isactive no true string; (true/false) whether the tenant/application is active or not callstarttimer no 00 00 00 string; allow calling from this time on a day callendtimer no 23 59 59 string; stop calling from this time on a day callalloweddays no \[“monday”, “tuesday”, “wednesday”, “thursday”, “friday”, “saturday”, “sunday”] \[string]; allowed days to make a call enableoutboundpopup no true \[string]; (true/false) enable popup for outbound calls query parameters field mandatory default description app yes nil name of the application in lowercase (ex leadsquared) sample request { "isactive" "true", "leadsquared" { "calllogapiurl" "https //telephony in21 leadsquared com/ ", "callrouteurl" "https //telephony in21 leadsquared com/ ", "agentpopupurl" "https //telephony in21 leadsquared com/ " "isactive" "true" } } response parameters param mandatory description status yes success/error message no error message, if any data no response data sample response { "data" { "isactive" "true", "token" "\<token> " }, "status" "success" } http status codes status code description 200 success 400 invalid input more details found in response description 401 unauthorised 500 server error get coc config this endpoint is responsible for retrieving the configs of the leadsquared application http request \ curl location request get 'https //api cocreate exotel com/v1/coc auth/{accsid}/config (for singapore domestic accounts) https //api lsq cocreate exotel com/v1/coc auth/{accsid}/config ( for all mumbai stamp accounts and international sgp accounts ) request header contenttype application/json api key exotel api key api token exotel api token parameter mandatory default description app yes nil name of the application in lowercase (ex leadsquared) response parameters param mandatory description status yes success/error message no error message, if any data no response data sample response { "data" { "isactive" "true", "leadsquared" { "agentpopupurl" "https //telephony in21 leadsquared com / ", "callalloweddays" \[ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ], "callendtimer" "23 59 59", "calllogapiurl" "https //telephony in21 leadsquared com / ", "callrouteurl" "https //telephony in21 leadsquared com / ", "callstarttimer" "00 00 00" "isactive" "true" }, "token" "\<token>" }, "status" "success" } http status codes status code description 200 success 400 invalid input more details found in response description 401 unauthorised 500 server error call flow configuration exotel portal login to exotel acc(https //my exotel com/) navigate to admin panel >> app bazar click on custom apps (+ create) to add a new flow add an ‘app name’ and create a new flow call start >> add a connect applet to begin the call flow connect applet configure dialwhom section with ‘ dial phone number(s) returned by url’ primaryurl (for singapore domestic accounts) https //api cocreate exotel com/v1/leadsquared/inbound/call/dialwhom?accsid={accsid} (for mumbai and all international accounts) accounts https //api lsq cocreate exotel com/v1/leadsquared/inbound/call/dialwhom?accsid={accsid} create popup to enable pop up on the leadsquared portal https //api cocreate exotel com/v1/leadsquared/inbound/call/popup?accsid={accsid} (for singapore domestic accounts) (for mumbai and all international accounts) https //api lsq cocreate exotel com/v1/leadsquared/inbound/call/popup?accsid={accsid} after the call conversation ends add passthru applet if nobody answers add passthru applet passthru applet (call conversation ends) passthru url (for singapore domestic accounts) https //api cocreate exotel com/v1/leadsquared/inbound/call/passthru?accsid=xxxxx (for mumbai and all international accounts) https //api lsq cocreate exotel com/v1/leadsquared/inbound/call/passthru?accsid=xxxxx make passthru asynchronous (☑) passthru applet (if nobody answers) passthru url (for singapore domestic accounts) https //api cocreate exotel com/v1/leadsquared/inbound/call/passthru?accsid=xxxx (for mumbai and all international accounts) \ https //api lsq cocreate exotel com/v1/leadsquared/inbound/call/passthru?accsid=xxxx make passthru asynchronous (☑) the above call flow setup can only handle calls from existing leads that are created and available in leadsquared to handle new callers whose data is not available in leadsquared, please add the below to the existing call flow the idea is to route the new callers to the groups available in exotel if we don’t receive any lead owner numbers from leadsquared and we will send those call details to leadsquared based on which they can create a lead in leadsquared post call completion place the 2nd connect applet in the “ we didn't dial anyone ” section as mentioned below in dial whom of 2nd connect applet, choose a group to dial you can also route the calls to a common customer care number by doing below where 1234567890 is the customer care number instead of providing a group configure both agent popup and passthru with the below urls as same as it’s configured in the 1st connect applet to send popup data and call logs to leadsquared create popup to enable pop up on the leadsquared portal (for all singapore domestic account) https //api cocreate exotel com/v1/leadsquared/inbound/call/popup?accsid={accsid} (for mumbai and all international accounts) https //api lsq cocreate exotel com/v1/leadsquared/inbound/call/popup?accsid={accsid} passthru applet (call conversation ends) passthru url (for all singapore domestic account) https //api cocreate exotel com/v1/leadsquared/inbound/call/passthru?accsid={accsid} (for mumbai and all international account) https //api lsq cocreate exotel com/v1/leadsquared/inbound/call/passthru?accsid={accsid} make passthru asynchronous (☑) passthru applet (if nobody answers) passthru url (for all singapore domestic account) https //api cocreate exotel com/v1/leadsquared/inbound/call/passthru?accsid={accsid} (for mumbia and all international account) https //api lsq cocreate exotel com/v1/leadsquared/inbound/call/passthru?accsid={accsid} make passthru asynchronous (☑)