Call Connection - Add Participant

Ссылка

Служба:: Communication

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

Добавьте участника в вызов.

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

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

Имя	Обязательно	Тип	Описание
participantToAdd	True	CommunicationIdentifierModel
customCallingContext		CustomCallingContext	Используется клиентом для отправки пользовательского контекста вызова целевым объектам
invitationTimeoutInSeconds		integer	Возвращает или задает время ожидания для ожидания, пока приглашенный участник получит получение. Максимальное значение этого значения составляет 180 секунд
operationCallbackUri		string	Задайте URI обратного вызова, который переопределяет URI обратного вызова по умолчанию, заданный createCall/AnswerCall для этой операции. Эта настройка выполняется для каждого действия. Если это не задано, будет использоваться универсальный код ресурса (URI) обратного вызова по умолчанию, заданный createCall/AnswerCall.
operationContext		string	Используется клиентами при вызове действий среднего вызова для сопоставления запроса с событием ответа.
sourceCallerIdNumber		PhoneNumberIdentifierModel
sourceDisplayName		string	(Необязательно) Отображаемое имя источника, связанного с этой операцией приглашения при добавлении участника ТСОП или пользователя teams. Примечание. Не будет обновлять отображаемое имя в списке.

Ответы

Имя	Тип	Описание
202 Accepted	AddParticipantResponse	Служба приняла запрос участника добавления и начнет обработку. Вы получите событие AddParticipantSucceeded или AddParticipantFailed по указанному URI обратного вызова, чтобы обновить состояние запроса.
Other Status Codes	CommunicationErrorResponse	Ошибка

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

Authorization

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

Тип: apiKey
В: header

Примеры

CallConnection_AddParticipant

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

HTTP

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

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

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

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

{
  "operationContext": "adding participant",
  "participant": {
    "identifier": {
      "kind": "communicationUser",
      "communicationUser": {
        "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538"
      }
    },
    "isMuted": false
  },
  "invitationId": "7b4244f8-d2ff-46d1-a629-4f9fb5f73d40"
}

Определения

Имя	Описание
AddParticipantRequest	Полезные данные запроса для добавления участника в вызов.
AddParticipantResponse	Полезные данные ответа для добавления участников в вызов.
CallParticipant	Участник вызова.
CustomCallingContext	Контекст пользовательского вызова, который будет отправлен в целевой объект

AddParticipantRequest

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

Имя	Тип	Описание
customCallingContext	CustomCallingContext	Используется клиентом для отправки пользовательского контекста вызова целевым объектам
invitationTimeoutInSeconds	integer	Возвращает или задает время ожидания для ожидания, пока приглашенный участник получит получение. Максимальное значение этого значения составляет 180 секунд
operationCallbackUri	string	Задайте URI обратного вызова, который переопределяет URI обратного вызова по умолчанию, заданный createCall/AnswerCall для этой операции. Эта настройка выполняется для каждого действия. Если это не задано, будет использоваться универсальный код ресурса (URI) обратного вызова по умолчанию, заданный createCall/AnswerCall.
operationContext	string	Используется клиентами при вызове действий среднего вызова для сопоставления запроса с событием ответа.
participantToAdd	CommunicationIdentifierModel
sourceCallerIdNumber	PhoneNumberIdentifierModel
sourceDisplayName	string	(Необязательно) Отображаемое имя источника, связанного с этой операцией приглашения при добавлении участника ТСОП или пользователя teams. Примечание. Не будет обновлять отображаемое имя в списке.

AddParticipantResponse

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

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

CallParticipant

Участник вызова.

Имя	Тип	Описание
identifier	CommunicationIdentifierModel
isMuted	boolean	Отключен ли участник
isOnHold	boolean	Участник на удержании.

CustomCallingContext

Контекст пользовательского вызова, который будет отправлен в целевой объект

Имя	Тип	Описание
sipHeaders	object	Пользовательские заголовки контекста ВЫЗОВА SIP
voipHeaders	object	Пользовательские заголовки контекста вызова VoiP

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