Call Connection - Add Participant

Referência

Serviço:: Communication

Versão da API:: 2024-09-15

Adicione um participante à chamada.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
callConnectionId	path	True	string	A ID da conexão de chamada
endpoint	path	True	string url	O ponto de extremidade do recurso de Comunicação do Azure.
api-version	query	True	string	Versão da API a ser invocada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	True	string	Um token de acesso de usuário dos Serviços de Comunicação do Azure.
Repeatability-Request-ID		string uuid	Se especificado, o cliente direciona que a solicitação seja repetível; ou seja, que o cliente pode fazer a solicitação várias vezes com a mesma RepetiçãoRequest-Id e obter uma resposta apropriada sem que o servidor execute a solicitação várias vezes. O valor daRequest-Id de Repetição é uma cadeia de caracteres opaca que representa um identificador exclusivo gerado pelo cliente para a solicitação. É uma UUID versão 4 (aleatória).
Repeatability-First-Sent		string date-time-rfc1123	Se o cabeçalho repeatability-Request-ID for especificado, o cabeçalhoFirst-Sent de repetição também deverá ser especificado. O valor deve ser a data e a hora em que a solicitação foi criada pela primeira vez, expressa usando a forma fixada pelo FMI de data HTTP. Exemplo: Dom, 06 Nov 1994 08:49:37 GMT.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
participantToAdd	True	CommunicationIdentifierModel
customCallingContext		CustomCallingContext	Usado pelo cliente para enviar contexto de chamada personalizado para destinos
invitationTimeoutInSeconds		integer	Obtém ou define o tempo limite para aguardar a retirada do participante convidado. O valor máximo disso é de 180 segundos
operationCallbackUri		string	Defina um URI de retorno de chamada que substitui o URI de retorno de chamada padrão definido por CreateCall/AnswerCall para esta operação. Essa configuração é por ação. Se isso não estiver definido, o URI de retorno de chamada padrão definido por CreateCall/AnswerCall será usado.
operationContext		string	Usado pelos clientes ao chamar ações de chamada intermediária para correlacionar a solicitação ao evento de resposta.
sourceCallerIdNumber		PhoneNumberIdentifierModel
sourceDisplayName		string	(Opcional) O nome de exibição da origem associada a essa operação de convite ao adicionar um participante PSTN ou um usuário do teams. Observação: não atualizará o nome de exibição na lista.

Respostas

Nome	Tipo	Description
202 Accepted	AddParticipantResponse	O serviço aceitou a solicitação adicionar participante e começará a processá-la. Você receberá o evento AddParticipantSucceeded ou AddParticipantFailed no URI de retorno de chamada especificado para atualizá-lo sobre o status da solicitação.
Other Status Codes	CommunicationErrorResponse	Erro

Segurança

Authorization

Um token de acesso de usuário dos Serviços de Comunicação do Azure.

Tipo: apiKey
Em: header

Exemplos

CallConnection_AddParticipant

Solicitação de exemplo

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"
}

Resposta de exemplo

Código de status:: 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"
}

Definições

Nome	Description
AddParticipantRequest	O conteúdo da solicitação para adicionar participante à chamada.
AddParticipantResponse	O conteúdo da resposta para adicionar participantes à chamada.
CallParticipant	Um participante da chamada.
CustomCallingContext	O contexto de chamada personalizado que será enviado para o destino

AddParticipantRequest

O conteúdo da solicitação para adicionar participante à chamada.

Nome	Tipo	Description
customCallingContext	CustomCallingContext	Usado pelo cliente para enviar contexto de chamada personalizado para destinos
invitationTimeoutInSeconds	integer	Obtém ou define o tempo limite para aguardar a retirada do participante convidado. O valor máximo disso é de 180 segundos
operationCallbackUri	string	Defina um URI de retorno de chamada que substitui o URI de retorno de chamada padrão definido por CreateCall/AnswerCall para esta operação. Essa configuração é por ação. Se isso não estiver definido, o URI de retorno de chamada padrão definido por CreateCall/AnswerCall será usado.
operationContext	string	Usado pelos clientes ao chamar ações de chamada intermediária para correlacionar a solicitação ao evento de resposta.
participantToAdd	CommunicationIdentifierModel
sourceCallerIdNumber	PhoneNumberIdentifierModel
sourceDisplayName	string	(Opcional) O nome de exibição da origem associada a essa operação de convite ao adicionar um participante PSTN ou um usuário do teams. Observação: não atualizará o nome de exibição na lista.

AddParticipantResponse

O conteúdo da resposta para adicionar participantes à chamada.

Nome	Tipo	Description
invitationId	string	ID de convite usada para adicionar um participante.
operationContext	string	O contexto de operação fornecido pelo cliente.
participant	CallParticipant	Lista de participantes atuais na chamada.

CallParticipant

Um participante da chamada.

Nome	Tipo	Description
identifier	CommunicationIdentifierModel
isMuted	boolean	O participante está mudo
isOnHold	boolean	É participante em espera.

CustomCallingContext

O contexto de chamada personalizado que será enviado para o destino

Nome	Tipo	Description
sipHeaders	object	Cabeçalhos SIP de contexto de chamada personalizada
voipHeaders	object	Cabeçalhos VoiP de contexto de chamada personalizada

Compartilhar via