Call Connection - Cancel Add Participant

Ссылка

Служба:: Communication

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

Отмена операции добавления участника.

POST {endpoint}/calling/callConnections/{callConnectionId}/participants:cancelAddParticipant?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.

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

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

Ответы

Имя	Тип	Описание
202 Accepted	CancelAddParticipantResponse	Возвращает ответ cancelAddParticipant
Other Status Codes	CommunicationErrorResponse	Ошибка

Безопасность

Authorization

Маркер доступа пользователей служб коммуникации Azure.

Тип: apiKey
В: header

Примеры

CallConnection_CancelAddParticipant

Образец запроса

HTTP

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

{
  "invitationId": "7b4244f8-d2ff-46d1-a629-4f9fb5f73d40",
  "operationContext": "cancelling add participant",
  "operationCallbackUri": "https://app.contoso.com/callback"
}

Пример ответа

Код состояния:: 202

{
  "invitationId": "7b4244f8-d2ff-46d1-a629-4f9fb5f73d40",
  "operationContext": "cancelling add participant"
}

Определения

Имя	Описание
CancelAddParticipantRequest	Запрос полезных данных для отмены запроса участника.
CancelAddParticipantResponse	Полезные данные ответа для отмены запроса участника.

CancelAddParticipantRequest

Запрос полезных данных для отмены запроса участника.

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

CancelAddParticipantResponse

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

Имя	Тип	Описание
invitationId	string	Идентификатор приглашения, используемый для отмены действия добавления участника.
operationContext	string	Контекст операции, предоставляемый клиентом.

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