宣布日期 推出日期（错开）
2023 年 5 月 22 日

2024 年 5 月 20 日 - 非欧盟地区 - 已完成

2024 年 9 月 9 日 - 欧盟地区 - 已完成

 

Zendesk 当前为大多数 API 端点提供基于偏移量的分页 (OBP) 和基于游标的分页 (CBP)。与 OBP 相比，CBP 具有许多优势，不久将成为 Zendesk 提供的主要分页方法。为了提供更好、更快的客户体验，我们正采取措施鼓励客户转换为 CBP：首先就是对高偏移量 OBP 请求引入更严格的限制。

此公告回答了以下问题：

  • 有什么变化？
  • Zendesk 为何作出这项更改？
  • 我需要做些什么？

有什么变化？

从 2024 年 5 月 20 日起，前 10,000 条记录（100 页）的 OBP 请求将引发错误消息：“400 错误请求。”要请求提供超过 10,000 条记录的数据集，客户需要转换为 CBP。

少于 10,000 条记录的 OBP 请求和使用 CBP 模型发出的请求都不会受到影响。 

Zendesk 为何作出这项更改？

我们之前的公告建议采用 CBP，并鼓励客户尽快进行转换。

对于客户而言，基于光标分页速度更快、效率更高。它还减轻了 Zendesk 基础设施的压力，提高了稳定性和可靠性。首先，我们将基于偏移量分页功能限制在相对较高的级别，以尽量减小转换对当前 API 使用量的影响。 

我需要做些什么？

Zendesk 强烈建议客户在 2024 年 5 月 20 日之前转换为基于光标分页。如果您不知道哪些整合或应用程序可能超出限制，建议您与负责管理 Zendesk 整合和应用程序的团队合作，调查并确定此更改对您的影响。

Zendesk 将继续提供偏移分页，但在不久的将来会大幅限制页面深度，以鼓励采用高性能的光标分页，缩短请求的响应时间。 

如有问题或需要其他支持，请联系我们。我们很乐于为您提供帮助。您可以通过网络小部件联系我们。

 

为确保所有用户无缝过渡，我们错开了推行时间，欧盟地区帐户更改拟定于三个月后（即 2024 年 9 月 9 日）实施。

 

客户端库/SDK 可用更新

Zendesk 已更新其官方 Ruby 客户端，并与社区 SDK 开发者合作提供 CBP 支持。如果您在使用这些库，请对其进行检查、测试并将其更新到最新版本。

库 有用的说明
Ruby

Zendesk API 客户端

>=3.0.4 支持光标分页

请参阅 Wiki 中的一般用法。
Python

Zen Py

>=v2.0.34 支持光标分页

pip install zenpy --upgrade
Or 
pip install zenpy==2.0.46(latest version as of this writing)
NodeJS

Node Zendesk

>=v3.0.2 支持光标分页。请参阅此处发布标签。

npm update node-zendesk
Java

Zendesk Java 客户端

>= v0.24.1 支持光标分页。请参阅此处发布标签。

使用 Maven
PHP

ZendeskAPI PHP 客户端

>= 3.0.01 支持光标分页

composer require zendesk/zendesk_api_client_php:^3.0.1

请参阅升级指南。
MS BI 连接器

全新优化版 Zendesk 数据连接器现可抓取超过 1000 行的记录，并可使用光标模型加快数据检索。

请参阅迁移指南，了解如何使用最新的连接器。
Go Lang

go-zendesk

>=v0.18.0

请参阅升级指南
C#

ZendeskApiClient

>= 7.0.7 支持光标分页 

请参阅 README 部分，了解如何使用光标分页

 

具有 CBP 功能的端点

产品 端点
工单处理 /api/v2/activities
工单处理 /api/v2/audit_logs
工单处理 /api/v2/automations
工单处理 /api/v2/automations/active
工单处理 /api/v2/brands
工单处理 /api/v2/custom_objects/:custom_object_key/fields
工单处理 /api/v2/custom_objects/:custom_object_key/records
工单处理 /api/v2/custom_objects/:custom_object_key/records/autocomplete
工单处理 /api/v2/custom_objects/:custom_object_key/records/search
工单处理 /api/v2/custom_objects/:custom_object_key/triggers
工单处理 /api/v2/custom_objects/:custom_object_key/triggers/active
工单处理 /api/v2/deleted_tickets
工单处理 /api/v2/deleted_users
工单处理 /api/v2/deletion_schedules
工单处理 /api/v2/dynamic_content/items
工单处理 /api/v2/dynamic_content/items/:item_id/variants
工单处理 /api/v2/end_users/:end_user_id/identities
工单处理 /api/v2/group_memberships
工单处理 /api/v2/group_memberships/assignable
工单处理 /api/v2/groups
工单处理 /api/v2/groups/:group_id/memberships
工单处理 /api/v2/groups/:group_id/memberships/assignable
工单处理 /api/v2/groups/:group_id/users
工单处理 /api/v2/groups/assignable
工单处理 /api/v2/groups/available_agents
工单处理 /api/v2/incremental/ticket_metric_events
工单处理 /api/v2/job_statuses
工单处理 /api/v2/macros
工单处理 /api/v2/macros/active
工单处理 /api/v2/macros/groups
工单处理 /api/v2/organization_fields
工单处理 /api/v2/organization_memberships
工单处理 /api/v2/organization_subscriptions
工单处理 /api/v2/organizations
工单处理 /api/v2/organizations/:organization_id/organization_memberships
工单处理 /api/v2/organizations/:organization_id/requests
工单处理 /api/v2/organizations/:organization_id/subscriptions
工单处理 /api/v2/organizations/:organization_id/tickets
工单处理 /api/v2/organizations/:organization_id/users
工单处理 /api/v2/problems
工单处理 /api/v2/recipient_addresses
工单处理 /api/v2/requests
工单处理 /api/v2/requests/:request_id/comments
工单处理 /api/v2/requests/ccd
工单处理 /api/v2/requests/open
工单处理 /api/v2/requests/solved
工单处理 /api/v2/satisfaction_ratings
工单处理 /api/v2/search/export
工单处理 /api/v2/sessions
工单处理 /api/v2/skips
工单处理 /api/v2/suspended_tickets
工单处理 /api/v2/tags
工单处理 /api/v2/:target_type/:target_id/relationship_fields/:field_id/:source_type
工单处理 /api/v2/ticket_audits
工单处理 /api/v2/ticket_content_pins
工单处理 /api/v2/ticket_fields
工单处理 /api/v2/ticket_fields/:ticket_field_id/options
工单处理 /api/v2/ticket_metrics
工单处理 /api/v2/tickets
工单处理 /api/v2/tickets/:ticket_id/audits
工单处理 /api/v2/tickets/:ticket_id/comments
工单处理 /api/v2/tickets/:ticket_id/incidents
工单处理 /api/v2/tickets/:ticket_id/skips
工单处理 /api/v2/trigger_categories
工单处理 /api/v2/triggers
工单处理 /api/v2/triggers/active
工单处理 /api/v2/user_fields
工单处理 /api/v2/user_fields/:user_field_id/options
工单处理 /api/v2/users
工单处理 /api/v2/users/:user_id/group_memberships
工单处理 /api/v2/users/:user_id/groups
工单处理 /api/v2/users/:user_id/identities
工单处理 /api/v2/users/:user_id/organization_memberships
工单处理 /api/v2/users/:user_id/organization_subscriptions
工单处理 /api/v2/users/:user_id/organizations
工单处理 /api/v2/users/:user_id/requests
工单处理 /api/v2/users/:user_id/sessions
工单处理 /api/v2/users/:user_id/skips
工单处理 /api/v2/users/:user_id/tickets/assigned
工单处理 /api/v2/users/:user_id/tickets/ccd
工单处理 /api/v2/users/:user_id/tickets/requested
工单处理 /api/v2/views
工单处理 /api/v2/views/:id/execute
工单处理 /api/v2/views/:id/tickets

 

 

产品 端点
帮助中心 /hc/api/v2/incremental/articles
帮助中心 /hc/api/v2/articles/attachments/:id
帮助中心 /hc/api/v2/articles/labels
帮助中心 /hc/api/v2/articles/labels/:id
帮助中心 /hc/api/v2/articles/:article_id/translations/missing
帮助中心 /hc/api/v2/articles/:article_id/translations
帮助中心 /hc/api/v2/articles/:article_id/translations/:id
帮助中心 /hc/api/v2/categories/:category_id/translations/missing
帮助中心 /hc/api/v2/categories/:category_id/translations
帮助中心 /hc/api/v2/categories/:category_id/translations/:id
帮助中心 /hc/api/v2/user_segments/applicable
帮助中心 /hc/api/v2/user_segments/:user_segment_id/sections
帮助中心 /hc/api/v2/user_segments/:user_segment_id/topics
帮助中心 /hc/api/v2/user_segments
帮助中心 /hc/api/v2/user_segments/:id
帮助中心 /hc/api/v2/sections/:section_id/translations/missing
帮助中心 /hc/api/v2/sections/:section_id/translations
帮助中心 /hc/api/v2/sections/:section_id/translations/:id
帮助中心 /hc/api/v2(/:locale)/articles/:article_id/attachments/:scope
帮助中心 /hc/api/v2(/:locale)/articles/:article_id/attachments
帮助中心 /hc/api/v2(/:locale)/articles/:article_id/attachments/:id
帮助中心 /hc/api/v2(/:locale)/articles/:article_id/labels
帮助中心 /hc/api/v2(/:locale)/articles/:article_id/comments/:comment_id/votes
帮助中心 /hc/api/v2(/:locale)/articles/:article_id/comments
帮助中心 /hc/api/v2(/:locale)/articles/:article_id/comments/:id
帮助中心 /hc/api/v2(/:locale)/articles/:article_id/votes
帮助中心 /hc/api/v2(/:locale)/articles/:article_id/subscriptions
帮助中心 /hc/api/v2(/:locale)/articles/:article_id/subscriptions/:id
帮助中心 /hc/api/v2(/:locale)/articles
帮助中心 /hc/api/v2(/:locale)/articles/:id
帮助中心 /hc/api/v2(/:locale)/categories/:category_id/articles
帮助中心 /hc/api/v2(/:locale)/categories/:category_id/sections
帮助中心 /hc/api/v2(/:locale)/categories
帮助中心 /hc/api/v2(/:locale)/categories/:id
帮助中心 /hc/api/v2(/:locale)/sections/:section_id/articles
帮助中心 /hc/api/v2(/:locale)/sections/:section_id/subscriptions
帮助中心 /hc/api/v2(/:locale)/sections/:section_id/subscriptions/:id
帮助中心 /hc/api/v2(/:locale)/sections
帮助中心 /hc/api/v2(/:locale)/sections/:id
帮助中心 /hc/api/v2/community/posts/:post_id/comments/:comment_id/votes
帮助中心 /hc/api/v2/community/posts/:post_id/comments
帮助中心 /hc/api/v2/community/posts/:post_id/comments/:id
帮助中心 /hc/api/v2/community/posts/:post_id/subscriptions
帮助中心 /hc/api/v2/community/posts/:post_id/subscriptions/:id
帮助中心 /hc/api/v2/community/posts/:post_id/votes
帮助中心 /hc/api/v2/community/posts
帮助中心 /hc/api/v2/community/posts/:id
帮助中心 /hc/api/v2/community/topics/:topic_id/subscriptions
帮助中心 /hc/api/v2/community/topics/:topic_id/subscriptions/:id
帮助中心 /hc/api/v2/community/topics/:topic_id/posts
帮助中心 /hc/api/v2/community/topics
帮助中心 /hc/api/v2/community/topics/:id
帮助中心 /hc/api/v2/community/users/:user_id/posts
帮助中心 /hc/api/v2/community/users/:user_id/comments
帮助中心 /hc/api/v2/users/:user_id/articles
帮助中心 /hc/api/v2/users/:user_id/subscriptions
帮助中心 /hc/api/v2/users/:user_id/user_subscriptions
帮助中心 /hc/api/v2/users/:user_id/comments
帮助中心 /hc/api/v2/users/:user_id/votes
帮助中心 /hc/api/v2/users/:user_id/user_segments
帮助中心 /hc/api/v2/votes
帮助中心 /hc/api/v2/votes/:id
由 Zendesk 提供技术支持