1. Feature Overview
LeadSquared Generic Telephony connector allows you to integrate any cloud telephony services with LeadSquared and it works across all regions. Your developer would need to understand the standard format of data to be posted into LeadSquared.
LeadSquared Generic Telephony Connector has the following features:
- Capture Call logs
- Click to Call
- Agent Popup
- Call Routing
- Call Disposition
- Single sign-on API
Follow the steps below to configure the LeadSquared Generic Telephony Connector in your account –
2. Prerequisites
- You must be an Administrator to install and configure this connector.
- You may require coding experience to configure the connector with your telephony provider.
3. Installation
Navigate to Apps>Apps Marketplace>Telephony, and under the LeadSquared Generic Telephony Connector, click Install
4. Configuration
Click on Settings>Configure
Name
Enter the name of the Telephony service provider and save.
Virtual Numbers
Add virtual numbers and tag name one by one and save it.
Call Route
This API is used to get the lead/opportunity owner. It is setup up automatically.
- Copy the Call Route API URL from Call Route API tab on the popup and deploy it in your cloud telephony account.
- Use HTTP GET method to send the data. Please refer to the usage section to understand how to send the data.
Agent Popup
You may enable Real-time Inbound Call Notification to the User, seen in the form of an Incoming Call Popup, whenever an inbound call from a lead (made to your virtual number) is routed to the LeadSquared User.
Note:
- Incoming calls matching a lead’s secondary phone number will be tracked without creating a duplicate lead.
- If you have multiple leads with the same phone number, you can pass the
LeadIdin the Agent Popup API. This will ensure that the correct lead details appear in the agent popup. For e.g.,"LeadId": "4c70ce73-0732-4977-85a2-fb49a978b85c".
- Copy the Agent Popup API URL from Agent popup tab and deploy it in your cloud telephony account.
- Use HTTP POST method to send the data to LeadSquared in JSON format.
- Enable Agent Popup by selecting the checkbox.
Please refer the ‘Usage’ section to understand how to send the data.
Call Log
All Inbound and Outbound calls made through your Telephony account can be logged in LeaSquared by setting up Call Logs.
After a call (incoming or outgoing) you can post the call logs to LeadSquared. This ensures that each phone interaction is logged in LeadSquared.
When your Telephony provider calls the LeadSquared API, data can be pushed into LeadSquared using POST method in JSON format.
{
"SourceNumber":"%2b919611795983",
"DestinationNumber":"%2b919611795980",
"DisplayNumber":"%2b919020897874",
"StartTime":"2015-08-20 18:26:38",
"EndTime":"2015-08-20 18:26:38",
"CallDuration":"12",
"Status":"Answered",
"CallNotes":"Enquired about product",
"ResourceURL":"server/filename.extension",
"Direction":"Inbound",
"CallSessionId":"080673309211440075398",
"CallerName":"Rakesh",
"CallerCity":"Bangalore",
"CallerState":"Karnataka",
"CallerCountry":"India",
"CallerZipCode":"560078"
}
| Property | Sample Value | Description | Mandatory |
| SourceNumber | +919611795983 | For Inbound Call- Lead’s contact number For Outbound Call- Caller’s Number or Agent’s number | Yes |
| DestinationNumber | +919611795980 | For Inbound Call- Caller’s Number or Agent’s number For outbound Call- Lead’s contact number | Yes |
| DisplayNumber | +919020897874 | Virtual(DID) Number provided by the provider | Yes |
| StartTime | 2015-08-20 18:26:38 | Start time of the call | Yes |
| EndTime | 2015-08-20 18:26:50 | End time of the call | Yes |
| CallDuration | 12 | Duration of call in seconds | Yes |
| Status | Answered | Status of the call, can be Answered, Missed, Voicemail | Yes |
| CallNotes | Enquired about a product | Additional notes about the call | No |
| ResourceURL | Server/filename.extension | URL of the file with a recording of the conversation | No |
| Direction | Inbound | Inbound or Outbound | Yes |
| CallSessionId | 080673309211440075398 | Call Unique Identifier | No |
| CallerName | Ram | Caller’s Name | No |
| CallerCity | Bangalore | Caller’s City | No |
| CallerState | Karnataka | Caller’s State | No |
| CallerCountry | India | Caller’s Country | No |
| CallerZipCode | 5600102 | Caller’s zip code | No |
You will find the Call Log API URL in Call Log API tab on the popup, deploy it in your cloud telephony account to log inbound and outbound phone calls.
Please refer to the usage section to understand how to send the data.
Click to Call
You can enable click to call feature for users, it will help them to initiate outbound calls directly from LeadSquared.
- Place the URL which is provided by your telephony service provider in URL field with necessary parameters as mentioned in the URL. (See Usage section)
- Select the HTTP method in which your telephony service accepts the data.
- Enter response keyword, which would be the response received by LeadSquared once data is posted successfully in to your Telephony Account. For e.g., OK, Success etc.
- Enable click to call feature for the Users by selecting the check box.
Please refer to the usage section to understand how to send the data.
A sample URL is provided to show you how you can pass the available parameters –
| Field | Description |
| @virtualNumber | Virtual Number the customer will see. |
| @leadId | Lead Id in LeadSquared. |
| @customerNumber | Lead Phone number without country code. |
| @PhoneNumberWithCountryCode | Lead Phone number with country code. |
| @agentNumber | User’s (Agent’s) Number |
| @agentName | User’s (Agent’s) Name |
| @agentEmail | User’s (Agent’s) Email Address |
| @{User:TeamId,} | Pass the Team Id if you’re using the teams feature and have included the user in a team. |
| @{User:GroupIds,} | Comma separated Ids of groups that the user belongs to. |
Call Disposition
When the call is ended between User and client, some of the telephony providers will not free the agent to take another call unless the current call is disposed, so the call has to be disposed with appropriate values.
After integration, the user can dispose calls from LeadSquared.
For it Create a Custom dropdown field in LeadSquared (say Disposition) with Call disposition options/values.
Now when the call is ended agent can select appropriate disposition value on Call/Agent-Notification Popup and dispose the call and get ready for the new call.
- Deploy URL provided by your telephony service in URL field with necessary parameters.
- Select the HTTP method in which your telephony service accepts the data.
- Select the Disposition field created earlier to capture Disposition value.
Single Sign-on API
This API will help you to embed LeadSquared within your telephony application.
Use Single sign-on API and use HTTP POST method to send data to LeadSquared in JSON format. And to get lead details use Lead Details API.
Please refer to the usage section to understand how to send the data.
Any Questions?
Did you find this article helpful? Please let us know any feedback you may have in the comments section below. We’d love to hear from you and help you out!
