Call Connection - Get Call

Referência

Serviço:: Communication

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

Obtenha as propriedades de detalhes de uma chamada em andamento.

GET {endpoint}/calling/callConnections/{callConnectionId}?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.

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=2024-09-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.

CallConnectionProperties

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	A ID de correlação.
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.

CallConnectionStateModel

O estado da conexão de chamada.

Nome	Tipo	Description
connected	string
connecting	string
disconnected	string
disconnecting	string
transferAccepted	string
transferring	string
unknown	string

Compartilhar via