Quick Call Telephony API
Table of Contents
Click 2 Call API…………………………………………………………………………….………2.1
Call Back Lead Upload API…………………………………………………………….…....2.2
2.1 Click 2 Call API
Introduction
The Quick Click2Call API is a robust solution that allows developers to integrate
click-to-call functionality into their applications. This API enables users to initiate
phone calls effortlessly, facilitating seamless communication between users and
businesses. This document serves as a comprehensive guide to the Quick
Click2Call API, outlining its usage, parameters, and responses.
API Method
The Quick Click2Call API utilizes the HTTP GET request method to initiate a phone
call. By constructing a GET request with the required parameters, developers can
trigger a call to the desired phone number. This straightforward method
streamlines the integration process, enabling users to establish communication
channels quickly.
Endpoint
The API endpoint for the Click2Call API is:
[Link]
neNo}&Name={CustomerName}&CampaignID={CampaignID}&AgentID={AgentID}
&Priority=1&Duplic
ate=2&Remark=Default&ClientID={LeadID}&AlternateNo={Number1},{Number2}
Integration Type: API
API Consumer: 3rd Party App / CRM
HTTP Method: GET
Required Parameters
The Click2Call API requires the following parameters to be included in the GET
request:
Parameters Description
PhoneNo (String, required) The PhoneNo is the phone number to which the call will be made
Name(String,Optional) This parameter specifies the name associated with the caller
CampaignID (String, required) This parameter is to specify the Campaign ID.
Remarks (String, required) This parameter is to specify the Lead Remark. One can specify as Default
AgentID (String, required) The AgentID parameter represents the Agent or representative who is initiating the call.
ClientID (String, optional) This parameter is to specify the LeadID associated with the call.
The Priority parameter signifies whether it is a Normal Call (2), Call Back
Priority (Integer, required)
(1) or Urgent Call (0). In case it is agent-specific then one must specify the value as 1
The Duplicate parameter determines whether duplicate calls to the same phone number are allowed.
0 means duplicity will be checked on PhoneNo
Duplicate (integer, required) 1 means Remarks+PhoneNo
2 means None i.e.
3 means Name+Remarks+PhoneNo
it will not check the duplicity and insert a fresh record
GET request using the Click2Call API:
[Link]
0&CampaignID=ABC123&AgentID=XYZ456&Priority=1&Duplicate=2
Response:
The Click2Call API responds with a JSON object containing information about the
call initiation status. The response may include the call ID, status code, and any
error messages if applicable.
2.2 Call Bulk Lead Upload API
Method-POST
Content-Type - application/json
UAT Campaign URL - [Link]
JSON Body
Note- Only 100 calls are permitted in a single set. If there are more records,
proceed with the sequence ID (starting from 1,2,3 and so on) in the start of shown
below.
-----------
1;CLC@QuickCall;{"Priority":"2","RemoveZero":"1","RejectedLog":"1","DuplicityCheck":"2","
EncryptedPhoneNo":"0","AutoSaveExtraInfo":"1","RemarksSuffix":"DDMMM",,"FixedAgent":"",
"CampaignId":"RHICL_BulkUpload","DialMode":"FIFO","FixedRemarks":"Default","data":[{"pho
neno":9899978503,"name":"BalvinderSingh","agentid":"bsingh","clientid":"acdfrs123","Altern
ateNo":"9988944339,998844277,8223383399"
},{"phoneno":9899978503,"name":"VijayKumar",,"agentid":"bsingh","clientid":"gtdrrs143"},{"p
honeno":99585781,"name":Ajay,"agentid":"bsm","clientid":"eersds1923"}]}
Optional fields - Field1, Field2, Field3, Field4 …. Field30
"DialMode":"FIFO" or "DialMode":"LIFO"
If DialMode parameter is given (either FIFO or LIFO) then lead will get active by default.
Response
-----------
{"UploadLead":"Success","Response":{"Records":3,"Inserted":3,"Rejected":0,"AlphaNumeric":0,
"DuplicateRows":0,"PhoneNoLength":0}}
2;CLC@QuickCall;{"Priority":"2","RemoveZero":"1","RejectedLog":"1","DuplicityCheck":"2",
"EncryptedPhoneNo":"0","AutoSaveExtraInfo":"1","RemarksSuffix":"DDMMM",,"FixedAgent":"
","CampaignId":"RHICL_BulkUpload","FixedRemarks":"Default","data":[{"phoneno":778878503,
"name":"GauravKumar","agentid":"bsingh"},{"phoneno":889978503,"name":"889978503",,
"agentid":"bsingh"},{"phoneno":7799585781,"name":Dhananjay,"agentid":"bsm"}]}
Response:-
-----------
{"UploadLead":"Success","Response":{"Records":3,"Inserted":3,"Rejected":0,"AlphaNumeric":0,
"DuplicateRows":0,"PhoneNoLength":0}}
Failure Response
1. Campaign ID do not found in the database
{"UploadLead":"Error","Response":{"Number":-18,"Description":"CampaignId Not
Found","Source":"[Link]"}}
2. PhoneNo field contains an Alphanumeric
{"UploadLead":"Success","Response":{"Records":3,"Inserted":2,"Rejected":1,"AlphaNumeric":1,
"DuplicateRows":0,"PhoneNoLength":0}}