Call Connection - Cancel Add Participant

Referência

Serviço:: Communication

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

Cancelar operação de adição de participante.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
callConnectionId	path	True	string	O 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 invocar.

Cabeçalho do Pedido

Name	Necessá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 é repetível; ou seja, que o cliente pode fazer a solicitação várias vezes com o mesmoRequest-Id de repetibilidade e obter de volta uma resposta apropriada sem que o servidor execute a solicitação várias vezes. O valor daRequest-Id Repeatability- é uma cadeia de caracteres opaca que representa um identificador exclusivo gerado pelo cliente para a solicitação. É uma versão 4 (aleatória) UUID.
Repeatability-First-Sent		string date-time-rfc1123	Se o cabeçalho Repeatability-Request-ID for especificado, o cabeçalho Repeatability-First-Sent 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 IMF-fixdate de HTTP-date. Exemplo: Sun, 06 nov 1994 08:49:37 GMT.

Corpo do Pedido

Name	Necessário	Tipo	Description
invitationId	True	string	ID do convite usado para adicionar um participante.
operationCallbackUri		string	Defina um URI de retorno de chamada que substitua o URI de retorno de chamada padrão definido por CreateCall/AnswerCall para esta operação. Esta 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 por clientes ao chamar ações de chamada intermediária para correlacionar a solicitação ao evento de resposta.

Respostas

Name	Tipo	Description
202 Accepted	CancelAddParticipantResponse	Retorna a resposta cancelAddParticipant
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_CancelAddParticipant

Pedido de amostra

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

Resposta da amostra

Código de estado:: 202

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

Definições

Name	Description
CancelAddParticipantRequest	Solicitar carga útil para cancelar adicionar solicitação de participante.
CancelAddParticipantResponse	Carga útil de resposta para cancelar adicionar solicitação de participante.

CancelAddParticipantRequest

Solicitar carga útil para cancelar adicionar solicitação de participante.

Name	Tipo	Description
invitationId	string	ID do convite usado para adicionar um participante.
operationCallbackUri	string	Defina um URI de retorno de chamada que substitua o URI de retorno de chamada padrão definido por CreateCall/AnswerCall para esta operação. Esta 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 por clientes ao chamar ações de chamada intermediária para correlacionar a solicitação ao evento de resposta.

CancelAddParticipantResponse

Carga útil de resposta para cancelar adicionar solicitação de participante.

Name	Tipo	Description
invitationId	string	ID do convite usado para cancelar a ação de adicionar participante.
operationContext	string	O contexto da operação fornecido pelo cliente.

Partilhar via