Answer Call - Answer Call

Referência

Serviço:: Communication

Versão da API:: 2025-05-15

Atenda uma chamada usando IncomingCallContext da grade de eventos.

POST {endpoint}/calling/callConnections:answer?api-version=2025-05-15

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
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
callbackUri	True	string	O uri de retorno de chamada.
incomingCallContext	True	string	O contexto associado à chamada.
answeredBy		CommunicationUserIdentifierModel
callIntelligenceOptions		CallIntelligenceOptions	Opções de IA para a chamada.
mediaStreamingOptions		MediaStreamingOptions: WebSocketMediaStreamingOptions	Opções de streaming de mídia.
operationContext		string	Um valor definido pelo cliente usado para acompanhar o atendimento de uma chamada.
transcriptionOptions		TranscriptionOptions: WebSocketTranscriptionOptions	Opções de transcrição.

Respostas

Name	Tipo	Description
200 OK	CallConnectionProperties	Retorna detalhes das propriedades da chamada assim que a solicitação AnswerCall é recebida pelo serviço. Você receberá o evento CallConnected no URI de retorno de chamada especificado, assim que a chamada for conectada.
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

AnswerCall

Pedido de amostra

HTTP

POST https://contoso.communications.azure.com/calling/callConnections:answer?api-version=2025-05-15

{
  "incomingCallContext": "H4sIAAAAAAAEAMVVS2/bOBD+LzrspaElPiSSBoJFNnvYoNi0aHaBtpcFRQ5t1rIokLRTJ8h/X1J2soHRQ4A9lAdZ4ry+mflm/FhpNQy3PjnrtErOj9XysbLBb8uvM9WyEkul49J2ioEiGhlKADHVKiR7oVDXUGo5tkpa8k8zH9yglhuKuLQNkqLpEMZUNSZLNFfVRWVcnAZ1uFVbyP53EQLOtzCaybsx3ZSgnZFKKk4QgLGIybZFfU8oolIZzFrWGk6yzaDG1U6tYLaBMd9MKiSn3aROjjSRoAUHhG1PEDMdIGFlg4yRUmhChWQsm62dMdl+adUQ4aIKEP0u6KPft6RePV1Uyf/PmmmT5VijnlmMpD7VDLg4r9m4G4azgjWng37weD5nBTt6OS8YlcRyBhpJwD1iggFSbccQJVRJANW1gp4XLCc/uHETS/4qJaXX2dE6pSku61pNbgETMrBfxM1hgsUIqVzWe1Lrqda6iBBpmsXx9ZWW1vUe19aHDZja9pqBMRyBpQyxriVIgNBIGa11D9wy2tWE1Q7np6iPOH51lyXtLRinrsZ4D6FwQmdY28LEKfhV7nX8+XCfkZwAB/gGOv18WEccJ1A7M/0V1BgnHwq0/JmBYSoWEi84XTC+pIyLuszCXPBrPyYY0zPTsv57OBSOxJxoXjXzV3WzJs1D/+X22gy/36m762/vhk8PV5eXOWAm5gZKqDZ5/PCdc2L/vvmjbynGh3fhPus8lVIZFzLI7PBj8BNkOsPMRBc/nURXw+DvIbM7hR3MJnmWdNE6Itt7p2Gr3HAHKblxVcyfsp724x5CnPfizbh36WVDvpaUNIMfhplbb+1Xtp87hhfPr687lq/qB4HD9ec1vN98+OzhQ9Rfp26zKq34BS47ygVtBZdNS3AjMCnb0MU/d0NyH/NEH15WmYu/BZ+7q2L6b1oN9LvVS3se5z+B4w6lWIOSHOl5+rmiSJoOI9b0jZZATMPUD7bsm5ZGjrsKfjfNcb+faPH0LyoNW7KCBgAA",
  "callbackUri": "https://app.contoso.com/callback",
  "operationContext": "operationContext",
  "callIntelligenceOptions": {
    "cognitiveServicesEndpoint": "string"
  },
  "answeredBy": {
    "id": "+11234567890"
  },
  "mediaStreamingOptions": {
    "audioChannelType": "mixed",
    "transportUrl": "string",
    "transportType": "websocket",
    "contentType": "audio",
    "startMediaStreaming": true,
    "enableBidirectional": true,
    "audioFormat": "pcm16KMono"
  },
  "transcriptionOptions": {
    "locale": "en-US",
    "transportUrl": "string",
    "transportType": "websocket",
    "speechModelEndpointId": "string",
    "startTranscription": true,
    "enableIntermediateResults": true
  }
}

Resposta da amostra

Código de estado:: 200

{
  "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
  "serverCallId": "aHR0cHM6Ly9jb252ZXJzYXRpb251cmwvdGVzdA",
  "sourceCallerIdNumber": {
    "value": "+18440123456"
  },
  "source": {
    "kind": "communicationUser",
    "communicationUser": {
      "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
    }
  },
  "targets": [
    {
      "kind": "communicationUser",
      "communicationUser": {
        "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_0f50d091-5bd3-448b-884d-44be7037d9b9"
      }
    }
  ],
  "callConnectionState": "connected",
  "callbackUri": "https://app.contoso.com/callback",
  "mediaStreamingSubscription": {
    "id": "23dea47f-b081-4107-9a5c-4300819d2caa",
    "state": "active",
    "subscribedContentTypes": [
      "audio"
    ]
  },
  "transcriptionSubscription": {
    "id": "45dea47f-b081-4107-9a5c-4300819d2caa",
    "state": "active",
    "subscribedResultTypes": [
      "final"
    ]
  },
  "answeredFor": {
    "value": "+11234567890"
  }
}

Definições

Name	Description
AnswerCallRequest	A carga útil da solicitação para atender a chamada.
AudioFormat	O formato de áudio usado para codificação, incluindo taxa de amostragem e tipo de canal. O padrão é Pcm16KMono.
CallConnectionProperties	Propriedades de uma conexão de chamada
CallConnectionStateModel	O estado da conexão de chamada.
CallIntelligenceOptions	Opções de IA para a chamada.
MediaStreamingAudioChannelType	O tipo de canal de áudio para transmitir, por exemplo, áudio não misturado, áudio misto.
MediaStreamingContentType
MediaStreamingSubscription	Objeto de assinatura de streaming de mídia.
MediaStreamingSubscriptionState	Estado da assinatura de streaming de mídia.
StreamingTransportType	Define o tipo de transporte usado para streaming. Observe que podem ser introduzidos valores futuros que não estão documentados no momento.
TranscriptionResultType
TranscriptionSubscription	Objeto de assinatura de transcrição.
TranscriptionSubscriptionState	Estado da subscrição de transcrição.
WebSocketMediaStreamingOptions	Representa as opções para transporte WebSocket.
WebSocketTranscriptionOptions	Representa as opções para transporte WebSocket.

AnswerCallRequest

Object

A carga útil da solicitação para atender a chamada.

Name	Tipo	Description
answeredBy	CommunicationUserIdentifierModel
callIntelligenceOptions	CallIntelligenceOptions	Opções de IA para a chamada.
callbackUri	string	O uri de retorno de chamada.
incomingCallContext	string	O contexto associado à chamada.
mediaStreamingOptions	MediaStreamingOptions: WebSocketMediaStreamingOptions	Opções de streaming de mídia.
operationContext	string	Um valor definido pelo cliente usado para acompanhar o atendimento de uma chamada.
transcriptionOptions	TranscriptionOptions: WebSocketTranscriptionOptions	Opções de transcrição.

AudioFormat

Enumeração

O formato de áudio usado para codificação, incluindo taxa de amostragem e tipo de canal. O padrão é Pcm16KMono.

Valor	Description
pcm16KMono
pcm24KMono

CallConnectionProperties

Object

Propriedades de uma conexão de chamada

Name	Tipo	Description
answeredBy	CommunicationUserIdentifierModel
answeredFor	PhoneNumberIdentifierModel
callConnectionId	string	A ID de conexão de chamada.
callConnectionState	CallConnectionStateModel	O estado da conexão de chamada.
callbackUri	string	O URI de retorno de chamada.
correlationId	string	O ID de correlação.
mediaStreamingSubscription	MediaStreamingSubscription	O estado da assinatura de streaming de mídia para a chamada
serverCallId	string	O ID de chamada do servidor.
source	CommunicationIdentifierModel
sourceCallerIdNumber	PhoneNumberIdentifierModel
sourceDisplayName	string	Exibir o nome da chamada se estiver discando para um número pstn.
targets	CommunicationIdentifierModel[]	Os alvos da chamada.
transcriptionSubscription	TranscriptionSubscription	Subscrição de transcrição.

CallConnectionStateModel

Enumeração

O estado da conexão de chamada.

Valor	Description
connected
connecting
disconnected
disconnecting
transferAccepted
transferring
unknown

CallIntelligenceOptions

Object

Opções de IA para a chamada.

Name	Tipo	Description
cognitiveServicesEndpoint	string	O identificador do recurso do Serviço Cognitivo atribuído a esta chamada.

MediaStreamingAudioChannelType

Enumeração

O tipo de canal de áudio para transmitir, por exemplo, áudio não misturado, áudio misto.

Valor	Description
mixed
unmixed

MediaStreamingContentType

Enumeração

Valor	Description
audio

MediaStreamingSubscription

Object

Objeto de assinatura de streaming de mídia.

Name	Tipo	Description
id	string	ID da subscrição.
state	MediaStreamingSubscriptionState	Estado da assinatura de streaming de mídia.
subscribedContentTypes	MediaStreamingContentType[]	Tipos de conteúdo de streaming de mídia assinado.

MediaStreamingSubscriptionState

Enumeração

Estado da assinatura de streaming de mídia.

Valor	Description
active
disabled
inactive

StreamingTransportType

Enumeração

Define o tipo de transporte usado para streaming. Observe que podem ser introduzidos valores futuros que não estão documentados no momento.

Valor	Description
websocket

TranscriptionResultType

Enumeração

Valor	Description
final
intermediate

TranscriptionSubscription

Object

Objeto de assinatura de transcrição.

Name	Tipo	Description
id	string	ID da subscrição.
locale	string	Especifica a localidade usada para transcrição, por exemplo, en-CA ou en-AU.
state	TranscriptionSubscriptionState	Estado da subscrição de transcrição.
subscribedResultTypes	TranscriptionResultType[]	Tipos de resultados de transcrição subscritos.

TranscriptionSubscriptionState

Enumeração

Estado da subscrição de transcrição.

Valor	Description
active
disabled
inactive

WebSocketMediaStreamingOptions

Object

Representa as opções para transporte WebSocket.

Name	Tipo	Description
audioChannelType	MediaStreamingAudioChannelType	O tipo de canal de áudio para transmitir, por exemplo, áudio não misturado, áudio misto.
audioFormat	AudioFormat	O formato de áudio usado para codificação, incluindo taxa de amostragem e tipo de canal. O padrão é Pcm16KMono.
contentType	MediaStreamingContentType
enableBidirectional	boolean	Um valor que indica se o streaming bidirecional está habilitado.
enableDtmfTones	boolean	Um valor que indica se os tons DTMF devem ser transmitidos.
startMediaStreaming	boolean	Um valor que indica se o streaming de mídia deve começar imediatamente após a chamada ser atendida.
transportType	string: websocket	Define o tipo de transporte usado para streaming. Observe que podem ser introduzidos valores futuros que não estão documentados no momento.
transportUrl	string	A URL de transporte para streaming de mídia.

WebSocketTranscriptionOptions

Object

Representa as opções para transporte WebSocket.

Name	Tipo	Description
enableIntermediateResults	boolean	Permite resultados intermediários para a fala transcrita.
locale	string	Especifica a localidade usada para transcrição, por exemplo, en-CA ou en-AU.
speechModelEndpointId	string	A ID do modelo personalizado implantado no formato GUID. O GUID é gerado pelo Azure Speech Studio, por exemplo, a259c255-1cdw-4ed7-a693-dd58563b6f6a.
startTranscription	boolean	Indica se a transcrição deve começar imediatamente após a chamada ser atendida.
transportType	string: websocket	Define o tipo de transporte usado para streaming. Observe que podem ser introduzidos valores futuros que não estão documentados no momento.
transportUrl	string	O URL usado para o transporte de transcrição ao vivo.

Partilhar via

Answer Call - Answer Call

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

Authorization

Exemplos

AnswerCall

Pedido de amostra

Resposta da amostra

Definições

AnswerCallRequest

AudioFormat

CallConnectionProperties

CallConnectionStateModel

CallIntelligenceOptions

MediaStreamingAudioChannelType

MediaStreamingContentType

MediaStreamingSubscription

MediaStreamingSubscriptionState

StreamingTransportType

TranscriptionResultType

TranscriptionSubscription

TranscriptionSubscriptionState

WebSocketMediaStreamingOptions

WebSocketTranscriptionOptions