请求
一个请求是最终用户对票据的看法。最终用户只能看到公开评论和票务的某些字段。使用这个API可以让最终用户查看、更新和创建他们有权访问的票据。
您可以通过请求来加载一些资源。亚博电脑端请参阅支持端点在侧载。
身份验证
最终用户可以使用Requests API。
请注意:如果最终用户在2017年9月17日之后添加了电子邮件身份(与Zendesk个人资料关联的电子邮件地址)，并且没有验证电子邮件地址，则最终用户将无法查看他们的请求。亚博API用403响应标记了这个问题。看到验证用户的邮箱地址在支持帮助中心。
创建票据支持匿名请求，但管理员可以禁用匿名请求。这些匿名请求的速率限制为每小时5个请求试用账号。看到创建请求在下面。
管理员和代理具有最终用户和匿名用户的所有权限。
Multibrand账户
在企业及以上计划中，支持帐户可以拥有多个品牌。看到了解Multibrand如何在您的账户中发挥作用在支持帮助中心。
如果您的帐户中有多个品牌，则Requests API只返回API路径中指定的品牌的票证。它不会退回账户里所有的票。在API路径中，品牌由子域指定。例如，对的GET请求https://omniwear.亚博zendesk.com/api/v2/requests.json只返回Omniwear品牌的票，即使Omniwear是默认品牌。
状态(遗留)和自定义票证状态
JSON格式
请求被表示为具有以下属性的JSON对象:
| 名字 | 类型 | 只读 | 强制性的 | 描述 |
|---|---|---|---|---|
| assignee_id | 整数 | 真正的 | 假 | 如果该字段对最终用户可见，则为受让人的id |
| can_be_solved_by_me | 布尔 | 真正的 | 假 | 如果为true，终端用户可以将请求标记为已解决。 |
| collaborator_ids | 数组 | 真正的 | 假 | 当前在票据上抄送的用户id |
| created_at | 字符串 | 真正的 | 假 | 创建此记录的时间 |
| custom_fields | 数组 | 假 | 假 | 请求的自定义字段。看到设置自定义字段值在票务文件中 |
| custom_status_id | 整数 | 假 | 假 | 票证的自定义票证状态id |
| 描述 | 字符串 | 真正的 | 假 | 只读对请求的第一个注释。当创建请求,使用评论设置描述 |
| due_at | 字符串 | 假 | 假 | 当任务到期时(仅适用于请求类型为“task”时) |
| email_cc_ids | 数组 | 真正的 | 假 | 当前在票上的电子邮件cc的用户id。看到cc和追随者资源亚博电脑端在支持帮助中心 |
| followup_source_id | 整数 | 真正的 | 假 | 如果此请求是后续票据，则为原始票据的id。看到创建请求 |
| group_id | 整数 | 真正的 | 假 | 如果该字段对最终用户可见，则为分配的组的id |
| id | 整数 | 真正的 | 假 | 在创建请求时自动分配 |
| is_public | 布尔 | 真正的 | 假 | 如果评论是公开的为true，否则为false |
| organization_id | 整数 | 真正的 | 假 | 请求者的组织 |
| 优先级 | 字符串 | 假 | 假 | 请求的优先级，“低”、“正常”、“高”、“紧急” |
| 收件人 | 字符串 | 假 | 假 | 请求的原始收件人电子邮件地址 |
| requester_id | 整数 | 真正的 | 假 | 请求者的id |
| 解决了 | 布尔 | 假 | 假 | 是否解决请求(如果上面的“can_be_solved_by_me”对该用户为真，则最终用户可以设置此值) |
| 状态 | 字符串 | 假 | 假 | 请求的状态，“new”、“open”、“pending”、“hold”、“resolved”、“closed” |
| 主题 | 字符串 | 假 | 真正的 | 如果该主题字段对最终用户可见，则此请求的主题字段的值;描述的删节版本 |
| ticket_form_id | 整数 | 假 | 假 | 如果表单对最终用户可见，则与此请求关联的票务表单的数字id -仅适用于企业帐户 |
| 类型 | 字符串 | 假 | 假 | 请求的类型，“问题”，“事件”，“问题”，“任务” |
| updated_at | 字符串 | 真正的 | 假 | 这个记录最后更新的时间 |
| url | 字符串 | 真正的 | 假 | 此请求的API url |
| 通过 | 对象 | 假 | 假 | 描述对象是如何创建的。看到通过对象引用 |
请求评论
注释表示请求者、协作者和代理之间关于请求的公开对话。
请求注释有以下属性:
| 名字 | 类型 | 只读 | 评论 |
|---|---|---|---|
| id | 整数 | 是的 | 在创建注释时自动分配 |
| 类型 | 字符串 | 是的 | “评论”或“语音评论” |
| request_id | 整数 | 是的 | 请求的id |
| 身体 | 字符串 | 没有 | 作者的实际评论 |
| html_body | 字符串 | 是的 | 作者所作的实际注释格式为HTML |
| plain_body | 字符串 | 是的 | 注释格式为纯文本 |
| 公共 | 布尔 | 是的 | 如果这是真的，这则评论是公开的 |
| author_id | 整数 | 是的 | 作者的id |
| 附件 | 数组 | 是的 | 评论附件的只读列表。看到附加文件 |
| 上传 | 数组 | 没有* | *仅创建。之后收到的令牌列表上传文件附加 |
| created_at | 日期 | 是的 | 当这个评论被创建时 |
请求注释示例
{“id”：1274，“类型”：“评论”，“身体”：“谢谢你的帮助!”，“html_body”：谢谢你的帮助!< / p > "
，“author_id”：1，“附件”：［{“id”：498483，“名称”：“crash.log”，“content_url”：“https://company.亚博zendesk.com/attachments/crash.log”，“content_type”：“文本/普通”，“大小”：2532，“缩略图”：［］｝］，“created_at”：“2009 - 07 - 20 - t22:55:29z”｝
例子
{“assignee_id”：72983，“can_be_solved_by_me”：假，“collaborator_ids”：［］，“created_at”：“2009 - 07 - 20 - t22:55:29z”，“描述”：“火的颜色很鲜艳。”，“due_at”：“2011 - 05 - 24 t12:00:00z”，“group_id”：8665，“id”：35436，“organization_id”：509974，“优先”：“正常”，“requester_id”：1462，“状态”：“开放”，“主题”：“救命，我的打印机着火了!”，“ticket_form_id”：2，“类型”：“问题”，“updated_at”：“2011 - 05 - 05 - t10:38:52z”，“url”：“https://company.亚博zendesk.com/api/v2/requests/35436.json”，“通过”：{“通道”：“网络”｝｝
列表请求
GET / api / v2 /请求GET / api / v2 / requests.json吗?状态=,开放GET / api / v2 /请求/ open.jsonGET / api / v2 /请求/ solved.jsonGET / api / v2 /请求/ ccd.jsonGET / api / v2 /用户/ {user_id} / requests.jsonGET / api / v2 /组织/ {organization_id} / requests.json
允许
- 最终用户
参数
| 名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| sort_by | 字符串 | 路径 | 假 | 取值为updated_at、created_at。 |
| sort_order | 字符串 | 路径 | 假 | “asc”，“desc”之一。默认为“asc” |
代码示例
旋度
旋度https://{子域名｝.亚博zendesk.com/api/v2/requests.json＼- v - u{email_address｝：{密码｝
去
进口（“fmt”“输入输出”“net/http”）函数主要（）{url: =“https://example.亚博zendesk.com/api/v2/requests”方法: =“获得”要求的事情，犯错: =http。NewRequest（方法，url，零）如果犯错! =零{fmt。Println（犯错）返回｝要求的事情。头。添加（“内容类型”，“application / json”）要求的事情。头。添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端: =＆http。客户端{｝res，犯错: =客户端。做（要求的事情）如果犯错! =零{fmt。Println（犯错）返回｝推迟res。身体。关闭（）身体，犯错: =io。ReadAll（res。身体）如果犯错! =零{fmt。Println（犯错）返回｝fmt。Println（字符串（身体））｝
Java
进口com。squareup。okhttp。*；OkHttpClient客户端=新OkHttpClient（）；HttpUrl。构建器urlBuilder=HttpUrl。解析（“https://example.亚博zendesk.com/api/v2/requests”）。newBuilder（）；请求请求=新请求。构建器（）。url（urlBuilder。构建（））。方法（“获得”，零）。addHeader（“内容类型”，“application / json”）。addHeader（“授权”，凭证。基本（“电子邮件”，“你的密码”））。构建（）；响应响应=客户端。newCall（请求）。执行（）；
Nodejs
varaxios=需要（“axios”）；var配置={方法：“得到”，url：“https://example.亚博zendesk.com/api/v2/requests”，头：{“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"｝，｝；axios（配置）。然后（函数（响应）{控制台。日志（JSON。stringify（响应。数据））；｝）。抓（函数（错误）{控制台。日志（错误）；｝）；
Python
进口请求url=“https://example.亚博zendesk.com/api/v2/requests”头={“内容类型”：“application / json”，｝响应=请求。请求（“获得”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应。文本）
鲁比（人名）
需要“net/http”uri=URI（“https://example.亚博zendesk.com/api/v2/requests”）请求=网：：HTTP：：得到。新（uri，“内容类型”：“application / json”）请求。basic_auth“用户名”，“密码”响应=网：：HTTP。开始uri。主机名，uri。港口，use_ssl：真正的做|http|http。请求（请求）结束
示例响应(年代)
200好了
//状态200 OK{“请求”：［{“custom_status_id”：123，“描述”：“我的打印机着火了!”，“id”：33，“状态”：“开放”，“主题”：“救命!”｝，{“custom_status_id”：234，“描述”：“我找不到我的钥匙了”，“id”：34，“状态”：“关闭”，“主题”：“救命!”｝］｝
搜索请求
GET / api / v2 /请求/搜索
例子:
GET / api / v2 /请求/ search.json吗?查询=打印机GET / api / v2 /请求/ search.json吗?查询= printer&organization_id = 1GET / api / v2 /请求/ search.json吗?查询= printer&cc_id = trueGET / api / v2 /请求/ search.json吗?查询= printer&status =,开放
分页
- 仅偏移分页
看到使用偏移分页。
结果限制
Search Requests端点每个查询最多返回1,000个结果，每页最多返回100个结果。看到分页。如果您请求的页面超过限制(页面= 11(每页100个结果)，则返回422“资源不足错误”。
允许
- 最终用户
参数
| 名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| 查询 | 字符串 | 路径 | 假 | 中详细介绍了字符串的语法和匹配逻辑亚博Zendesk支持搜索参考。另请参阅查询基础知识在Tickets API文档中。 |
代码示例
旋度
旋度https://{子域名｝.亚博zendesk.com/api/v2/requests/search.json ?查询={search_string｝＼- v - u{email_address｝：{密码｝
去
进口（“fmt”“输入输出”“net/http”）函数主要（）{url: =“https://example.亚博zendesk.com/api/v2/requests/search”方法: =“获得”要求的事情，犯错: =http。NewRequest（方法，url，零）如果犯错! =零{fmt。Println（犯错）返回｝要求的事情。头。添加（“内容类型”，“application / json”）要求的事情。头。添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端: =＆http。客户端{｝res，犯错: =客户端。做（要求的事情）如果犯错! =零{fmt。Println（犯错）返回｝推迟res。身体。关闭（）身体，犯错: =io。ReadAll（res。身体）如果犯错! =零{fmt。Println（犯错）返回｝fmt。Println（字符串（身体））｝
Java
进口com。squareup。okhttp。*；OkHttpClient客户端=新OkHttpClient（）；HttpUrl。构建器urlBuilder=HttpUrl。解析（“https://example.亚博zendesk.com/api/v2/requests/search”）。newBuilder（）；请求请求=新请求。构建器（）。url（urlBuilder。构建（））。方法（“获得”，零）。addHeader（“内容类型”，“application / json”）。addHeader（“授权”，凭证。基本（“电子邮件”，“你的密码”））。构建（）；响应响应=客户端。newCall（请求）。执行（）；
Nodejs
varaxios=需要（“axios”）；var配置={方法：“得到”，url：“https://example.亚博zendesk.com/api/v2/requests/search”，头：{“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"｝，｝；axios（配置）。然后（函数（响应）{控制台。日志（JSON。stringify（响应。数据））；｝）。抓（函数（错误）{控制台。日志（错误）；｝）；
Python
进口请求url=“https://example.亚博zendesk.com/api/v2/requests/search”头={“内容类型”：“application / json”，｝响应=请求。请求（“获得”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应。文本）
鲁比（人名）
需要“net/http”uri=URI（“https://example.亚博zendesk.com/api/v2/requests/search”）请求=网：：HTTP：：得到。新（uri，“内容类型”：“application / json”）请求。basic_auth“用户名”，“密码”响应=网：：HTTP。开始uri。主机名，uri。港口，use_ssl：真正的做|http|http。请求（请求）结束
示例响应(年代)
200好了
//状态200 OK{“请求”：［{“custom_status_id”：123，“描述”：“我的打印机着火了!”，“id”：33，“状态”：“开放”，“主题”：“救命!”｝，{“custom_status_id”：234，“描述”：“我找不到我的钥匙了”，“id”：34，“状态”：“关闭”，“主题”：“救命!”｝］｝
显示请求
GET / api / v2 /请求/ {request_id}
拷贝的
支持以下副加载:
| 名字 | 将拷贝的 |
|---|---|
| 用户 | 这封邮件是针对侧载用户的请求发送的 |
允许
- 最终用户
参数
| 名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| request_id | 整数 | 路径 | 真正的 | 请求的ID |
代码示例
旋度
旋度https://{子域名｝.亚博zendesk.com/api/v2/requests/{request_id｝. json＼- v - u{email_address｝：{密码｝
去
进口（“fmt”“输入输出”“net/http”）函数主要（）{url: =“https://example.亚博zendesk.com/api/v2/requests/33”方法: =“获得”要求的事情，犯错: =http。NewRequest（方法，url，零）如果犯错! =零{fmt。Println（犯错）返回｝要求的事情。头。添加（“内容类型”，“application / json”）要求的事情。头。添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端: =＆http。客户端{｝res，犯错: =客户端。做（要求的事情）如果犯错! =零{fmt。Println（犯错）返回｝推迟res。身体。关闭（）身体，犯错: =io。ReadAll（res。身体）如果犯错! =零{fmt。Println（犯错）返回｝fmt。Println（字符串（身体））｝
Java
进口com。squareup。okhttp。*；OkHttpClient客户端=新OkHttpClient（）；HttpUrl。构建器urlBuilder=HttpUrl。解析（“https://example.亚博zendesk.com/api/v2/requests/33”）。newBuilder（）；请求请求=新请求。构建器（）。url（urlBuilder。构建（））。方法（“获得”，零）。addHeader（“内容类型”，“application / json”）。addHeader（“授权”，凭证。基本（“电子邮件”，“你的密码”））。构建（）；响应响应=客户端。newCall（请求）。执行（）；
Nodejs
varaxios=需要（“axios”）；var配置={方法：“得到”，url：“https://example.亚博zendesk.com/api/v2/requests/33”，头：{“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"｝，｝；axios（配置）。然后（函数（响应）{控制台。日志（JSON。stringify（响应。数据））；｝）。抓（函数（错误）{控制台。日志（错误）；｝）；
Python
进口请求url=“https://example.亚博zendesk.com/api/v2/requests/33”头={“内容类型”：“application / json”，｝响应=请求。请求（“获得”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应。文本）
鲁比（人名）
需要“net/http”uri=URI（“https://example.亚博zendesk.com/api/v2/requests/33”）请求=网：：HTTP：：得到。新（uri，“内容类型”：“application / json”）请求。basic_auth“用户名”，“密码”响应=网：：HTTP。开始uri。主机名，uri。港口，use_ssl：真正的做|http|http。请求（请求）结束
示例响应(年代)
200好了
//状态200 OK{“请求”：{“custom_status_id”：123，“描述”：“我的打印机着火了!”，“id”：33，“状态”：“开放”，“主题”：“救命!”｝｝
创建请求
POST / api / v2 /请求
接受一个请求对象，该对象设置一个或多个属性。
允许
- 最终用户
- 匿名用户(速率限制为每小时5个请求)试用账号）
额外的属性
的可写请求属性之外JSON格式表上面，您可以在创建请求时设置以下属性。
| 名字 | 类型 | 强制性的 | 评论 |
|---|---|---|---|
| 评论 | 对象 | 是的 | 描述问题、事件、问题或任务。看到请求评论 |
| 合作者 | 数组 | 没有 | 向请求添加协作者(抄送)。当创建票据时，会向他们发送电子邮件通知。看到设置的合作者 |
| 请求者 | 对象 | 是的* | *需要匿名请求。指定匿名请求的请求者。看到创建匿名请求 |
创建后续请求
一旦票被关闭(不同于已解决)，它就不能重新打开。但是，您可以创建一个引用已关闭票据的新请求。要创建后续请求，请包含via_followup_source_id的财产请求对象，该对象指定已关闭的票据。该参数仅适用于已关闭的票据。对其他票无效。
代码示例
旋度
经过身份验证的请求
旋度https://{子域名｝.亚博zendesk.com/api/v2/requests.json＼- d{"请求":{“主题”:“救命!”,“评论”:{“身体”:“我的打印机是着火了!”,“上传”:[…]}}}＼- v - u{email_address｝：{密码｝-x post -h“application / json内容类型:
旋度
匿名的请求
旋度https://{子域名｝.亚博zendesk.com/api/v2/requests.json＼- d{"request": {"requester": {"name": "Anonymous customer"}， "subject": "Help!"， "comment": {"body": "My printer is fire!"”}}}＼-x post -h“application / json内容类型:
去
进口（“fmt”“输入输出”“net/http”）函数主要（）{url: =“https://example.亚博zendesk.com/api/v2/requests”方法: =“职位”要求的事情，犯错: =http。NewRequest（方法，url，零）如果犯错! =零{fmt。Println（犯错）返回｝要求的事情。头。添加（“内容类型”，“application / json”）要求的事情。头。添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端: =＆http。客户端{｝res，犯错: =客户端。做（要求的事情）如果犯错! =零{fmt。Println（犯错）返回｝推迟res。身体。关闭（）身体，犯错: =io。ReadAll（res。身体）如果犯错! =零{fmt。Println（犯错）返回｝fmt。Println（字符串（身体））｝
Java
进口com。squareup。okhttp。*；OkHttpClient客户端=新OkHttpClient（）；HttpUrl。构建器urlBuilder=HttpUrl。解析（“https://example.亚博zendesk.com/api/v2/requests”）。newBuilder（）；RequestBody身体=RequestBody。创建（MediaType。解析（“application / json”），”“””“”）；请求请求=新请求。构建器（）。url（urlBuilder。构建（））。方法（“职位”，身体）。addHeader（“内容类型”，“application / json”）。addHeader（“授权”，凭证。基本（“电子邮件”，“你的密码”））。构建（）；响应响应=客户端。newCall（请求）。执行（）；
Nodejs
varaxios=需要（“axios”）；var配置={方法：“职位”，url：“https://example.亚博zendesk.com/api/v2/requests”，头：{“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"｝，｝；axios（配置）。然后（函数（响应）{控制台。日志（JSON。stringify（响应。数据））；｝）。抓（函数（错误）{控制台。日志（错误）；｝）；
Python
进口请求url=“https://example.亚博zendesk.com/api/v2/requests”头={“内容类型”：“application / json”，｝响应=请求。请求（“职位”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应。文本）
鲁比（人名）
需要“net/http”uri=URI（“https://example.亚博zendesk.com/api/v2/requests”）请求=网：：HTTP：：帖子。新（uri，“内容类型”：“application / json”）请求。basic_auth“用户名”，“密码”响应=网：：HTTP。开始uri。主机名，uri。港口，use_ssl：真正的做|http|http。请求（请求）结束
示例响应(年代)
201年创建
//状态201创建{“请求”：{“custom_status_id”：1，“描述”：“我的打印机着火了!”，“id”：33，“状态”：“新”，“主题”：“救命!”｝｝
更新请求
把/ api / v2 /请求/ {request_id}
用注释或协作者(cc)更新请求。创建请求的最终用户也可以使用它将请求标记为已解决。该端点不能用于更新其他请求属性。
可写属性
此端点只能更新请求中的以下属性。
| 名字 | 类型 | 要求 | 描述 |
|---|---|---|---|
| 评论 | 对象 | 没有 | 向请求添加注释。看到请求评论 |
| 解决了 | 布尔 | 没有 | 将请求标记为已解决。例子:{"request": {" resolved ": "true"}} |
| additional_collaborators | 数组 | 没有 | 向请求添加协作者。当机票更新时，会向他们发送电子邮件通知。看到添加的合作者 |
允许
- 最终用户
参数
| 名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| request_id | 整数 | 路径 | 真正的 | 请求的ID |
代码示例
旋度
旋度https://{子域名｝.亚博zendesk.com/api/v2/requests/{id｝. json＼- d{"request": {"comment": {"body": "谢谢! "“}}}＼- v - u{email_address｝：{密码｝-x放-h“application / json内容类型:
去
进口（“fmt”“输入输出”“net/http”）函数主要（）{url: =“https://example.亚博zendesk.com/api/v2/requests/33”方法: =“把”要求的事情，犯错: =http。NewRequest（方法，url，零）如果犯错! =零{fmt。Println（犯错）返回｝要求的事情。头。添加（“内容类型”，“application / json”）要求的事情。头。添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端: =＆http。客户端{｝res，犯错: =客户端。做（要求的事情）如果犯错! =零{fmt。Println（犯错）返回｝推迟res。身体。关闭（）身体，犯错: =io。ReadAll（res。身体）如果犯错! =零{fmt。Println（犯错）返回｝fmt。Println（字符串（身体））｝
Java
进口com。squareup。okhttp。*；OkHttpClient客户端=新OkHttpClient（）；HttpUrl。构建器urlBuilder=HttpUrl。解析（“https://example.亚博zendesk.com/api/v2/requests/33”）。newBuilder（）；RequestBody身体=RequestBody。创建（MediaType。解析（“application / json”），”“””“”）；请求请求=新请求。构建器（）。url（urlBuilder。构建（））。方法（“把”，身体）。addHeader（“内容类型”，“application / json”）。addHeader（“授权”，凭证。基本（“电子邮件”，“你的密码”））。构建（）；响应响应=客户端。newCall（请求）。执行（）；
Nodejs
varaxios=需要（“axios”）；var配置={方法：“把”，url：“https://example.亚博zendesk.com/api/v2/requests/33”，头：{“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"｝，｝；axios（配置）。然后（函数（响应）{控制台。日志（JSON。stringify（响应。数据））；｝）。抓（函数（错误）{控制台。日志（错误）；｝）；
Python
进口请求url=“https://example.亚博zendesk.com/api/v2/requests/33”头={“内容类型”：“application / json”，｝响应=请求。请求（“把”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应。文本）
鲁比（人名）
需要“net/http”uri=URI（“https://example.亚博zendesk.com/api/v2/requests/33”）请求=网：：HTTP：：把。新（uri，“内容类型”：“application / json”）请求。basic_auth“用户名”，“密码”响应=网：：HTTP。开始uri。主机名，uri。港口，use_ssl：真正的做|http|http。请求（请求）结束
示例响应(年代)
200好了
//状态200 OK{“请求”：{“custom_status_id”：1，“描述”：“我的打印机着火了!”，“id”：33，“状态”：“新”，“主题”：“救命!”｝｝
清单的评论
GET / api / v2 /请求/ {request_id} /评论
分页
- 游标分页(推荐)
- 抵消分页
看到分页。
排序
默认情况下，注释按创建日期升序排序。
当使用游标分页时，使用以下参数更改排序顺序:
| 名字 | 类型 | 要求 | 评论 |
|---|---|---|---|
排序 |
字符串 | 没有 | 可能的值是"created_at"(升序)或"-created_at"(降序) |
当使用偏移分页时，使用以下参数更改排序顺序:
| 名字 | 类型 | 要求 | 评论 |
|---|---|---|---|
sort_by |
字符串 | 没有 | 之一created_at，updated_at |
sort_order |
字符串 | 没有 | 之一asc，desc |
允许
- 最终用户
参数
| 名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| 角色 | 字符串 | 查询 | 假 | “agent”、“end_user”之一。如果未指定，则不进行筛选 |
| 自 | 字符串 | 查询 | 假 | 过滤来自给定日期时间的评论 |
| request_id | 整数 | 路径 | 真正的 | 请求的ID |
代码示例
旋度
旋度https://{子域名｝.亚博zendesk.com/api/v2/requests/{request_id｝/ comments.json＼- v - u{email_address｝：{密码｝
去
进口（“fmt”“输入输出”“net/http”）函数主要（）{url: =“https://example.亚博zendesk.com/api/v2/requests/33/comments?role=&since=”方法: =“获得”要求的事情，犯错: =http。NewRequest（方法，url，零）如果犯错! =零{fmt。Println（犯错）返回｝要求的事情。头。添加（“内容类型”，“application / json”）要求的事情。头。添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端: =＆http。客户端{｝res，犯错: =客户端。做（要求的事情）如果犯错! =零{fmt。Println（犯错）返回｝推迟res。身体。关闭（）身体，犯错: =io。ReadAll（res。身体）如果犯错! =零{fmt。Println（犯错）返回｝fmt。Println（字符串（身体））｝
Java
进口com。squareup。okhttp。*；OkHttpClient客户端=新OkHttpClient（）；HttpUrl。构建器urlBuilder=HttpUrl。解析（“https://example.亚博zendesk.com/api/v2/requests/33/comments”）。newBuilder（）。addQueryParameter（“角色”，”“）。addQueryParameter（“自”，”“）；请求请求=新请求。构建器（）。url（urlBuilder。构建（））。方法（“获得”，零）。addHeader（“内容类型”，“application / json”）。addHeader（“授权”，凭证。基本（“电子邮件”，“你的密码”））。构建（）；响应响应=客户端。newCall（请求）。执行（）；
Nodejs
varaxios=需要（“axios”）；var配置={方法：“得到”，url：“https://example.亚博zendesk.com/api/v2/requests/33/comments”，头：{“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"｝，参数个数：{“角色”：＇＇，“自”：＇＇，｝，｝；axios（配置）。然后（函数（响应）{控制台。日志（JSON。stringify（响应。数据））；｝）。抓（函数（错误）{控制台。日志（错误）；｝）；
Python
进口请求url=“https://example.亚博zendesk.com/api/v2/requests/33/comments?role=&since=”头={“内容类型”：“application / json”，｝响应=请求。请求（“获得”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应。文本）
鲁比（人名）
需要“net/http”uri=URI（“https://example.亚博zendesk.com/api/v2/requests/33/comments”）uri。查询=URI。encode_www_form（“角色”：”“，“自”：”“）请求=网：：HTTP：：得到。新（uri，“内容类型”：“application / json”）请求。basic_auth“用户名”，“密码”响应=网：：HTTP。开始uri。主机名，uri。港口，use_ssl：真正的做|http|http。请求（请求）结束
示例响应(年代)
200好了
//状态200 OK{“评论”：［{“身体”：“谢谢你的帮助”，“id”：43｝］｝
得到评论
GET / api / v2 /请求/ {request_id} /评论/ {ticket_comment_id}
允许
- 最终用户
参数
| 名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| request_id | 整数 | 路径 | 真正的 | 请求的ID |
| ticket_comment_id | 整数 | 路径 | 真正的 | 票据评论的ID |
代码示例
旋度
旋度https://{子域名｝.亚博zendesk.com/api/v2/requests/{request_id｝/评论/{ticket_comment_id｝. json＼- v - u{email_address｝：{密码｝
去
进口（“fmt”“输入输出”“net/http”）函数主要（）{url: =“https://example.亚博zendesk.com/api/v2/requests/33/comments/35436”方法: =“获得”要求的事情，犯错: =http。NewRequest（方法，url，零）如果犯错! =零{fmt。Println（犯错）返回｝要求的事情。头。添加（“内容类型”，“application / json”）要求的事情。头。添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端: =＆http。客户端{｝res，犯错: =客户端。做（要求的事情）如果犯错! =零{fmt。Println（犯错）返回｝推迟res。身体。关闭（）身体，犯错: =io。ReadAll（res。身体）如果犯错! =零{fmt。Println（犯错）返回｝fmt。Println（字符串（身体））｝
Java
进口com。squareup。okhttp。*；OkHttpClient客户端=新OkHttpClient（）；HttpUrl。构建器urlBuilder=HttpUrl。解析（“https://example.亚博zendesk.com/api/v2/requests/33/comments/35436”）。newBuilder（）；请求请求=新请求。构建器（）。url（urlBuilder。构建（））。方法（“获得”，零）。addHeader（“内容类型”，“application / json”）。addHeader（“授权”，凭证。基本（“电子邮件”，“你的密码”））。构建（）；响应响应=客户端。newCall（请求）。执行（）；
Nodejs
varaxios=需要（“axios”）；var配置={方法：“得到”，url：“https://example.亚博zendesk.com/api/v2/requests/33/comments/35436”，头：{“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"｝，｝；axios（配置）。然后（函数（响应）{控制台。日志（JSON。stringify（响应。数据））；｝）。抓（函数（错误）{控制台。日志（错误）；｝）；
Python
进口请求url=“https://example.亚博zendesk.com/api/v2/requests/33/comments/35436”头={“内容类型”：“application / json”，｝响应=请求。请求（“获得”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应。文本）
鲁比（人名）
需要“net/http”uri=URI（“https://example.亚博zendesk.com/api/v2/requests/33/comments/35436”）请求=网：：HTTP：：得到。新（uri，“内容类型”：“application / json”）请求。basic_auth“用户名”，“密码”响应=网：：HTTP。开始uri。主机名，uri。港口，use_ssl：真正的做|http|http。请求（请求）结束
示例响应(年代)
200好了
//状态200 OK{“评论”：{“身体”：“谢谢!”，“id”：43｝｝