Get Call State
- DarkLight
Get Call State
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
This API allows the Agent to get the state of current call.
Pre-requisite
The agent must be on an active call.
Sequence Diagram

Message Structure
Request Parameters | Value |
|---|---|
channel | Cisco |
topic | Call |
subtopic | GetCallState |
source | «app-name-broadcasting-this-message» |
data | Not Applicable |
Data Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
No data parameters |
Sample Request
{
"channel": "Cisco",
"topic": "Call",
"subtopic": "GetCallState"
}Sample Response
{
"channel": "Cisco",
"topic": "Call",
"subtopic": "CallsStateChange",
"message": {
"source": "api",
"calls": [],
"isNonVoice": false
}
}Was this article helpful?