查询
查询类型 / 操作
查询的第一步是选择操作/查询类型。每个操作/查询类型都代表 Zendesk 中的一个 API。选择操作/查询类型后,必须提供该 API 所需的相关附加信息。
某些 API 需要传递强制参数,它们位于操作选择旁边。如果存在任何可选参数,它们将显示在查询编辑器的可选参数部分。
搜索
搜索允许您在 Zendesk 帐户中搜索工单、用户和组织。
进行搜索请求时,您可以使用 query 参数指定资源类型,例如工单或用户。您还可以指定搜索条件,例如“用户名为 Jane Doe”或“状态为开放的工单”。
要查看完整的搜索参数列表,请参阅 Zendesk 搜索文档。
示例
任务 | 查询 |
---|---|
搜索特定词语 | Grafana |
搜索精确字符串 | "Grafana Labs" |
按 ID 搜索工单 | 3245227 |
搜索资源类型 | type:user "Jane Doe" |
按工单状态搜索 | type:ticket status:open |
按日期搜索 | type:organization created<2099-05-01 |
按 ID 显示工单
此操作允许您通过提供工单 ID 列表来检索多个工单记录。
这将在单个请求中返回最多 100 条工单记录。
参数
名称 | 必需 | 描述 |
---|---|---|
工单 ID | 是 | 工单 ID 列表。 |
显示工单评论
此查询检索与特定工单关联的评论。
参数
名称 | 必需 | 描述 |
---|---|---|
工单 ID | 是 | 工单的 ID。 |
显示已删除工单
此操作返回所有已删除(且尚未归档)工单的列表。
参数
名称 | 必需 | 描述 |
---|---|---|
排序依据 | 否 | 排序依据。允许的值为 id 、subject 或 deleted_at 。 |
排序顺序 | 否 | 排序顺序。默认为 asc 。允许的值为 asc 或 desc 。 |
统计工单数
返回帐户中工单的大致数量。如果数量超过 100,000,则每 24 小时更新一次。
显示所有用户
列出注册到 Zendesk 实例的所有用户。
参数
名称 | 必需 | 描述 |
---|---|---|
角色 | 否 | 按角色过滤结果。可能的值为 end-user 、agent 或 admin 。 |
显示选定用户
此操作按 ID 显示多个用户的信息。
参数
名称 | 必需 | 描述 |
---|---|---|
用户 ID | 是 | 您要查询的用户的 ID。 |