你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Call Connection - Mute
使用标识符将呼叫中的参与者静音。
POST {endpoint}/calling/callConnections/{callConnectionId}/participants:mute?api-version=2023-10-15
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
call
|
path | True |
string |
呼叫连接 ID。 |
endpoint
|
path | True |
string url |
Azure 通信资源的终结点。 |
api-version
|
query | True |
string |
要调用的 API 版本。 |
请求头
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
Authorization | True |
string |
Azure 通信服务用户访问令牌。 |
Repeatability-Request-ID |
string uuid |
如果指定,客户端指示请求是可重复的;也就是说,客户端可以多次使用相同的 Repeatability-Request-Id 发出请求,并返回适当的响应,而无需服务器多次执行请求。 Repeatability-Request-Id 的值是一个不透明的字符串,表示客户端为请求生成的唯一标识符。 它是版本 4 (随机) UUID。 |
|
Repeatability-First-Sent |
string date-time-rfc1123 |
如果指定了 Repeatability-Request-ID 标头,则还必须指定 Repeatability-First-Sent 标头。 该值应是首次创建请求的日期和时间,使用 HTTP-date 的 IMF-fixdate 形式表示。 示例:星期日,1994 年 11 月 6 日 08:49:37 GMT。 |
请求正文
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
targetParticipants | True |
Communication |
要从通话中静音的参与者。 仅支持 ACS 用户。 |
operationContext |
string |
客户在调用通话中操作时使用,将请求关联到响应事件。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
返回静音参与者响应 |
|
Other Status Codes |
Communication |
错误 |
安全性
Authorization
Azure 通信服务用户访问令牌。
类型:
apiKey
在:
header
示例
CallConnection_Mute
示例请求
POST https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c/participants:mute?api-version=2023-10-15
{
"targetParticipants": [
{
"kind": "communicationUser",
"communicationUser": {
"id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
}
}
],
"operationContext": "mute participant"
}
示例响应
{
"operationContext": "mute participant"
}
定义
名称 | 说明 |
---|---|
Mute |
呼叫中将参与者静音的请求有效负载。 |
Mute |
将参与者从呼叫中静音的结果有效负载。 |
MuteParticipantsRequest
呼叫中将参与者静音的请求有效负载。
名称 | 类型 | 说明 |
---|---|---|
operationContext |
string |
客户在调用通话中操作时使用,将请求关联到响应事件。 |
targetParticipants |
Communication |
要从通话中静音的参与者。 仅支持 ACS 用户。 |
MuteParticipantsResult
将参与者从呼叫中静音的结果有效负载。
名称 | 类型 | 说明 |
---|---|---|
operationContext |
string |
客户端提供的操作上下文。 |