Call Connection - Get Call

サービス:

Communication

API バージョン:

2024-09-15

進行中の呼び出しの詳細プロパティを取得します。

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

URI パラメーター

名前	/	必須	型	説明
callConnectionId	path	True	string	呼び出し接続 ID。
endpoint	path	True	string url	Azure Communication リソースのエンドポイント。
api-version	query	True	string	呼び出す API のバージョン。

要求ヘッダー

名前	必須	型	説明
Authorization	True	string	Azure Communication Services ユーザー アクセス トークン。

応答

名前	型	説明
200 OK	CallConnectionProperties	呼び出しプロパティの詳細を返します。
Other Status Codes	CommunicationErrorResponse	エラー

セキュリティ

Authorization

Azure Communication Services ユーザー アクセス トークン。

型: apiKey
/: header

例

CallConnection_GetCall

要求のサンプル

HTTP

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

応答のサンプル

状態コード:

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

定義

名前	説明
CallConnectionProperties	呼び出し接続のプロパティ
CallConnectionStateModel	呼び出し接続の状態。

CallConnectionProperties

呼び出し接続のプロパティ

名前	型	説明
answeredBy	CommunicationUserIdentifierModel
answeredFor	PhoneNumberIdentifierModel
callConnectionId	string	呼び出し接続 ID。
callConnectionState	CallConnectionStateModel	呼び出し接続の状態。
callbackUri	string	コールバック URI。
correlationId	string	関連付け ID。
serverCallId	string	サーバー呼び出し ID。
source	CommunicationIdentifierModel
sourceCallerIdNumber	PhoneNumberIdentifierModel
sourceDisplayName	string	pstn 番号にダイヤルアウトする場合の通話の表示名。
targets	CommunicationIdentifierModel[]	呼び出しのターゲット。

CallConnectionStateModel

呼び出し接続の状態。

名前	型	説明
connected	string
connecting	string
disconnected	string
disconnecting	string
transferAccepted	string
transferring	string
unknown	string