.png?sv=2022-11-02&spr=https&st=2025-06-05T11%3A52%3A39Z&se=2025-06-05T12%3A02%3A39Z&sr=c&sp=r&sig=IIFZzgpaBMeHfZo1uDglK6ldh435y2ifzaxwFW%2FY%2B8M%3D){kind=logo}
Get Callback Modes
- DarkLight
Get Callback Modes
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The GetCallBackModes API provides the list of modes associated with specified contacts and tagged with a Callback strategy.
.jpg?sv=2022-11-02&spr=https&st=2025-06-05T11%3A52%3A39Z&se=2025-06-05T12%3A02%3A39Z&sr=c&sp=r&sig=V23yMq%2BbecXOditWBTtvHBGCj7bg9ctyob0GANfTyGk%3D)
Pre-requisite
The Agent must be on an active call or logged in to the application.
Sequence Diagram
.jpg?sv=2022-11-02&spr=https&st=2025-06-05T11%3A52%3A39Z&se=2025-06-05T12%3A02%3A39Z&sr=c&sp=r&sig=V23yMq%2BbecXOditWBTtvHBGCj7bg9ctyob0GANfTyGk%3D)
Message Structure
Request Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | GetCallBackModes |
source | «app-name-broadcasting-this-message» |
data | «JSON Object» |
Data Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
callid | Yes | String | Call ID. |
AccountNumber | Yes | String | LCM Key. |
Response Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | CallbackModes |
message | «JSON Object» |
Message Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
callid | Yes | String | Call ID. |
response | Yes | JSON Array | Callback modes data. |
Response Parameters | |||
ModeID | Yes | String | The mode ID. |
Description | Yes | String | The mode description. |
ChannelType | NA | NA | NA |
MinLength | NA | NA | NA |
MaxLength | NA | NA | NA |
Cvalue | Yes | String | The current mode value - a phone number. |
PEWC | NA | NA | NA |
CampaignPEWC | NA | NA | NA |
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": "GetCallBackModes",
"data":
{
"callid": "12345",
"AccountNumber": "5|3|1|0|0|44|1"
}
}Sample Response
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "CallBackModes",
"message":
{
"callid": "12345",
"response":
[
{
"ModeID": "3",
"Description": "Mobile",
"ChannelType": null,
"MinLength": null,
"MaxLength": null,
"Cvalue": "6591462346",
"PEWC": true,
"CampaignPEWC": false
},
{
"ModeID": "2",
"Description": "Office",
"ChannelType": null,
"MinLength": null,
"MaxLength": null,
"Cvalue": "6591462346",
"PEWC": true,
"CampaignPEWC": false
}
]
}
}Was this article helpful?