callRecord: getPstnBlockedUsersLog

命名空间:microsoft.graph.callRecords

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

获取被阻止/取消阻止的用户在 Microsoft Teams 中将公用电话交换网络 (PSTN) 呼叫的日志作为 pstnBlockedUsersLogRow 条目的集合。 该日志包括有关每个被阻止用户的信息,例如他们分配的电话号码,以及阻止/取消阻止他们拨打电话的原因。

此 API 可用于以下国家级云部署

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) 不支持。 不支持。
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用程序 CallRecords.Read.All 不可用。

HTTP 请求

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

函数参数

在请求 URL 中,提供以下查询参数(含值)。

参数 类型 说明
fromDateTime DateTimeOffset 要查询的时间范围的开始时间。 时间戳类型表示采用 ISO 8601 格式的日期和时间信息,始终采用 UTC 时区。 例如,2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。 必需。
toDateTime DateTimeOffset 查询的结束时间范围。 时间戳类型表示采用 ISO 8601 格式的日期和时间信息,始终采用 UTC 时区。 例如,2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。 必需。

重要

fromDateTimetoDateTime 值不能超过 90 天的日期范围。

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权

请求正文

请勿提供此方法的请求正文。

响应

如果成功,此函数在 200 OK 响应正文中返回响应代码和 microsoft.graph.callRecords.pstnBlockedUsersLogRow 条目的集合。

如果函数为指定的日期范围返回超过 1,000 个条目,则正文还将包含一个 @odata.nextLink URL,用于查询下一页条目。 日期范围中的最后一 @odata.nextLink页没有 。 有关详细信息,请参阅 在应用中分页 Microsoft Graph 数据

示例

以下示例演示如何获取在指定日期范围内发生的 PSTN 阻止用户的记录集合。 响应包括 "@odata.count": 1000 枚举第一个响应中的记录数,以及 用于 @odata.nextLink 获取超过前 1,000 条的记录的 。 为了提高可读性,响应对象仅包含两条记录的集合。

请求

以下示例显示了一个请求。

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