Update Call Variables
- DarkLight
Update Call Variables
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
This API allows the Agent to update the call variables that are defined and enabled in the Cisco Finesse application.
Pre-requisite
The agent must be on an active call.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
channel | Cisco |
topic | Agent |
subtopic | UpdateCallVariables |
source | «app-name-broadcasting-this-message» |
data | «JSON Object» |
Data Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
callID | String | The Call ID. | 2130707678 |
key | String | The call variable name. | CallVariable1 |
value | String | The call variable to be updated. | 67 |
Sample Request
{
"channel": "Cisco",
"topic": "Agent",
"subtopic": "UpdateCallVariables",
"data": {
"callID": "2130707678",
"key": "callVariable1",
"value": "67"
}
}Sample Response
The agent receives the following events:
SetAgentState
OutBoundCallStateChange
Was this article helpful?