你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Call Connection - Remove Participant

服务:

Communication

API 版本:

2023-10-15

使用标识符从呼叫中删除参与者。

POST {endpoint}/calling/callConnections/{callConnectionId}/participants:remove?api-version=2023-10-15

URI 参数

名称	在	必需	类型	说明
callConnectionId	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 标头。 该值应为首次创建请求的日期和时间，使用 IMF-fixdate 形式的 HTTP-date 表示。 示例：星期日，1994年11月6日 08：49：37 GMT。

请求正文

名称	必需	类型	说明
participantToRemove	True	CommunicationIdentifierModel
operationCallbackUri		string	设置一个回调 URI，用于替代由 CreateCall/AnswerCall 为此操作设置的默认回调 URI。 此设置是按操作进行的。 如果未设置，将使用 CreateCall/AnswerCall 设置的默认回调 URI。
operationContext		string	客户在调用通话中操作时使用，将请求与响应事件相关联。

响应

名称	类型	说明
202 Accepted	RemoveParticipantResponse	服务已接受删除参与者请求，并开始处理该请求。 在指定的回调 URI 处，将收到 RemoveParticipantSucceeded 或 RemoveParticipantFailed 事件，以更新请求的状态。
Other Status Codes	CommunicationErrorResponse	错误

安全性

Authorization

Azure 通信服务用户访问令牌。

类型: apiKey
在: header

示例

CallConnection_RemoveParticipant

示例请求

HTTP

POST https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c/participants:remove?api-version=2023-10-15

{
  "participantToRemove": {
    "kind": "communicationUser",
    "communicationUser": {
      "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538"
    }
  },
  "operationContext": "removing participant",
  "operationCallbackUri": "https://app.contoso.com/callback"
}

示例响应

状态代码:

202

{
  "operationContext": "removing participant"
}

定义

名称	说明
RemoveParticipantRequest	按标识符删除参与者请求。
RemoveParticipantResponse	用于删除呼叫参与者的响应有效负载。

RemoveParticipantRequest

按标识符删除参与者请求。

名称	类型	说明
operationCallbackUri	string	设置一个回调 URI，用于替代由 CreateCall/AnswerCall 为此操作设置的默认回调 URI。 此设置是按操作进行的。 如果未设置，将使用 CreateCall/AnswerCall 设置的默认回调 URI。
operationContext	string	客户在调用通话中操作时使用，将请求与响应事件相关联。
participantToRemove	CommunicationIdentifierModel

RemoveParticipantResponse

用于删除呼叫参与者的响应有效负载。

名称	类型	说明
operationContext	string	客户端提供的操作上下文。