Call Connection - Get Call

Serviço:

Communication

Versão da API:

2025-05-15

Obtenha as propriedades de detalhes de uma chamada em andamento.

GET {endpoint}/calling/callConnections/{callConnectionId}?api-version=2025-05-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.

Respostas

Nome	Tipo	Description
200 OK	CallConnectionProperties	Retorna detalhes das propriedades da chamada.
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_GetCall

Solicitação de exemplo

HTTP

GET https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c?api-version=2025-05-15

Resposta de exemplo

Código de status:

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"
      }
    },
    {
      "kind": "phoneNumber",
      "phoneNumber": {
        "value": "+14250123456"
      }
    }
  ],
  "callConnectionState": "connected",
  "callbackUri": "https://app.contoso.com/callback"
}

Definições

Nome	Description
CallConnectionProperties	Propriedades de uma conexão de chamada
CallConnectionStateModel	O estado da conexão de chamada.
MediaStreamingContentType
MediaStreamingSubscription	Objeto de assinatura de streaming de mídia.
MediaStreamingSubscriptionState	Estado da assinatura de streaming de mídia.
TranscriptionResultType
TranscriptionSubscription	Objeto de assinatura de transcrição.
TranscriptionSubscriptionState	Estado da assinatura de transcrição.

CallConnectionProperties

Objeto

Propriedades de uma conexão de chamada

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

CallConnectionStateModel

Enumeração

O estado da conexão de chamada.

Valor	Description
unknown
connecting
connected
transferring
transferAccepted
disconnecting
disconnected

MediaStreamingContentType

Enumeração

Valor	Description
audio

MediaStreamingSubscription

Objeto

Objeto de assinatura de streaming de mídia.

Nome	Tipo	Description
id	string	ID da assinatura.
state	MediaStreamingSubscriptionState	Estado da assinatura de streaming de mídia.
subscribedContentTypes	MediaStreamingContentType[]	Tipos de conteúdo de streaming de mídia inscritos.

MediaStreamingSubscriptionState

Enumeração

Estado da assinatura de streaming de mídia.

Valor	Description
disabled
inactive
active

TranscriptionResultType

Enumeração

Valor	Description
final
intermediate

TranscriptionSubscription

Objeto

Objeto de assinatura de transcrição.

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

TranscriptionSubscriptionState

Enumeração

Estado da assinatura de transcrição.

Valor	Description
disabled
inactive
active