Call Connection - Remove Participant

Ссылка

Служба:: Communication

Версия API:: 2024-09-15

Удалите участника из вызова с помощью идентификатора.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
callConnectionId	path	True	string	Идентификатор подключения вызова.
endpoint	path	True	string url	Конечная точка ресурса связи Azure.
api-version	query	True	string	Версия API для вызова.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Authorization	True	string	Маркер доступа пользователей служб коммуникации Azure.
Repeatability-Request-ID		string uuid	Если задано, клиент указывает, что запрос повторяется; т. е. клиент может несколько раз выполнять запрос с одной и той же повторяемостью,Request-Id и возвращать соответствующий ответ без выполнения запроса несколько раз. Значение повторяемостиRequest-Id является непрозрачной строкой, представляющей созданный клиентом уникальный идентификатор запроса. Это UUID версии 4 (случайный).
Repeatability-First-Sent		string date-time-rfc1123	Если задано значение "Повторяемость-Request-ID заголовка", необходимо также указать заголовок "Повторяемость-First-Sent". Значение должно быть датой и временем создания запроса, выраженным с помощью формы HTTP-даты, исправленной МВФ. Пример: Sun, 06 ноября 1994 08:49:37 GMT.

Текст запроса

Имя	Обязательно	Тип	Описание
participantToRemove	True	CommunicationIdentifierModel
operationCallbackUri		string	Задайте URI обратного вызова, который переопределяет URI обратного вызова по умолчанию, заданный createCall/AnswerCall для этой операции. Эта настройка выполняется для каждого действия. Если это не задано, будет использоваться универсальный код ресурса (URI) обратного вызова по умолчанию, заданный createCall/AnswerCall.
operationContext		string	Используется клиентами при вызове действий среднего вызова для сопоставления запроса с событием ответа.

Ответы

Имя	Тип	Описание
202 Accepted	RemoveParticipantResponse	Служба приняла запрос на удаление участника и начнет обработку. Вы получите событие RemoveParticipantSucceeded или RemoveParticipantFailed по указанному URI обратного вызова, чтобы обновить состояние запроса.
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=2024-09-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 обратного вызова, который переопределяет URI обратного вызова по умолчанию, заданный createCall/AnswerCall для этой операции. Эта настройка выполняется для каждого действия. Если это не задано, будет использоваться универсальный код ресурса (URI) обратного вызова по умолчанию, заданный createCall/AnswerCall.
operationContext	string	Используется клиентами при вызове действий среднего вызова для сопоставления запроса с событием ответа.
participantToRemove	CommunicationIdentifierModel

RemoveParticipantResponse

Полезные данные ответа для удаления участников вызова.

Имя	Тип	Описание
operationContext	string	Контекст операции, предоставляемый клиентом.

Поделиться через