Genesys Cloud
即将发布新的使用情况查询服务，扩展数据访问和分页功能

宣布于 生效日期 啊哈！主意
2025-04-21 - -

Genesys Cloud 推出了新的使用情况查询服务，以替代现有的公共 API 使用情况查询服务，从而改善客户访问和与其使用情况数据交互的方式。2025 年 3 月 31 日，您可以使用这项新服务在更广泛的数据集上运行异步查询，而不仅仅是公共 API 使用。新服务支持完整的分页和页面大小控制。

为什么这个改变很重要？

这一变化旨在让客户更好地访问和了解他们的平台使用情况，并支持未来扩展到公共 API 使用之外的其他数据集。以前，公共 API 使用端点应用了严格的过滤器；例如，排除一些系统级组织 ID，并且缺乏分页。 

通过这项新服务，客户将：

  • 更好地控制他们的查询，包括按客户端 ID、平台、用户 ID、HTTP 方法等进行高级过滤。
  • 访问以前隐藏的完整数据（例如，现在包括 purecloud 或 purecloud-builtin 等 OAuth 客户端）。
  • 使用异步查询作业更快、更可靠地接收数据。
  • 对结果进行分页，避免对大型结果集的限制并获得管理输出大小的能力。

局限性

该服务提供的数据包括所有使用活动，而不仅仅是计费数据。客户不应使用此 API 来确定账单。该服务没有定义什么是可计费的，什么是不可计费的。

新的可用端点

  • POST /api/v2/usage/aggregates/query/jobs
  • GET /api/v2/usage/aggregates/query/jobs/{jobId}
  • POST /api/v2/usage/client/{clientId}/aggregates/query/jobs
  • GET /api/v2/usage/client/{clientId}/aggregates/query/jobs/{jobId}

弃用的端点

  • 各种 api/v2/usage/query 和 api/v2/oauth/clients/{clientId}/usage 端点

过渡细节

鼓励客户迁移到新的端点，以获得完整且可定制的使用数据视图。