Show Agent Pop-Up
This API allows you to show the Agent Popup for the LeadSquared Generic Telephony Connector.
Note: You need to pass the “LeadId” and the corresponding “UserId” in the JSON body.
API URL
URL
POST
https://{host}/v2/Telephony.svc/ShowAgentPopup?accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/jsonJSON Body/Payload
{
"SourceNumber":"+91-8611795988",
"DestinationNumber":"+91-8971373363",
"DisplayNumber":"+91-8611795989",
"Direction":"Inbound",
"CallSessionId":"12345",
"LeadId":"f5c7e023-653c-11e7-b25c-023cca4497b9",
"Tag":"Tag - Lead",
"UserId":"dd908e91-c5c9-11e5-8de3-22000aa5088d"
}
Request Parameters
| Parameter | Description |
|---|---|
| SourceNumber | This is the source telephone number. In case of an inbound call, the source phone number is the lead’s phone number. In case of an outbound call, the source is the agent phone number. |
| DestinationNumber | This is the destination telephone number. In case of an inbound call, the destination phone number is the agent’s phone number. In case of an outbound call, the destination number is the Lead’s phone number. |
| DisplayNumber | This is the IVR number. |
| Direction | This is the direction of the call. This can be inbound or outbound. |
| CallSessionId | This is the unique Id of the call session. |
| LeadId | This is the unique Id of a lead. |
| Tag | This is particular to each virtual number. The tag gets added to the origin of the Lead. Note: This is an optional field and is not mandatory for the API to work. |
| UserId | This is the unique Id of the LeadSquared user you want to associate to the Lead. Use the Get Users API under User Management to retrieve this value. |
Response
200 OK
Content-Type: application/json
{
"Status": "Success",
"Message": {
"Id": "b8c4d74f-17ed-4bae-9f05-c183496680f1",
"Message": "Message broadcasted successfully"
}
}
HTTP Response Codes
| Code | Description |
|---|---|
| 200 OK | This is the status code for successful API call. |
| 401 Unauthorized | The API call was made with invalid access credentials. Check your AccessKey and SecretKey. |
| 400 Bad Request | The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure. |
| 404 Not Found | The API could not be found. Please check the API signature. |
| 429 Too Many Requests | API calls exceeded the limit of 25 in 5 second(s) |
| 500 Internal Server Error | The API called failed. There could be many reasons for it. Check the exception message to get more details. |
