.png?sv=2022-11-02&spr=https&st=2025-12-23T19%3A15%3A17Z&se=2025-12-23T19%3A25%3A17Z&sr=c&sp=r&sig=ttlmnJNXSSKz4cMYCgCefZKOBwMrBDsZfm7CoUeqXz0%3D){kind=logo}
Set New Mode Number
- DarkLight
Set New Mode Number
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The SetNewModeNumber API allows an Agent to add or change the contact mode of an existing contact.
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-12-23T19%3A15%3A17Z&se=2025-12-23T19%3A25%3A17Z&sr=c&sp=r&sig=rJgJLQGZrhT3TSRS0f0mesfUAs04ccvyh9jD3RRfR8k%3D)
Message Structure
Request Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | SetNewModeNumber |
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. |
ModeID | Yes | String | The mode ID. |
ContactNumber | Yes | String | The contact number to be updated in the mode. |
DeleteOtherModes | Yes | Boolean | Set to true to delete all other available modes when this update is completed by the agent. Set to false to retain other modes. |
AgentID | Yes | String | The agent ID. |
Response Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | SetNewModeNumberResult |
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 mode number change 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": "SetNewModeNumber",
"data":
{
"callid": "12345",
"AccountNumber": "5|3|1|0|0|44|1",
"ModeID": 1,
"ContactNumber": "961084836",
"DeleteOtherModes": false,
"AgentID": "testagent"
}
}Sample Response
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "SetNewModeNumberResult",
"message":
{
"callid": "12345",
"response": {
"success": true
}
}
}Was this article helpful?