票
票证是最终用户(客户)与Zendesk Support中的代理进行通信的手段。亚博门票可以来自许多渠道，包括电子邮件、帮助中心、聊天、电话、Twitter、Facebook或API。所有门票都有一组核心属性。
门票及要求
亚博Zendesk有一个ticket API和一个Requests API。一个票是代理人对一张票的看法。一个请求是最终用户对票据的看法。最终用户只能看到票据的公开评论和某些字段。因此，请使用请求API让最终用户查看、更新和创建票据。使用本文档其余部分中描述的Tickets API让代理和管理员管理票据。
请求者和提交者
每个票据都有一个请求者和提交者。通过票据请求支持的用户是请求者。对于大多数使用Zendesk Support的企业来说，请亚博求者是客户，但请求者也可以是Zendesk Support实例中的代理。
提交者是创建票据的用户。默认情况下，票据的请求者是提交者。例如，如果您的客户向您的支持地址发送电子邮件，这将创建一个票据，客户同时作为请求者和提交者。请求者也将作为票据第一个注释的作者出现。
但是，支持代理也可以代表客户创建票据。如果代理通过web界面创建票据，则将代理设置为提交者。可以通过API通过将代理的用户ID传递为submitter_id在创建票据时。在这种情况下，作为提交者的代理成为了票据的第一个注释的作者，并且票据显示代理“代表”客户创建了票据。
提交者总是第一个注释作者
在上面的描述中，我们看到票证的第一个注释作者可以根据创建票证的人而有所不同。在这两个示例中，提交者都将成为第一个注释作者。这将适用于Zendesk支持中创建的所有票证，只有一个例外。亚博
例外:如果票据是作为后续票据创建的(即，如果票据是使用via_followup_source_id)，然后是submitter_id属性被忽略。API将创建后续票据的人(对于API，始终是经过身份验证的用户)设置为第一个注释作者。
描述和第一条评论
创建票据时，使用评论属性设置票据描述，这也是第一个注释。例子:
｛“票”：｛“主题”：“我的打印机着火了!”，“评论”：｛“身体”：“烟的颜色很鲜艳。”｝｝｝
重要的:不要使用描述属性设置第一个注释。该属性仅用于读取。虽然可以使用属性来设置第一个注释，但该功能有局限性，并且提供该功能是为了支持现有的实现。
组和受让人
Zendesk Sup亚博port中的票据可以传递给一组未分配的代理，也可以传递给特定组中的特定代理。一张票一次只能分配给一个受让人。
合作者
除了请求者之外，票据还可以包括在其通信中的其他人，称为合作者或抄送人。当门票更新时，合作者会收到电子邮件通知。合作者可以是最终用户，也可以是代理人。
状态(遗留)和自定义票据状态
在自定义票证状态之前，Zendesk支持中的所有票证都以“新”开始，并通过打开、等待、等待(亚博仅限订阅)、解决和关闭状态进行进展。
自定义机票状态必须属于五个机票状态类别之一，这些类别由现有的五个遗留机票状态组成:
- 新
- 开放
- 等待
- 收藏
- 解决了
对于遗留状态为“关闭”的票据，Zendesk自动化将使用属于“已解决”状态类别的自定义票据状态。亚博
由于票据对象仅包含custom_status_id属性，附带加载custom_statuses在GET请求中为代理或最终用户提取人类可读的标签。例子:
GET / api / v2 / tickets.json吗?包括= custom_statuses回应:｛“票”:{“id”:35436年,“custom_status_id”:123年,“状态”:“开放”,.．.}，“custom_statuses”:(｛“id”:123年,“status_category”:“开放”,“agent_label”:“开放”,“end_user_label”:“开放”,.．.｝］｝
JSON格式
票据被表示为具有以下属性的JSON对象:
| 的名字 | 类型 | 只读 | 强制性的 | 描述 |
|---|---|---|---|---|
| allow_attachments | 布尔 | 真正的 | 假 | 代理向注释添加附件的权限。默认为true |
| allow_channelback | 布尔 | 真正的 | 假 | 如果禁用channelback则为false，否则为true。只适用于频道框架票务 |
| assignee_email | 字符串 | 假 | 假 | 只写。要将票分配到的代理的电子邮件地址 |
| assignee_id | 整数 | 假 | 假 | 当前分配给票据的代理 |
| attribute_value_ids | 数组 | 假 | 假 | 只写。与票据相关联的属性值的id数组 |
| brand_id | 整数 | 假 | 假 | 企业只有。此票所关联的品牌的id |
| collaborator_ids | 数组 | 假 | 假 | 目前抄送到票上的用户id |
| 合作者 | 数组 | 假 | 假 | 仅POST请求。用户在创建票据时添加为抄送。看到设置的合作者 |
| 评论 | 对象 | 假 | 假 | 只写。向票据添加注释的对象。看到票的评论．若要在注释中包含附件，请参见附加文件 |
| created_at | 字符串 | 真正的 | 假 | 当创建此记录时 |
| custom_fields | 数组 | 假 | 假 | 票证的自定义字段。看到设置自定义字段值 |
| custom_status_id | 整数 | 假 | 假 | 票据的自定义票据状态id |
| 描述 | 字符串 | 真正的 | 假 | 票上的只读第一个注释。当创建票据,使用评论设置描述信息。看到描述和第一条评论 |
| due_at | 字符串 | 假 | 假 | 如果这是一张类型为“task”的票据，那么它就有一个到期日。到期日期格式使用ISO 8601格式。 |
| email_cc_ids | 数组 | 假 | 假 | 目前抄送到票上的代理或最终用户的id。看到cc和关注者资源亚博电脑端在支持帮助中心 |
| email_ccs | 对象 | 假 | 假 | 只写。一个对象数组，表示代理或最终用户通过电子邮件向cc发送邮件，以便从票据中添加或删除。看到设置邮件cc |
| external_id | 字符串 | 假 | 假 | 可用于将Zendesk Support票据链接到本地亚博记录的id |
| follower_ids | 数组 | 假 | 假 | 当前跟随票据的代理的id。看到cc和关注者资源亚博电脑端 |
| 追随者 | 对象 | 假 | 假 | 只写。表示要从票据中添加或删除的代理关注者的对象数组。看到设置的追随者 |
| followup_ids | 数组 | 真正的 | 假 | 从此票据创建的后续操作的id。id只有在门票关闭时才可见 |
| forum_topic_id | 整数 | 真正的 | 假 | 此票据起源于Zendesk Web亚博门户中的主题(如果有的话)。Web门户已弃用 |
| group_id | 整数 | 假 | 假 | 此票分配给的组 |
| has_incidents | 布尔 | 真正的 | 假 | 如果罚单是问题类型，并且有一个或多个事件与之关联，则为true。否则，该值为false。 |
| id | 整数 | 真正的 | 假 | 在创建票据时自动分配 |
| is_public | 布尔 | 真正的 | 假 | 如果任何评论是公开的，则为真，否则为假 |
| macro_id | 整数 | 假 | 假 | 只写。票据审计中要记录的宏ID |
| macro_ids | 数组 | 假 | 假 | 仅POST请求。票证审核中要记录的宏id列表 |
| 元数据 | 对象 | 假 | 假 | 只写。审计的元数据。在审计对象中指定的数据自定义的属性元数据对象。看到设置元数据 |
| organization_id | 整数 | 假 | 假 | 请求者的组织。您只能指定与请求者关联的组织的ID。看到组织会员 |
| 优先级 | 字符串 | 假 | 假 | 处理这张罚单的紧迫性。取值范围为“紧急”、“高”、“正常”、“低”。 |
| problem_id | 整数 | 假 | 假 | 对于类型为“incident”的票据，表示事件所链接到的问题的ID |
| raw_subject | 字符串 | 假 | 假 | 动态内容占位符(如果存在)，或者“主题”值(如果不存在)。看到动态内容项 |
| 收件人 | 字符串 | 假 | 假 | 票的原始收件人电子邮件地址。票的通知邮件从这个地址发送 |
| 请求者 | 对象 | 假 | 假 | 只写。看到用一个新的请求者创建一个票据 |
| requester_id | 整数 | 假 | 真正的 | 请求此票据的用户 |
| safe_update | 布尔 | 假 | 假 | 只写。可选布尔。防止使用过期的票据数据进行更新(updated_stamp为true时要求的属性)。看到防止票证更新冲突 |
| satisfaction_rating | 对象 | 真正的 | 假 | 票的满意等级，如果存在，或满意状态，“提供”或“未提供”。对于不支持CSAT的计划类型，该值为空 |
| sharing_agreement_ids | 数组 | 真正的 | 假 | 用于此票据的共享协议的id |
| 状态 | 字符串 | 假 | 假 | 票的状态。允许的值为“new”、“open”、“pending”、“hold”、“solved”或“closed”。 |
| 主题 | 字符串 | 假 | 假 | 此票据的主题字段的值 |
| submitter_id | 整数 | 假 | 假 | 提交票据的用户。提交者总是成为票据上第一个注释的作者 |
| 标签 | 数组 | 假 | 假 | 应用于此票据的标记数组 |
| ticket_form_id | 整数 | 假 | 假 | 企业只有。为获取机票而呈现的机票表单的id |
| 类型 | 字符串 | 假 | 假 | 这张票的类型。允许取值为problem, incident, question, task。 |
| updated_at | 字符串 | 真正的 | 假 | 这条记录上次更新的时候 |
| updated_stamp | 字符串 | 假 | 假 | 只写。从API接收的最后一次更新的日期时间。看到safe_update财产 |
| url | 字符串 | 真正的 | 假 | 此票据的API url |
| 通过 | 对象 | 假 | 假 | 有关更多信息，请参见通过对象引用 |
| via_followup_source_id | 整数 | 假 | 假 | 仅POST请求。创建后续票据时关闭票据的id。看到创建后续票据 |
| via_id | 整数 | 假 | 假 | 只写。有关更多信息，请参见通过对象引用 |
| voice_comment | 对象 | 假 | 假 | 只写。看到创建语音留言票据 |
你也可以包括一个comment_count属性在GET请求返回的JSON对象中通过侧加载它。例子:
GET / api / v2 / tickets.json吗?包括= comment_count
例子
｛“assignee_id”：235323，“collaborator_ids”：［35334，234］，“created_at”：“2009 - 07 - 20 - t22:55:29z”，“custom_fields”：［｛“id”：27642，“价值”：“745”｝，｛“id”：27648，“价值”：“是的”｝］，“custom_status_id”：123，“描述”：“火是五颜六色的。”，“due_at”：零，“external_id”：“ahg35h3jh”，“follower_ids”：［35334，234］，“group_id”：98738，“has_incidents”：假，“id”：35436，“organization_id”：509974，“优先”：“高”，“problem_id”：9873764，“raw_subject”：“{{dc.printer_on_fire}}”，“接收方”：＂(电子邮件保护)＂，“requester_id”：20978392，“satisfaction_rating”：｛“评论”：“伟大的支持!”，“id”：1234，“分数”：“好”｝，“sharing_agreement_ids”：［84432］，“状态”：“开放”，“主题”：“救命，我的打印机着火了!”，“submitter_id”：76872，“标签”：［“企业”，“other_tag”］，“类型”：“事件”，“updated_at”：“2011 - 05 - 05 - t10:38:52z”，“url”：“https://company.亚博zendesk.com/api/v2/tickets/35436.json”，“通过”：｛“通道”：“网络”｝｝
票列表
GET / api / v2 /票GET / api / v2 /组织/ {organization_id} /票GET / api / v2 /用户/ {user_id} /票/要求GET / api / v2 /用户/ {user_id} /票/ ccdGET / api / v2 /用户/ {user_id} /票/跟踪GET / api / v2 /用户/ {user_id} /票/分配拿到票/ api / v2 / /最近
ccd列出被抄送给指定用户的票据。
之后列出指定用户正在关注的票证。
最近列出请求代理最近在代理界面中查看的票据，而不是最近创建或更新的票据(除非由代理最近在代理界面中创建)。
要获取帐户中所有门票的列表，请使用增量票证导出，基于游标或增量票导出，基于时间端点。
有关更多筛选器选项，请使用搜索API．
您也可以附带相关的记录与门票。看到侧载．
响应中不包括存档的票据。看到关于存档门票在支持帮助中心。
如果一个受门票限制的代理人向api / v2 /票端点，端点只返回代理可以访问的票据。有关受门票限制的代理人的信息，请参见创建自定义角色并分配代理．此外，受限制的代理人的要求包括最多10,000张票，如果代理人是一个CC或追随者．
允许
- 代理
分页
- 游标分页(推荐)
- 抵消分页
看到分页．
每页最多返回100条记录。
排序
默认情况下，票据按id从小到大排序。
当使用游标分页时，使用以下参数更改排序顺序:
| 的名字 | 类型 | 要求 | 评论 |
|---|---|---|---|
排序 |
字符串 | 没有 | 取值为“updated_at”，“id”，“status”，从高到低依次为“-updated_at”，“-id”，“status”。 |
当使用偏移分页时，使用以下参数来更改排序顺序:
| 的名字 | 类型 | 要求 | 评论 |
|---|---|---|---|
sort_by |
字符串 | 没有 | 取值为“assignee”，“assigne .name”，“created_at”，“group”，“id”，“locale”，“requester”，“request .name”，“status”，“subject”，“updated_at” |
sort_order |
字符串 | 没有 | 之一asc，desc．默认为asc |
当按创建日期排序时，列出的第一张票可能不是您帐户中最古老的票，原因是票存档．
的查询参数对此端点不支持。使用搜索API缩小你的结果查询．
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| external_id | 字符串 | 查询 | 假 | 根据外部id列出票据。外部id不必对每张票都是唯一的。因此，请求可能返回多个具有相同外部id的票据。 |
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/tickets.json＼- v - u｛email_address｝：｛密码｝
示例响应(年代)
200好了
// Status 200 OK｛“门票”：［｛“assignee_id”：235323，“collaborator_ids”：［35334，234］，“created_at”：“2009 - 07 - 20 - t22:55:29z”，“custom_fields”：［｛“id”：27642，“价值”：“745”｝，｛“id”：27648，“价值”：“是的”｝］，“custom_status_id”：123，“描述”：“火是五颜六色的。”，“due_at”：零，“external_id”：“ahg35h3jh”，“follower_ids”：［35334，234］，“group_id”：98738，“has_incidents”：假，“id”：35436，“organization_id”：509974，“优先”：“高”，“problem_id”：9873764，“raw_subject”：“{{dc.printer_on_fire}}”，“接收方”：＂(电子邮件保护)＂，“requester_id”：20978392，“satisfaction_rating”：｛“评论”：“伟大的支持!”，“id”：1234，“分数”：“好”｝，“sharing_agreement_ids”：［84432］，“状态”：“开放”，“主题”：“救命，我的打印机着火了!”，“submitter_id”：76872，“标签”：［“企业”，“other_tag”］，“类型”：“事件”，“updated_at”：“2011 - 05 - 05 - t10:38:52z”，“url”：“https://company.亚博zendesk.com/api/v2/tickets/35436.json”，“通过”：｛“通道”：“网络”｝｝］｝
数票
拿到票/ api / v2 / /计数GET / api / v2 /组织/ {organization_id} /票/计数GET / api / v2 /用户/ {user_id} /票/ ccd /计数GET / api / v2 /用户/ {user_id} /票/分配/计数
返回帐户中票证的大致数量。如果计数超过100,000，则每24小时更新一次。
ccd列出被抄送给指定用户的票据。
的数(refreshed_at)属性是一个时间戳，该时间戳指示上次更新计数的时间。
请注意:当计数超过100,000时，数(refreshed_at)可能偶尔为空。这表明计数正在后台更新，并且数(价值)在更新完成之前，限制为100,000。
允许
- 代理
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/tickets/count.json＼- v - u｛email_address｝：｛密码｝
示例响应(年代)
200好了
// Status 200 OK｛“数”：｛“refreshed_at”：“2020 - 04 - 06 - t02:18:17z”，“价值”：102｝｝
演出门票
拿到票/ api / v2 / / {ticket_id}
返回一些票证属性，但不返回票证注释。要获得评论，请使用评论列表
允许
- 代理
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| ticket_id | 整数 | 路径 | 真正的 | 机票的ID |
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/tickets/｛ticket_id｝. json＼- v - u｛email_address｝：｛密码｝
示例响应(年代)
200好了
// Status 200 OK｛“票”：｛“assignee_id”：235323，“collaborator_ids”：［35334，234］，“created_at”：“2009 - 07 - 20 - t22:55:29z”，“custom_fields”：［｛“id”：27642，“价值”：“745”｝，｛“id”：27648，“价值”：“是的”｝］，“custom_status_id”：123，“描述”：“火是五颜六色的。”，“due_at”：零，“external_id”：“ahg35h3jh”，“follower_ids”：［35334，234］，“group_id”：98738，“has_incidents”：假，“id”：35436，“organization_id”：509974，“优先”：“高”，“problem_id”：9873764，“raw_subject”：“{{dc.printer_on_fire}}”，“接收方”：＂(电子邮件保护)＂，“requester_id”：20978392，“satisfaction_rating”：｛“评论”：“伟大的支持!”，“id”：1234，“分数”：“好”｝，“sharing_agreement_ids”：［84432］，“状态”：“开放”，“主题”：“救命，我的打印机着火了!”，“submitter_id”：76872，“标签”：［“企业”，“other_tag”］，“类型”：“事件”，“updated_at”：“2011 - 05 - 05 - t10:38:52z”，“url”：“https://company.亚博zendesk.com/api/v2/tickets/35436.json”，“通过”：｛“通道”：“网络”｝｝｝
出示多张票
拿到票/ api / v2 / / show_many吗?id = {id}
接受要返回的以逗号分隔的票据id列表。
这个端点将返回最多100条票据记录。
允许
- 代理
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| id | 字符串 | 查询 | 真正的 | 以逗号分隔的票据id列表 |
旋度
旋度https://｛子域名｝i亚博ds .zendesk.com/api/v2/tickets/show_many.json吗?＝1、2，3＼- v - u｛email_address｝：｛密码｝
示例响应(年代)
200好了
// Status 200 OK｛“门票”：［｛“assignee_id”：235323，“collaborator_ids”：［35334，234］，“created_at”：“2009 - 07 - 20 - t22:55:29z”，“custom_fields”：［｛“id”：27642，“价值”：“745”｝，｛“id”：27648，“价值”：“是的”｝］，“custom_status_id”：123，“描述”：“火是五颜六色的。”，“due_at”：零，“external_id”：“ahg35h3jh”，“follower_ids”：［35334，234］，“group_id”：98738，“has_incidents”：假，“id”：35436，“organization_id”：509974，“优先”：“高”，“problem_id”：9873764，“raw_subject”：“{{dc.printer_on_fire}}”，“接收方”：＂(电子邮件保护)＂，“requester_id”：20978392，“satisfaction_rating”：｛“评论”：“伟大的支持!”，“id”：1234，“分数”：“好”｝，“sharing_agreement_ids”：［84432］，“状态”：“开放”，“主题”：“救命，我的打印机着火了!”，“submitter_id”：76872，“标签”：［“企业”，“other_tag”］，“类型”：“事件”，“updated_at”：“2011 - 05 - 05 - t10:38:52z”，“url”：“https://company.亚博zendesk.com/api/v2/tickets/35436.json”，“通过”：｛“通道”：“网络”｝｝］｝
创建机票
POST / api / v2 /票
需要一个票对象，该对象指定票据属性。唯一需要的属性是评论．看到票的评论．中列出的所有可写属性JSON格式是可选的。
要在注释中提交带有HTML数据的票据，请使用html_body而不是身体在你的请求中。如果使用，HTML数据将从请求中剥离身体．
一个审计对象在创建或更新票据时生成并包含在响应中。的审计对象具有事件数组，列出对新票据进行的所有更新。有关更多信息，请参见票审核．的元数据中添加自己的元数据审计对象。看到设置元数据．
有关创建票据的更多信息，请参见:
允许
- 代理
例子的身体
｛“票”：｛“评论”：｛“身体”：“烟的颜色很鲜艳。”｝，“优先”：“紧急”，“主题”：“我的打印机着火了!”｝｝
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/tickets.json＼- d“{“票”:{“主题”:“我的打印机着火了!”，“评论”:{“身体”:“烟很鲜艳。””}}}＼- h“application / json内容类型:- v - u｛email_address｝：｛密码｝- x的帖子
示例响应(年代)
201年创建
//状态201已创建｛“票”：｛“assignee_id”：235323，“collaborator_ids”：［35334，234］，“created_at”：“2009 - 07 - 20 - t22:55:29z”，“custom_fields”：［｛“id”：27642，“价值”：“745”｝，｛“id”：27648，“价值”：“是的”｝］，“custom_status_id”：123，“描述”：“火是五颜六色的。”，“due_at”：零，“external_id”：“ahg35h3jh”，“follower_ids”：［35334，234］，“group_id”：98738，“has_incidents”：假，“id”：35436，“organization_id”：509974，“优先”：“高”，“problem_id”：9873764，“raw_subject”：“{{dc.printer_on_fire}}”，“接收方”：＂(电子邮件保护)＂，“requester_id”：20978392，“satisfaction_rating”：｛“评论”：“伟大的支持!”，“id”：1234，“分数”：“好”｝，“sharing_agreement_ids”：［84432］，“状态”：“开放”，“主题”：“救命，我的打印机着火了!”，“submitter_id”：76872，“标签”：［“企业”，“other_tag”］，“类型”：“事件”，“updated_at”：“2011 - 05 - 05 - t10:38:52z”，“url”：“https://company.亚博zendesk.com/api/v2/tickets/35436.json”，“通过”：｛“通道”：“网络”｝｝｝
制作许多门票
POST / api / v2 /票/ create_many
接受最多100个票据对象的数组。请注意:使用此端点创建的每个票据都可能受到业务规则的影响，其中可能包括向最终用户发送电子邮件通知。如果要导入历史票据或创建超过1000个票据，请考虑使用批量进口端点。
这个端点返回一个job_statusJSON对象并排队后台作业来完成工作。使用显示作业状态端点来检查作业是否完成。
允许
- 代理
例子的身体
｛“门票”：［｛“评论”：｛“身体”：“烟的颜色很鲜艳。”｝，“优先”：“紧急”，“主题”：“我的打印机着火了!”｝，｛“评论”：｛“身体”：“这是一个评论”｝，“优先”：“正常”，“主题”：“帮助”｝］｝
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/tickets/create_many.json＼- d“{“票”:[{“主题”:“我的打印机着火了!”，“评论”:{“身体”:“烟很鲜艳。”}},{“主题”:“救命!”,“评论”:{“身体”:“帮助我需要有人。”}}]}”＼- h“application / json内容类型:- v - u｛email_address｝：｛密码｝- x的帖子
示例响应(年代)
200好了
// Status 200 OK｛“job_status”：｛“id”：“82 de0b044094f0c67893ac9fe64f1a99”，“消息”：“完成于2018-03-08 10:07:04 +0000”，“进步”：2，“结果”：［｛“行动”：“更新”，“id”：244，“状态”：“更新”，“成功”：真正的｝，｛“行动”：“更新”，“id”：245，“状态”：“更新”，“成功”：真正的｝］，“状态”：“完成”，“总”：2，“url”：“https://example.亚博zendesk.com/api/v2/job_statuses/82de0b0467893ac9fe64f1a99.json”｝｝
更新票
把/ api / v2 /票/ {ticket_id}
PUT请求需要一个票对象，该对象列出要更新的值。所有属性都是可选的。
另请参阅防止票证更新冲突．
审计事件
一个审计对象在更新票据时生成并包含在响应中。看到审计事件．
允许
- 代理
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| ticket_id | 整数 | 路径 | 真正的 | 机票的ID |
例子的身体
｛“票”：｛“评论”：｛“身体”：“感谢您选择Acme Jet Motors。”，“公共”：真正的｝，“custom_status_id”：321，“状态”：“解决”｝｝
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/tickets/｛ticket_id｝. json＼- h“application / json内容类型:＼- d“{"ticket": {"status": "open"， "custom_status_id": 123， "comment": {" body": "The smoke is very colour ."， "author_id": 494820284}}}}”＼- v - u｛email_address｝：｛密码｝- x将
示例响应(年代)
200好了
// Status 200 OK｛“审计”：｛“事件”：［｛“field_name”：“主题”，“id”：206091192546，“类型”：“创造”，“价值”：“我的打印机着火了!”｝，｛“身体”：“烟的颜色很鲜艳。”，“id”：206091192547，“类型”：“评论”｝，｛“field_name”：“状态”，“id”：206091192548，“类型”：“创造”，“价值”：“开放”｝，｛“field_name”：“custom_status_id”，“id”：206091192549，“类型”：“创造”，“价值”：123｝］｝，“票”：｛“custom_status_id”：123，“id”：35436，“requester_id”：123453，“状态”：“开放”，“主题”：“我的打印机着火了!”｝｝
更新许多机票
把/ api / v2 /票/ update_many
接受最多100个票据对象的数组，或以逗号分隔的最多100个票据id的列表。
这个端点返回一个job_statusJSON对象并排队后台作业来完成工作。使用显示作业状态端点来检查作业是否完成。
批量和批量更新是自动安全的，当作业启动后对相同票据进行另一次更新时，会失败。看到防止票证更新冲突．
批量更新
要对多个票据进行相同的更改，请使用以下端点和数据格式:
https://{子域名}.zendes亚博k.com/api/v2/tickets/update_many.json ? id = 1, 2, 3
｛“票”：｛“状态”：“解决”｝｝
批量更新
要对多个票据进行不同的更改，请使用以下端点和数据格式:
https://{子域名}.zendes亚博k.com/api/v2/tickets/update_many.json
｛“门票”：［｛“id”：1，“状态”：“解决”｝，｛“id”：2，“状态”：“等待”｝］｝
更新标签列表
您可以使用批量更新格式向每个票据的标记列表中添加或删除标记，而无需覆盖现有的标记。要做到这一点，请包含additional_tags或remove_tags的财产票对象。例子:
旋度https://｛子域名｝i亚博ds .zendesk.com/api/v2/tickets/update_many.json吗?＝1、2，3＼- d”{“票”:{“additional_tags”:[" a_new_tag "]}}”＼- h“application / json内容类型:＼- v - u｛email_address｝：｛密码｝- x将
的additional_tags或remove_tags属性仅适用于批量更新，而不适用于批量更新。
允许
- 代理
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| id | 字符串 | 查询 | 假 | 以逗号分隔的票据id列表 |
旋度
批量更新
旋度https://｛子域名｝i亚博ds .zendesk.com/api/v2/tickets/update_many.json吗?＝1、2，3＼- h“application / json内容类型:＼- v - u｛email_address｝：｛密码｝- x将＼- d“{“票”:{“状态”:“已解决”}}”
旋度
批量更新
旋度https://｛子域名｝.亚博zendesk.com/api/v2/tickets/update_many.json＼- h“application / json内容类型:＼- v - u｛email_address｝：｛密码｝- x将＼- d{“门票”:[{" id ": 1、“状态”:"解决"},{" id ": 2,“状态”:“等待”}]}”
示例响应(年代)
200好了
// Status 200 OK｛“job_status”：｛“id”：“82 de0b044094f0c67893ac9fe64f1a99”，“消息”：“完成于2018-03-08 10:07:04 +0000”，“进步”：2，“结果”：［｛“行动”：“更新”，“id”：244，“状态”：“更新”，“成功”：真正的｝，｛“行动”：“更新”，“id”：245，“状态”：“更新”，“成功”：真正的｝］，“状态”：“完成”，“总”：2，“url”：“https://example.亚博zendesk.com/api/v2/job_statuses/82de0b0467893ac9fe64f1a99.json”｝｝
将票据标记为垃圾邮件并暂停请求者
把/ api / v2 /票/ {ticket_id} / mark_as_spam
允许
- 代理
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| ticket_id | 整数 | 路径 | 真正的 | 机票的ID |
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/tickets/｛ticket_id｝/ mark_as_spam.json＼- v - u｛email_address｝：｛密码｝-X PUT -d“{}”
示例响应(年代)
200好了
// Status 200 OK零
批量标记票为垃圾邮件
把/ api / v2 / / mark_many_as_spam票吗?id = {id}
接受以逗号分隔的最多100个票据id的列表。
这个端点返回一个job_statusJSON对象并排队后台作业来完成工作。使用显示作业状态端点来检查作业是否完成
允许
- 代理
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| id | 字符串 | 查询 | 真正的 | 以逗号分隔的票据id列表 |
旋度
旋度https://｛子域名｝i亚博ds .zendesk.com/api/v2/tickets/mark_many_as_spam.json吗?＝1、2，3＼- v - u｛email_address｝：｛密码｝-X PUT -d“{}”- h“application / json内容类型:
示例响应(年代)
200好了
// Status 200 OK｛“job_status”：｛“id”：“82 de0b044094f0c67893ac9fe64f1a99”，“消息”：“完成于2018-03-08 10:07:04 +0000”，“进步”：2，“结果”：［｛“行动”：“更新”，“id”：244，“状态”：“更新”，“成功”：真正的｝，｛“行动”：“更新”，“id”：245，“状态”：“更新”，“成功”：真正的｝］，“状态”：“完成”，“总”：2，“url”：“https://example.亚博zendesk.com/api/v2/job_statuses/82de0b0467893ac9fe64f1a99.json”｝｝
将票合并为目标票
POST / api / v2 /票/ {ticket_id} /合并
将一个或多个票据合并到具有指定id的票据中。
看到合并的票在支持帮助中心查看票据合并规则。
源票据的任何附件都被复制到目标票据。
这个端点返回一个job_statusJSON对象并排队后台作业来完成工作。使用显示作业状态端点来检查作业是否完成。
允许
- 代理
企业帐户中的代理必须具有合并权限。看到创建自定义角色并分配代理(企业)在支持帮助中心。
可用参数
该请求接受一个具有以下属性的数据对象:
| 的名字 | 类型 | 要求 | 评论 |
|---|---|---|---|
| id | 数组 | 是的 | 要合并到目标票中的票的id |
| target_comment | 字符串 | 没有 | 要添加到目标票据的私人评论 |
| source_comment | 字符串 | 没有 | 要添加到源票据的私有注释 |
| target_comment_is_public | 布尔 | 没有 | 目标票中的评论是公开的还是私有的 |
| source_comment_is_public | 布尔 | 没有 | 源票中的注释是公共的还是私有的 |
注释是可选的，但强烈推荐。
注释是私有的，在以下情况下不能修改:
- 任何源或目标票都是私有的
- 任何来源或目标票都是通过Twitter、Facebook或Channel框架创建的
在任何其他情况下，注释默认为私有，但可以使用注释隐私参数进行修改。
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| ticket_id | 整数 | 路径 | 真正的 | 机票的ID |
例子的身体
｛“id”：［123，456，789］，“source_comment”：“接近支持111号”，“target_comment”：“结合#123，#456，#789”｝
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/tickets/｛ticket_id｝/ merge.json＼- v - u｛email_address｝：｛密码｝- x的帖子＼- d'{"ids": [123, 456, 789]， "source_comment": "关闭在支持#111"，"target_comment": "结合#123，#456，#789"}'＼- h“application / json内容类型:
示例响应(年代)
200好了
// Status 200 OK｛“job_status”：｛“id”：“82 de0b044094f0c67893ac9fe64f1a99”，“消息”：“完成于2018-03-08 10:07:04 +0000”，“进步”：2，“结果”：［｛“行动”：“更新”，“id”：244，“状态”：“更新”，“成功”：真正的｝，｛“行动”：“更新”，“id”：245，“状态”：“更新”，“成功”：真正的｝］，“状态”：“完成”，“总”：2，“url”：“https://example.亚博zendesk.com/api/v2/job_statuses/82de0b0467893ac9fe64f1a99.json”｝｝
机票相关信息
拿到票/ api / v2 / / {ticket_id} /相关
该请求返回一个具有以下属性的数据对象:
| 的名字 | 类型 | 评论 |
|---|---|---|
| topic_id | 字符串 | Web门户中的相关主题(已弃用功能) |
| followup_source_ids | 数组 | 跟进的来源 |
| from_archive | 布尔 | 如果当前票证已存档，则为true |
| 事件 | 整数 | 有关事故发生次数的统计 |
| 推特 | 对象 | 与门票相关的Twitter信息 |
允许
- 代理
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| ticket_id | 整数 | 路径 | 真正的 | 机票的ID |
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/tickets/｛ticket_id｝/ related.json＼- v - u｛email_address｝：｛密码｝
示例响应(年代)
200好了
// Status 200 OK｛“followup_source_ids”：［］，“from_archive”：假，“事件”：7，“topic_id”：零，“推特”：｛“直接”：假，“handle_id”：10，“配置文件”：｛“created_at”："2013/01/08 23:24:49 -0800"，“描述”：“亚博Zendesk是领先的……”｝｝｝
删除的机票
删除/ api / v2 /票/ {ticket_id}
允许
- 管理员
- 代理商有权删除机票
在“支持”中设置代理删除权限。看到删除门票在支持帮助中心。
删票率限制
使用此端点，每1分钟可以删除400张票据。速率限制机制的行为描述为速度限制在API介绍中。亚博Zendesk建议您遵守Retry-After头值。要删除很多票，你可以使用批量删除票．
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| ticket_id | 整数 | 路径 | 真正的 | 机票的ID |
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/tickets/｛ticket_id｝. json＼- v - u｛email_address｝：｛密码｝- x删除
示例响应(年代)
204无内容
//状态204无内容零
批量删除票
删除/ api / v2 / / destroy_many票吗?id = {id}
接受以逗号分隔的最多100个票据id的列表。
允许
- 管理员
- 代理商有权删除机票
在“支持”中设置代理删除权限。看到删除门票在支持帮助中心。
这个端点返回一个job_statusJSON对象并排队后台作业来完成工作。使用显示作业状态端点来检查作业是否完成
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| id | 字符串 | 查询 | 真正的 | 以逗号分隔的票据id列表 |
旋度
旋度https://｛子域名｝i亚博ds .zendesk.com/api/v2/tickets/destroy_many.json吗?＝1、2，3＼- v - u｛email_address｝：｛密码｝- x删除
示例响应(年代)
200好了
// Status 200 OK｛“job_status”：｛“id”：“82 de0b044094f0c67893ac9fe64f1a99”，“消息”：“完成于2018-03-08 10:07:04 +0000”，“进步”：2，“结果”：［｛“行动”：“更新”，“id”：244，“状态”：“更新”，“成功”：真正的｝，｛“行动”：“更新”，“id”：245，“状态”：“更新”，“成功”：真正的｝］，“状态”：“完成”，“总”：2，“url”：“https://example.亚博zendesk.com/api/v2/job_statuses/82de0b0467893ac9fe64f1a99.json”｝｝
列出已删除的票据
GET / api / v2 / deleted_tickets
每页最多返回100个已删除的票据。看到分页．
结果包括所有已删除(且尚未存档)的票擦洗在过去30天内。存档的门票不包括在结果中。看到关于存档门票在支持帮助中心。
门票按创建日期按时间顺序排列，从最老的到最新的。列出的第一张票可能不是您帐户中最古老的票，因为票存档．
分页
- 游标分页(推荐)
- 抵消分页
看到分页．
每页最多返回100条记录。
允许
- 代理
速率限制
您可以使用此端点每1分钟发出10个请求。当请求超过第100页时，每1分钟可以发出5个请求。速率限制机制的行为描述为监视请求活动在API介绍中。
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| sort_by | 字符串 | 查询 | 假 | 排序。取值为id、subject、deleted_at。 |
| sort_order | 字符串 | 查询 | 假 | 排序顺序。默认为“asc”。允许取值为asc或desc。 |
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/deleted_tickets.json＼- v - u｛email_address｝：｛密码｝
示例响应(年代)
200好了
// Status 200 OK｛“数”：1，“deleted_tickets”：［｛“演员”：｛“id”：3946，“名称”：”小胡子袋熊”｝，“deleted_at”：“20140704 t15:37:04z”，“id”：581，“previous_state”：“开放”，“主题”：“袋熊党”｝］，“next_page”：零，“previous_page”：零｝
恢复以前删除的票据
把/ api / v2 / deleted_tickets / {ticket_id} /恢复
允许
- 代理
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| ticket_id | 整数 | 路径 | 真正的 | 机票的ID |
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/deleted_tickets/｛id｝/ restore.json-X PUT -v -u｛email_address｝：｛密码｝
示例响应(年代)
200好了
// Status 200 OK零
批量恢复以前删除的票据
把/ api / v2 / deleted_tickets / restore_many吗?id = {id}
允许
- 代理
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| id | 字符串 | 查询 | 真正的 | 以逗号分隔的票据id列表 |
旋度
旋度https://｛子域名｝i亚博ds .zendesk.com/api/v2/deleted_tickets/restore_many吗?＝｛id｝. json-X PUT -v -u｛email_address｝：｛密码｝
示例响应(年代)
200好了
// Status 200 OK零
永久删除票据
删除/ api / v2 / deleted_tickets / {ticket_id}
永久删除软删除的票据。看到软删除在Zendes亚博k的GDPR文件中。要软删除票据，请使用删除的机票端点。
该端点对票据删除作业进行排队，并返回带有作业状态的有效负载。
如果作业成功，票据将被永久删除。此操作无法撤消。
这个端点返回一个job_statusJSON对象并排队后台作业来完成工作。使用显示作业状态端点来检查作业是否完成。
允许
- 代理
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| ticket_id | 整数 | 路径 | 真正的 | 机票的ID |
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/deleted_tickets/｛id｝. json＼-X DELETE -v -u｛email_address｝：｛密码｝
示例响应(年代)
200好了
// Status 200 OK｛“job_status”：｛“id”：“82 de0b044094f0c67893ac9fe64f1a99”，“消息”：零，“进步”：零，“结果”：零，“状态”：“排队”，“总”：零，“url”：“https://example.亚博zendesk.com/api/v2/job_statuses/82de0b0467893ac9fe64f1a99.json”｝｝
永久删除多个票据
删除/ api / v2 / deleted_tickets / destroy_many吗?id = {id}
永久删除最多100个软删除票据。看到软删除在Zendes亚博k的GDPR文件中。软删除票据，使用批量删除票端点。
这个端点接受一个由逗号分隔的最多100个票据id的列表。它对票据删除作业进行排队，并返回带有作业状态的有效负载。
如果一个票据删除失败，端点仍然尝试删除其他票据。如果作业成功，成功删除的票据将被永久删除。此操作无法撤消。
这个端点返回一个job_statusJSON对象并排队后台作业来完成工作。使用显示作业状态端点来检查作业是否完成。
允许
- 代理
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| id | 字符串 | 查询 | 真正的 | 以逗号分隔的票据id列表 |
旋度
旋度https://｛子域名｝i亚博ds .zendesk.com/api/v2/deleted_tickets/destroy_many.json吗?＝1、2，3＼-X DELETE -v -u｛email_address｝：｛密码｝
示例响应(年代)
200好了
// Status 200 OK｛“job_status”：｛“id”：“82 de0b044094f0c67893ac9fe64f1a99”，“消息”：零，“进步”：零，“结果”：零，“状态”：“排队”，“总”：零，“url”：“https://example.亚博zendesk.com/api/v2/job_statuses/82de0b0467893ac9fe64f1a99.json”｝｝
为一张罚单列出合作者
拿到票/ api / v2 / / {ticket_id} /合作者
允许
- 代理
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| ticket_id | 整数 | 路径 | 真正的 | 机票的ID |
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/tickets/｛ticket_id｝/ collaborators.json＼- v - u｛email_address｝：｛密码｝
示例响应(年代)
200好了
// Status 200 OK｛“用户”：［｛“id”：223443，“名称”：“约翰尼代理”｝，｛“id”：8678530，“名称”：“彼得管理”｝］｝
列出一张票的追随者
拿到票/ api / v2 / / {ticket_id} /追随者
返回遵循该票据的任何用户。
可用性
的cc和追随者该特性必须在Zendesk Support中启用。亚博
允许
- 代理
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| ticket_id | 整数 | 路径 | 真正的 | 机票的ID |
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/tickets/｛ticket_id｝/ followers.json＼- v - u｛email_address｝：｛密码｝
示例响应(年代)
200好了
// Status 200 OK｛“用户”：［｛“id”：223443，“名称”：“约翰尼代理”｝，｛“id”：8678530，“名称”：“彼得管理”｝］｝
列出机票的电子邮件cc
拿到票/ api / v2 / / {ticket_id} / email_ccs
返回在票据上抄送的所有用户。
可用性
的cc和追随者该特性必须在Zendesk Support中启用。亚博
如果没有启用该特性，则使用默认的CC功能。在这种情况下，使用列表的合作者在票上抄送的用户名单。
允许
- 代理
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| ticket_id | 整数 | 路径 | 真正的 | 机票的ID |
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/tickets/｛ticket_id｝/ email_ccs.json＼- v - u｛email_address｝：｛密码｝
示例响应(年代)
200好了
// Status 200 OK｛“用户”：［｛“id”：“223443”，“名称”：“约翰尼代理”｝，｛“id”：“8678530”，“名称”：“彼得管理”｝，｛“id”：“6748530”，“名称”：“简终端用户”｝］｝
机票事故清单
拿到票/ api / v2 / / {ticket_id} /事件
允许
- 代理
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| ticket_id | 整数 | 路径 | 真正的 | 机票的ID |
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/tickets/12345/incidents.json＼- v - u｛email_address｝：｛密码｝
示例响应(年代)
200好了
// Status 200 OK｛“门票”：［｛“描述”：“火是五颜六色的。”，“id”：33，“状态”：“开放”，“主题”：“我的打印机着火了”｝，｛“描述”：“火的颜色也很丰富!”，“id”：34，“状态”：“等待”，“主题”："这边的打印机也着火了"｝］｝
列出票务问题
GET / api / v2 /问题
响应总是按updated_at按降序排列
允许
- 代理
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/problems.json＼- v - u｛email_address｝：｛密码｝
示例响应(年代)
200好了
// Status 200 OK｛“门票”：［｛“custom_status_id”：123，“描述”：“火是五颜六色的。”，“id”：33，“状态”：“开放”，“主题”：“我的打印机着火了”｝，｛“custom_status_id”：231，“描述”：“火的颜色也很丰富!”，“id”：34，“状态”：“等待”，“主题”："这边的打印机也着火了"｝］｝
自动完成的问题
POST / api / v2 /问题/自动完成
方法中指定的字符串，返回类型为“problem”的票据文本参数。
您可以指定文本参数，而不是查询字符串。例子:
{“文本”:“火”}
允许
- 代理
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| 文本 | 字符串 | 查询 | 假 | 要搜索的文本 |
例子的身体
｛“文本”：“火”｝
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/problems/autocomplete.json ?文本＝火＼-x post -h“application / json内容类型:＼- u｛email_address｝：｛密码｝
示例响应(年代)
200好了
// Status 200 OK｛“门票”：［｛“custom_status_id”：123，“描述”：“火是五颜六色的。”，“id”：33，“状态”：“开放”，“主题”：“我的打印机着火了”｝，｛“custom_status_id”：231，“描述”：“火的颜色也很丰富!”，“id”：34，“状态”：“等待”，“主题”："这边的打印机也着火了"｝］｝