.png?sv=2022-11-02&spr=https&st=2025-10-21T08%3A05%3A43Z&se=2025-10-21T08%3A15%3A43Z&sr=c&sp=r&sig=dmPHPI4JFtpY8Vnq1FFBCzTeu6brdtkEe%2BZtk4adGt8%3D){kind=logo}
Mute
- DarkLight
Mute
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
This API allows muting the Agent’s microphone.
Pre-requisite
Agent must be on an active call.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
channel | Amazon |
topic | Agent |
subtopic | Mute |
source | «app-name-broadcasting-this-message» |
Response Parameters | Value |
|---|---|
channel | Amazon |
topic | Agent |
subtopic | SetAgentState |
message | JSON Object |
Message Parameters
Parameters | Data Type | Description | Example Data |
|---|---|---|---|
rules | JSON Object | Button state rules. Refer Rules in Appendix. | NA |
data | JSON Object | User details of agent. Refer AgentInfo in Appendix. | NA |
event | String | Name of the event. | Not Ready |
source | String | Source of the message. | Event |
Sample Request
{
"channel": "Amazon",
"topic": "Agent",
"subtopic": "Mute",
"source": "myapp"
}Sample Response
{
"channel": "Amazon",
"topic": "Agent",
"subtopic": "SetAgentState",
"message": {
"rules": {
"ButtonStates": {
"items": {
"mute": "Hide",
"unmute": "Enable"
},
"count": 2
},
"ResponseActual": {
"agentStateARN": null,
"type": "system",
"name": "Busy",
"startTimestamp": "2020-04-09T13:45:37.151Z"
}
},
"data": {
"muted": true,
"name": "Agent 1",
"extension": "",
"loginName": "agent1",
"softphoneEnabled": true,
"state": "Not_Ready",
"reasonCode": {
"id": "Busy"
},
"stateChangeTime": "2020-04-09T13:45:37.151Z",
"type": "system"
},
"event": "Busy",
"source": "event"
}
}Was this article helpful?