.png?sv=2022-11-02&spr=https&st=2025-12-23T15%3A49%3A58Z&se=2025-12-23T15%3A59%3A58Z&sr=c&sp=r&sig=isMD9mr05W2lc7oiF41LPZGLOTKf%2BTp0kj%2BRNUphAi0%3D){kind=logo}
Set Callback
- DarkLight
Set Callback
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The SetCallback API provides an option for the Agent to schedule a Regular Callback for a contact. The agents can also add call comments and target value achieved during the call. Regular callback is delivered to any Available Agent for the Campaign unlike a Personal Callback that is delivered only to a specific agent.
Pre-requisite
The agent must be on an active call or logged in to the application.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | SetCallbackWithComments |
source | «app-name-broadcasting-this-message» |
data | N/A |
Data Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
callid | Yes | String | The Call ID generated by the application. |
AccountNumber | Yes | String | The LCM Key. |
StartDate | Yes | String | The callback start date in DD/MM/YYYY format. |
EndDate | Yes | String | The callback end date in DD/MM/YYYY format. |
StartTime | Yes | String | The callback start time in HH:mm (24-h) format. |
EndTime | Yes | String | The callback end time in HH:mm (24-h) format. |
CallbackModeId | Yes | Number | The mode ID for the callback call. |
UserID | Yes | String | The agent ID. |
AgentComments | Yes | String | The comments entered by the agent. |
LeadScore | Yes | Number | The lead score for the contact. |
TargetAmount | Yes | Number | The target achieved. |
Response Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | SetCallbackWithCommentsResult |
message | «JSON Object» |
Message Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
callid | Yes | String | The call ID generated by the application. |
response | Yes | JSON Object | The response data. |
Response Parameters | |||
success | Yes | Boolean | The callback status. |
Possible Error Cases
Error Type | Actual Error | Message |
|---|---|---|
WS_Error | Callid is empty | Invalid Call ID. |
WS_Error | Invalid Call ID:<call_id> | Invalid Call ID. |
Sample Request
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "SetCallbackWithComments",
"data":
{
"callid": "12345",
"AccountNumber": "5|3|1|0|0|44|1",
"StartDate": "03/07/2020",
"EndDate": "03/07/2020",
"StartTime": "13:45",
"EndTime": "13:45",
"CallbackModeID": 1,
"UserID": "testagent",
"AgentComments": "Test comment",
"LeadScore": 0,
"TargetAmount": 0
}
}Sample Response
{
"channel": "LCM",
"topic": "WebService",
"subtopic": " SetCallbackWithCommentsResult",
"message":
{
"callid": "12345",
"response":
{
"success": true
}
}
}Was this article helpful?