callRecord: getPstnCalls

名前空間: microsoft.graph.callRecords

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

この 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.nextLink、最初の 1,000 を超えるレコードを取得することが含まれます"@odata.count": 1000。 読みやすくするために、応答には 1 つのレコードのコレクションのみが表示されます。 その日付範囲に 1,000 を超える呼び出しがあると仮定してください。

要求

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

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

応答

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

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

HTTP/1.1 200 OK

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.callRecords.pstnCallLogRow)",
    "@odata.count": 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"
        }
    ],
    "@odata.nextLink": "https://graph.microsoft.com/v1.0/communications/callRecords/getPstnCalls(from=2019-11-01,to=2019-12-01)?$skip=1000"
}