Click2Call integration is based on receiving the API GET request from CRM IP addresses allowlisted in the PBX to process the request.
IMPORTANT
You must allowlist your IP address. Otherwise, you will get the HTTP 404 Not Found response.
The Click2Call request looks like this:
CRM_ID — a static unique CRM vendor ID (mandatory field)
Client_ID — a static unique client ID (mandatory field)
leg_a — a unique agents/user extension in PBX (mandatory field)
leg_b — a number called by an agent (mandatory field)
prefix — an additional prefix to be used before a called number (optional field)
custom_data — custom data in the Click2Call API request that allows you to add your own key-value data in the CDR, e.g. Lead ID in the CRM
To learn more about Click2Call, check Click2Call Overview.
FAQs:
What is the format of the required data?
All required values are expected as an integer data type. The called number should be in the E.164 format.What is an example of a successful response to the Click2Call request?
Example:
{"success":true,"message":"OK","unique_id":"10000000.1000","leg_a":"1000","leg_b":"*4477668899","pbx":"subdomain.pbx.commpeak.com"}
What is an example of an error response?
Example:
{"success":false,"message":"Extension does not exist.","unique_id":"10000000.1000","leg_a":"10270000","leg_b":"*4477668899","pbx":"subdomain.pbx.commpeak.com"}
How do we test the Click2Call integration between the CRM and the PBX?
CommPeak may use a customer's PBX for test purposes to check and confirm successful Click2Call requests from the CRM.How to add custom data to the Click2Call request?
You can add custom data to your Click2Call request, e.g. leadid, userid, domain, recordno, or any other data.
Example:
https://<pbx_name>.stats.pbx.commpeak.com/click2call/leg_a/leg_b/prefix?leadid=1234&domain=anothertest
In the above example for PBX Stats Click2Call Integration, the following custom data is added:
the leadid parameter and 1234 value
the domain parameter and anothertest value
If you wish to perform a search for your custom data and display it in CDRs, you need to configure custom CDR fields in PBX Stats. Add the cdr_custom_fields and cdr_extra_data on the Admin Page.
The custom data fields will be displayed in the advanced search on the CDRs page.
