次の方法で共有

callRecord: getPstnCalls

  • [アーティクル]

名前空間: microsoft.graph.callRecords

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

pstnCallLogRow エントリのコレクションとして PSTN 呼び出しのログを取得します。

注:

この API は、 Telstra または ソフトバンク 通話プランの情報を返しません。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ✅ ✅ ❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) サポートされていません。 サポートされていません。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション CallRecords.Read.All 注意事項なし。

HTTP 要求

GET /communications/callRecords/getPstnCalls(fromDateTime={fromDateTime},toDateTime={toDateTime})

関数パラメーター

要求 URL で、次のクエリ パラメーターに値を指定します。 次の表に、この関数で使用できるパラメーターを示します。

パラメーター 型 説明
fromDateTime DateTimeOffset クエリを実行する時間範囲の開始。 UTC (包括的)。
時間範囲は、呼び出しの開始時刻に基づいています。
toDateTime DateTimeOffset クエリを実行する時間の範囲の終了。 UTC (包括的)。

重要

fromDateTime および toDateTime の値は、90 日の日付範囲を超えることはできません。

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。

応答

成功した場合、この関数は応答コード 200 OK と応答本文の pstnCallLogRow エントリのコレクションを返します。

日付範囲に 1,000 を超えるエントリがある場合、本文には、呼び出しエントリの次のページを照会するための URL を含む @odata.nextLink も含まれます。 日付範囲の最後のページに @odata.nextLinkがありません。 詳細については、「 アプリでの Microsoft Graph データのページング」を参照してください。

例

次の例は、指定した日付範囲で発生した PSTN 呼び出しのレコードのコレクションを取得する方法を示しています。 応答には、この最初の応答のレコード数を列挙する "@odata.count": 1000 と、最初の 1,000 を超えるレコードを取得するための @odata.nextLink が含まれます。 読みやすくするために、応答には 1 つのレコードのコレクションのみが表示されます。 その日付範囲に 1,000 を超える呼び出しがあるとします。

要求

次の例は要求を示しています。

GET https://graph.microsoft.com/beta/communications/callRecords/getPstnCalls(fromDateTime=2019-11-01,toDateTime=2019-12-01)

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 200 OK

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.callRecords.pstnCallLogRow)",
    "@odata.count": 1000,
    "@odata.nextLink": "https://graph.microsoft.com/beta/communications/callRecords/getPstnCalls(from=2019-11-01,to=2019-12-01)?$skip=1000",
    "value": [
        {
            "id": "9c4984c7-6c3c-427d-a30c-bd0b2eacee90",
            "callId": "1835317186_112562680@61.221.3.176",
            "userId": "db03c14b-06eb-4189-939b-7cbf3a20ba27",
            "userPrincipalName": "richard.malk@contoso.com",
            "userDisplayName": "Richard Malk",
            "startDateTime": "2019-11-01T00:00:08.2589935Z",
            "endDateTime": "2019-11-01T00:03:47.2589935Z",
            "duration": 219,
            "charge": 0.00,
            "callType": "user_in",
            "currency": "USD",
            "calleeNumber": "+1234567890",
            "usageCountryCode": "US",
            "tenantCountryCode": "US",
            "connectionCharge": 0.00,
            "callerNumber": "+0123456789",
            "destinationContext": null,
            "destinationName": "United States",
            "conferenceId": null,
            "licenseCapability": "MCOPSTNU",
            "inventoryType": "Subscriber",
            "operator": "Microsoft",
            "callDurationSource": "microsoft",
            "otherPartyCountryCode": "US",
            "clientPublicIpV4Address": "99.76.33.16",
            "clientPublicIpV6Address": "1234:fd2:5621:1:89::4500",
            "clientLocalIpV4Address": "192.168.1.165",
            "clientLocalIpV6Address": "2600:1700:1dca:8110::40",
            "administrativeUnitInfos": [
               {
                  "id": "639b616c-f164-4a6f-a933-24936b8eb210"
               },
               {
                  "id": "cc6ea167-4e92-4c2d-9391-85791e978006"
               }
            ]
        }
    ]
}

関連コンテンツ