Call Connection - Get Call

Referenz

Service:: Communication

API Version:: 2023-10-15

Ruft die Detaileigenschaften eines laufenden Aufrufs ab.

GET {endpoint}/calling/callConnections/{callConnectionId}?api-version=2023-10-15

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
callConnectionId	path	True	string	Die Anrufverbindungs-ID.
endpoint	path	True	string url	Der Endpunkt der Azure Communication-Ressource.
api-version	query	True	string	Version der aufzurufenden API.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Ein Azure Communication Services Benutzerzugriffstoken.

Antworten

Name	Typ	Beschreibung
200 OK	CallConnectionProperties	Gibt Details der Aufrufeigenschaften zurück.
Other Status Codes	CommunicationErrorResponse	Fehler

Sicherheit

Authorization

Ein Azure Communication Services Benutzerzugriffstoken.

Type: apiKey
In: header

Beispiele

CallConnection_GetCall

Sample Request

HTTP

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

Sample Response

Status code:: 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"
}

Definitionen

Name	Beschreibung
CallConnectionProperties	Eigenschaften einer Anrufverbindung
CallConnectionStateModel	Der Zustand der Anrufverbindung.

CallConnectionProperties

Eigenschaften einer Anrufverbindung

Name	Typ	Beschreibung
answeredBy	CommunicationUserIdentifierModel
callConnectionId	string	Die Anrufverbindungs-ID.
callConnectionState	CallConnectionStateModel	Der Zustand der Anrufverbindung.
callbackUri	string	Der Rückruf-URI.
correlationId	string	Die Korrelations-ID.
serverCallId	string	Die Serveraufruf-ID.
source	CommunicationIdentifierModel
sourceCallerIdNumber	PhoneNumberIdentifierModel
sourceDisplayName	string	Anzeigename des Anrufs, wenn eine Pstn-Nummer gewählt wird.
targets	CommunicationIdentifierModel[]	Die Ziele des Aufrufs.

CallConnectionStateModel

Der Zustand der Anrufverbindung.

Name	Typ	Beschreibung
connected	string
connecting	string
disconnected	string
disconnecting	string
transferAccepted	string
transferring	string
unknown	string

Freigeben über