文档 API参考

文章的评论

用户可以通过在知识库中添加评论来提供反馈亚博官方app文章．用户必须拥有Zendesk帐户，并且他们的亚博请求必须经过身份验证。匿名用户不能添加评论。有关更多信息，请参见帮助中心的解剖．

JSON格式

文章评论表示为具有以下属性的JSON对象:

名字 类型 只读 强制性的 描述
author_id 整数 假 假 此评论作者的id。可由帮助中心经理编写和创建。看到创建的评论
身体 字符串 假 真正的 作者的评论。看到用户内容
created_at 字符串 假 假 评论被创建的时间。可由帮助中心经理编写和创建。看到创建的评论
html_url 字符串 真正的 假 在帮助中心中显示评论的url
id 整数 真正的 假 在创建注释时自动分配
语言环境 字符串 假 真正的 发表此评论的语言环境
non_author_editor_id 整数 真正的 假 执行最近一次(如果有的话)非作者编辑的用户id。非作者编辑包括由创建或更新数据库的作者以外的用户进行的编辑身体或author_id．请注意，只有在2021年5月17日之后进行的编辑才会反映在此字段中。如果自2021年5月17日以来没有发生非作者编辑，则此字段将被删除零．
non_author_updated_at 字符串 真正的 假 评论最后被非作者用户编辑的时间
source_id 整数 真正的 假 对所作评论的项目的编号
source_type 字符串 真正的 假 提出这一评论的项目类型。目前只支持“文章”
updated_at 字符串 真正的 假 评论最后更新的时间
url 字符串 真正的 假 此注释的API url
vote_count 整数 真正的 假 赞成和反对的总数
vote_sum 整数 真正的 假 赞成(+1)和反对(-1)的总和，可以是正面的，也可以是负面的

用户内容

最终用户可以通过社区帖子、帖子评论或文章评论的形式添加自己的内容。总的来说，这叫做< em >用户内容．用户内容的格式为html。

内容可能包含以下标准HTML标签:

  • 段落和段落:< p >，< div >，< span >，< br >
  • 文本格式:< b >，<我>，<你>，< >强，< em >，子> <，<一口>
  • 链接和分隔符:<一>，<人力资源>
  • 图片:< img >(src属性必须引用用户上传的图像)
  • 标题:<标题>，< h2 >，< h3 >，< h4 >，< h5 >，<编辑>
  • 子弹列表:< ul >，< ol >，<李>
  • 描述列表:< dl >，< dt >，< dd >
  • 表:<表>，< thead >，tbody > <，< tfoot >，< tr >，< th >，< td >，< colgroup >指定表格中，< >上校
  • 引号和代码片段:< blockquote >，< >之前
  • 语义:<方法>，<缩略词>，<引用>，<代码>，< tt >，<桑普>，< kbd >，< var >，< dfn >，<地址>

此外，内容可能包含以下非标准HTML标签:

  • @提到:< x亚博-zendesk-user >，其中标记的内容应该是所提到的用户的用户ID。例子:123亚博4年< x-zendesk-user > < / x-zendesk-user >以提及ID为1234的用户。

即使对内容进行了验证，输出的主体也可能与请求主体不相同。例如，可以出于安全性或标准遵从性的原因进行调整。

例子

             

              
{“author_id”：3465，“身体”：“谢谢你的帮助!”，“created_at”：“2012 - 04 - 04 - t09:14:57z”，“id”：1635，“场所”：“en - us”，“source_id”：65466，“source_type”：“文章”}

评论列表

  • GET / api / v2 / help_center{/地区}/文章/ {article_id} /评论
  • GET / api / v2 / help_center /用户/ {user_id} /评论

列出特定用户创建的评论，或所有用户对特定文章的所有评论。

的{地区}对于这篇文章，只有终端用户才需要注释。管理员和代理可以忽略它。

允许

  • 代理
  • 终端用户

最终用户只能列出他们自己的评论。如果按用户列出评论，则必须指定我作为id。

拷贝的

支持以下副加载:

名字 将拷贝的
用户 作者
文章 文章

参数

名字 类型 在 要求 描述
article_id 整数 路径 真正的 文章的唯一ID
语言环境 字符串 路径 假 项目显示的区域设置

代码示例

旋度 
              

               
旋度https://{子域名}.亚博zendesk.com/api/v2/help_center/users/{user_id}/ comments.json＼- v - u{email_address}：{密码}
去 
              

               
进口（“fmt”“输入输出”“net/http”）函数主要（）{url：=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /评论”方法：=“获得”要求的事情，犯错：=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://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /评论”）．newBuilder（）；请求请求=新请求．构建器（）．url（urlBuilder．构建（））．方法（“获得”，零）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应=客户端．newCall（请求）．执行（）；
Nodejs 
              

               
varaxios=需要（“axios”）；var配置={方法：“得到”，url：“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /评论，头：{“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，}；axios（配置）．然后（函数（响应）{控制台．日志（JSON．stringify（响应．数据））；}）．抓（函数（错误）{控制台．日志（错误）；}）；
Python 
              

               
进口请求url=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /评论”头={“内容类型”：“application / json”，}响应=请求．请求（“获得”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应．文本）
鲁比（人名） 
              

               
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /评论”）请求=网：：HTTP：：得到．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应=网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

200好了 
              

               
//状态200 OK{“评论”：［{“author_id”：89567，“身体”：“我的打印机着火了”，“id”：35467，“场所”：“en”}，{“author_id”：89589，“身体”：“我的打印机也着火了!”，“id”：36221，“场所”：“en”}］}

显示评论

  • GET / api / v2 / help_center{/地区}/文章/ {article_id} /评论/ {comment_id}

显示指定注释的属性。

的{地区}仅对最终用户和匿名用户需要。管理员和代理可以忽略它。

允许

  • 代理
  • 终端用户
  • 匿名用户

参数

名字 类型 在 要求 描述
article_id 整数 路径 真正的 文章的唯一ID
comment_id 整数 路径 真正的 评论的唯一ID
语言环境 字符串 路径 假 项目显示的区域设置

代码示例

旋度 
              

               
旋度https://{子域名}.亚博zendesk.com/api/v2/help_center/{语言环境}/文章/{article_id}/评论/{comment_id}. json＼- v - u{email_address}：{密码}
去 
              

               
进口（“fmt”“输入输出”“net/http”）函数主要（）{url：=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /评论/ 360026053753”方法：=“获得”要求的事情，犯错：=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://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /评论/ 360026053753”）．newBuilder（）；请求请求=新请求．构建器（）．url（urlBuilder．构建（））．方法（“获得”，零）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应=客户端．newCall（请求）．执行（）；
Nodejs 
              

               
varaxios=需要（“axios”）；var配置={方法：“得到”，url：“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /评论/ 360026053753”，头：{“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，}；axios（配置）．然后（函数（响应）{控制台．日志（JSON．stringify（响应．数据））；}）．抓（函数（错误）{控制台．日志（错误）；}）；
Python 
              

               
进口请求url=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /评论/ 360026053753”头={“内容类型”：“application / json”，}响应=请求．请求（“获得”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应．文本）
鲁比（人名） 
              

               
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /评论/ 360026053753”）请求=网：：HTTP：：得到．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应=网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

200好了 
              

               
//状态200 OK{“评论”：{“author_id”：89567，“身体”：“好信息!”，“id”：35467，“场所”：“en”}}

创建的评论

  • POST / api / v2 / help_center{/地区}/文章/ {article_id} /评论

将注释添加到指定的文章．由于注释与特定的文章翻译或语言环境相关联，因此必须指定语言环境。

允许

  • 最终用户

具有帮助中心管理器角色的代理可以选择性地提供一个created_at作为评论对象。如未提供，created_at设置为当前时间。

提供一个notify_subscribers属性的值为false将阻止评论文章的订阅者收到评论创建电子邮件通知。这在一次创建许多注释时非常有用。在JSON对象的根目录中指定属性，而不是在“comment”对象中。

参数

名字 类型 在 要求 描述
article_id 整数 路径 真正的 文章的唯一ID
语言环境 字符串 路径 假 项目显示的区域设置

代码示例

旋度 
              

               
旋度https://{子域名}.亚博zendesk.com/api/v2/help_center/articles/{article_id}/ comments.json＼- d”{“评论”:{“身体”:“好信息!”,“语言环境”:“en - us”},“notify_subscribers”:假}”- v - u{email_address}：{密码}-x post -h“application / json内容类型:
去 
              

               
进口（“fmt”“输入输出”“net/http”）函数主要（）{url：=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /评论”方法：=“职位”要求的事情，犯错：=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://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /评论”）．newBuilder（）；RequestBody身体=RequestBody．创建（MediaType．解析（“application / json”），＂＂＂＂＂＂）；请求请求=新请求．构建器（）．url（urlBuilder．构建（））．方法（“职位”，身体）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应=客户端．newCall（请求）．执行（）；
Nodejs 
              

               
varaxios=需要（“axios”）；var配置={方法：“职位”，url：“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /评论，头：{“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，}；axios（配置）．然后（函数（响应）{控制台．日志（JSON．stringify（响应．数据））；}）．抓（函数（错误）{控制台．日志（错误）；}）；
Python 
              

               
进口请求url=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /评论”头={“内容类型”：“application / json”，}响应=请求．请求（“职位”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应．文本）
鲁比（人名） 
              

               
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /评论”）请求=网：：HTTP：：帖子．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应=网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

200好了 
              

               
//状态200 OK{“评论”：{“author_id”：89567，“身体”：“好信息!”，“id”：35467，“场所”：“en”}}

更新的评论

  • 把/ api / v2 / help_center{/地区}/文章/ {article_id} /评论/ {comment_id}

允许

  • 代理
  • 创建评论的最终用户

参数

名字 类型 在 要求 描述
article_id 整数 路径 真正的 文章的唯一ID
comment_id 整数 路径 真正的 评论的唯一ID
语言环境 字符串 路径 假 项目显示的区域设置

代码示例

旋度 
              

               
旋度——请求PUT https://support.zendes亚博k.com/api/v2/help_center{/地区}/文章/ 360026053753 /评论/ 360026053753＼——头“application / json内容类型:＼- u用户名:密码

              
              

               
旋度https://{子域名}.亚博zendesk.com/api/v2/help_center/articles/{article_id}/评论/{comment_id}. json＼- d'{"comment": {"body": " failed work"}}'＼- v - u{email_address}：{密码}-x放-h“application / json内容类型:
去 
              

               
进口（“fmt”“输入输出”“net/http”）函数主要（）{url：=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /评论/ 360026053753”方法：=“把”要求的事情，犯错：=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://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /评论/ 360026053753”）．newBuilder（）；RequestBody身体=RequestBody．创建（MediaType．解析（“application / json”），＂＂＂＂＂＂）；请求请求=新请求．构建器（）．url（urlBuilder．构建（））．方法（“把”，身体）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应=客户端．newCall（请求）．执行（）；
Nodejs 
              

               
varaxios=需要（“axios”）；var配置={方法：“把”，url：“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /评论/ 360026053753”，头：{“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，}；axios（配置）．然后（函数（响应）{控制台．日志（JSON．stringify（响应．数据））；}）．抓（函数（错误）{控制台．日志（错误）；}）；
Python 
              

               
进口请求url=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /评论/ 360026053753”头={“内容类型”：“application / json”，}响应=请求．请求（“把”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应．文本）
鲁比（人名） 
              

               
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /评论/ 360026053753”）请求=网：：HTTP：：把．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应=网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

200好了 
              

               
//状态200 OK{“评论”：{“author_id”：89567，“身体”：“好信息!”，“id”：35467，“场所”：“en”}}

删除评论

  • 删除/ api / v2 / help_center / {article_id}{/地区}/文章/评论/ {comment_id}

允许

  • 代理
  • 创建评论的最终用户

参数

名字 类型 在 要求 描述
article_id 整数 路径 真正的 文章的唯一ID
comment_id 整数 路径 真正的 评论的唯一ID
语言环境 字符串 路径 假 项目显示的区域设置

代码示例

旋度 
              

               
旋度——请求删除https://support.zendesk.com亚博/api/v2/help_center{/地区}/文章/ 360026053753 /评论/ 360026053753＼——头“application / json内容类型:＼- u用户名:密码

              
              

               
旋度https://{子域名}.亚博zendesk.com/api/v2/help_center/articles/{article_id}/评论/{comment_id}. json＼- v - u{email_address}：{密码}- x删除
去 
              

               
进口（“fmt”“输入输出”“net/http”）函数主要（）{url：=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /评论/ 360026053753”方法：=“删除”要求的事情，犯错：=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://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /评论/ 360026053753”）．newBuilder（）；请求请求=新请求．构建器（）．url（urlBuilder．构建（））．方法（“删除”，零）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应=客户端．newCall（请求）．执行（）；
Nodejs 
              

               
varaxios=需要（“axios”）；var配置={方法：“删除”，url：“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /评论/ 360026053753”，头：{“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，}；axios（配置）．然后（函数（响应）{控制台．日志（JSON．stringify（响应．数据））；}）．抓（函数（错误）{控制台．日志（错误）；}）；
Python 
              

               
进口请求url=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /评论/ 360026053753”头={“内容类型”：“application / json”，}响应=请求．请求（“删除”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应．文本）
鲁比（人名） 
              

               
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /评论/ 360026053753”）请求=网：：HTTP：：删除．新（uri，“内容类型”：“application / json”）请求．basic_auth“用户名”，“密码”响应=网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

204无内容 
              

               
//状态204无内容零