callRecord: getPstnBlockedUsersLog
名前空間: microsoft.graph.callRecords
重要
Microsoft Graph の /beta
バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
pstnBlockedUsersLogRow エントリのコレクションとして、Microsoft Teams で公衆交換電話網 (PSTN) 通話を行うことをブロックまたはブロック解除されたユーザーのログを取得します。 ログには、割り当てられた電話番号や、通話がブロックまたはブロック解除された理由など、ブロックされた各ユーザーに関する情報が含まれます。
この API は、次の国内クラウド展開で使用できます。
グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
---|---|---|---|
✅ | ✅ | ✅ | ❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください。
アクセス許可の種類 | 最小特権アクセス許可 | 特権の高いアクセス許可 |
---|---|---|
委任 (職場または学校のアカウント) | サポートされていません。 | サポートされていません。 |
委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
アプリケーション | CallRecords.Read.All | 注意事項なし。 |
HTTP 要求
GET /communications/callRecords/getPstnBlockedUsersLog(fromDateTime={fromDateTime},toDateTime={toDateTime})
関数パラメーター
要求 URL で、次のクエリ パラメーターに値を指定します。
パラメーター | 型 | 説明 |
---|---|---|
fromDateTime | DateTimeOffset | クエリを実行する時間範囲の開始。 Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時間です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 必須です。 |
toDateTime | DateTimeOffset | クエリを実行する時間の範囲の終了。 Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時間です。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 必須です。 |
重要
fromDateTime と toDateTime の値は、90 日の日付範囲を超えることはできません。
要求ヘッダー
名前 | 説明 |
---|---|
Authorization | ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。 |
要求本文
このメソッドには、要求本文を指定しません。
応答
成功した場合、この関数は応答コードと、応答本文の microsoft.graph.callRecords.pstnBlockedUsersLogRow エントリのコレクションを返200 OK
します。
指定した日付範囲に対して 1,000 を超えるエントリが返される場合、本文には、エントリの次のページを照会する URL を含む も含まれます @odata.nextLink
。 日付範囲の最後のページには @odata.nextLink
、 がありません。 詳細については、「 アプリでの Microsoft Graph データのページング」を参照してください。
例
次の例は、指定した日付範囲で発生した PSTN ブロックされたユーザーのレコードのコレクションを取得する方法を示しています。 応答には、最初の応答のレコード数を列挙し@odata.nextLink
、最初の 1,000 を超えるレコードを取得する が含まれます"@odata.count": 1000
。 読みやすくするために、応答オブジェクトには 2 つのレコードのコレクションのみが含まれます。
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/beta/communications/callRecords/getPstnBlockedUsersLog(fromDateTime=2022-11-01,toDateTime=2022-12-01)
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.callRecords.pstnBlockedUsersLogRow)",
"@odata.count": 1000,
"@odata.nextLink": "https://graph.microsoft.com/beta/communications/callRecords/getPstnBlockedUsersLog(fromDateTime=2022-11-01,toDateTime=2022-12-01)?$skip=1000",
"value": [
{
"userId": "76efb13c-64ba-4305-9149-4e8f854004a9",
"userPrincipalName": "andre.lawson@contoso.com",
"userDisplayName": "Andre Lawson",
"blockDateTime": "2022-11-23T13:51:09.796Z",
"userTelephoneNumber": "+37212345678",
"userBlockMode": "Blocked",
"blockReason": "High Overall Usage",
"remediationId": "c98e1515-a937-4b81-b8a8-3992afde64e0",
},
{
"userId": "76efb13c-64ba-4305-9149-4e8f854004a9",
"userPrincipalName": "ruwini.perera@contoso.com",
"userDisplayName": "Ruwini Perera",
"blockDateTime": "2022-11-23T13:51:09.796Z",
"userTelephoneNumber": "+37212345678",
"userBlockMode": "Unblocked",
"blockReason": "Tenant Requested",
"remediationId": "c98e1515-a937-4b81-b8a8-3992afde64e0",
}
]
}