Call Connection - Get Call

Usługa:

Communication

Wersja interfejsu API:

2024-09-15

Uzyskaj szczegółowe właściwości trwającego wywołania.

GET {endpoint}/calling/callConnections/{callConnectionId}?api-version=2024-09-15

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
callConnectionId	path	True	string	Identyfikator połączenia wywołania.
endpoint	path	True	string url	Punkt końcowy zasobu usługi Azure Communication.
api-version	query	True	string	Wersja interfejsu API do wywołania.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Authorization	True	string	Token dostępu użytkownika usług Azure Communication Services.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CallConnectionProperties	Zwraca szczegóły właściwości wywołania.
Other Status Codes	CommunicationErrorResponse	Błąd

Zabezpieczenia

Authorization

Token dostępu użytkownika usług Azure Communication Services.

Typ: apiKey
W: header

Przykłady

CallConnection_GetCall

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
CallConnectionProperties	Właściwości połączenia wywołania
CallConnectionStateModel	Stan połączenia połączenia.

CallConnectionProperties

Właściwości połączenia wywołania

Nazwa	Typ	Opis
answeredBy	CommunicationUserIdentifierModel
answeredFor	PhoneNumberIdentifierModel
callConnectionId	string	Identyfikator połączenia wywołania.
callConnectionState	CallConnectionStateModel	Stan połączenia połączenia.
callbackUri	string	Identyfikator URI wywołania zwrotnego.
correlationId	string	Identyfikator korelacji.
serverCallId	string	Identyfikator wywołania serwera.
source	CommunicationIdentifierModel
sourceCallerIdNumber	PhoneNumberIdentifierModel
sourceDisplayName	string	Nazwa wyświetlana połączenia w przypadku wybierania numeru pstn.
targets	CommunicationIdentifierModel[]	Cele wywołania.

CallConnectionStateModel

Stan połączenia połączenia.

Nazwa	Typ	Opis
connected	string
connecting	string
disconnected	string
disconnecting	string
transferAccepted	string
transferring	string
unknown	string