Call Connection - Transfer To Participant

Referência

Serviço:: Communication

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

Transfira a chamada para um participante.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
callConnectionId	path	True	string	A ID de 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
targetParticipant	True	CommunicationIdentifierModel
customCallingContext		CustomCallingContext	Usado pelo cliente para enviar contexto de chamada personalizado para destinos
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.
sourceCallerIdNumber		PhoneNumberIdentifierModel
transferee		CommunicationIdentifierModel

Respostas

Name	Tipo	Description
202 Accepted	TransferCallResponse	O serviço aceitou o pedido de transferência e começará a processá-lo. Você receberá o evento CallTransferAccepted ou CallTransferFailed 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_TransferToParticipant

Pedido de amostra

HTTP

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

{
  "targetParticipant": {
    "kind": "communicationUser",
    "communicationUser": {
      "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
    }
  },
  "transferee": {
    "kind": "communicationUser",
    "communicationUser": {
      "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538"
    }
  },
  "operationCallbackUri": "https://app.contoso.com/callback",
  "operationContext": "trasferring call"
}

Resposta da amostra

Código de estado:: 202

{
  "operationContext": "trasferring call"
}

Definições

Name	Description
CustomCallingContext	O contexto de chamada personalizado que será enviado para o destino
TransferCallResponse	A carga útil de resposta para transferir a chamada.
TransferToParticipantRequest	A carga útil da solicitação para transferir a chamada para um participante.

CustomCallingContext

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

Name	Tipo	Description
sipHeaders	object	Cabeçalhos SIP de contexto de chamada personalizados
voipHeaders	object	Cabeçalhos VoiP de contexto de chamada personalizados

TransferCallResponse

A carga útil de resposta para transferir a chamada.

Name	Tipo	Description
operationContext	string	O contexto da operação fornecido pelo cliente.

TransferToParticipantRequest

A carga útil da solicitação para transferir a chamada para um participante.

Name	Tipo	Description
customCallingContext	CustomCallingContext	Usado pelo cliente para enviar contexto de chamada personalizado para destinos
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.
sourceCallerIdNumber	PhoneNumberIdentifierModel
targetParticipant	CommunicationIdentifierModel
transferee	CommunicationIdentifierModel

Partilhar via