的帖子
帖子代表用户与社区分享的内容。
JSON格式
post被表示为具有以下属性的JSON对象:
| 名字 | 类型 | 只读 | 强制性的 | 描述 |
|---|---|---|---|---|
| author_id | 整数 | 真正的 | 假 | 帖子作者的id。*可由帮助中心管理员创建—参见创建帖子 |
| 关闭 | 布尔 | 假 | 假 | 是否允许进一步评论 |
| comment_count | 整数 | 真正的 | 假 | 该帖子的评论数 |
| content_tag_ids | 数组 | 假 | 假 | 附加到文章的内容标签列表 |
| created_at | 字符串 | 真正的 | 假 | 创建该职位时。可由帮助中心管理人员创建创建后 |
| 细节 | 字符串 | 假 | 假 | 作者所发帖子的细节。看到用户内容 |
| 特色 | 布尔 | 假 | 假 | 帖子是否被推荐 |
| follower_count | 整数 | 真正的 | 假 | 该帖子的关注者数量 |
| html_url | 字符串 | 真正的 | 假 | 帖子的社区url |
| id | 整数 | 真正的 | 假 | 在创建职位时自动分配 |
| non_author_editor_id | 整数 | 真正的 | 假 | 执行最近一次(如果有的话)非作者编辑的用户id。非作者编辑包括由创建或更新数据库的作者以外的用户进行的编辑标题或细节。请注意，只有在2021年5月17日之后进行的编辑才会反映在此字段中。如果自2021年5月17日以来没有发生非作者编辑，则此字段将被删除零。 |
| non_author_updated_at | 字符串 | 真正的 | 假 | 文章最后被非作者用户编辑的时间 |
| 固定 | 布尔 | 假 | 假 | 当为true时，将该帖子固定在其主题的顶部 |
| 状态 | 字符串 | 假 | 假 | 职位的状态。取值:planned, not_planned, answered, completed |
| 标题 | 字符串 | 假 | 真正的 | 帖子的标题 |
| topic_id | 整数 | 假 | 假 | 帖子所属主题的id |
| 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，“特色”：真正的，“id”：1635，“标题”：“这篇文章”}
文章列表
GET / api / v2 /社区/职位获得社区/ api / v2 / /主题/ {topic_id} /职位GET / api / v2 /社区/用户/ {user_id} /职位
列出所有的帖子，在给定的所有帖子主题，或特定用户的所有帖子。当按特定用户列出时，可以通过指定列出提出请求的用户的帖子我作为id。
允许
- 代理
- 最终用户
- 匿名用户
过滤
可以过滤结果filter_by查询字符串参数。
得到/api/v2/社区/的帖子。json吗?filter_by=完成
的filter_by参数可以是以下值之一:
| 价值 | 描述 |
|---|---|
计划 |
只列出状态为“已计划”的帖子 |
not_planned |
只列出状态为“未计划”的帖子 |
完成 |
只列出状态为“已完成”的帖子 |
回答 |
只列出状态为“已回答”的帖子 |
没有一个 |
只列出状态为“None”的帖子 |
排序
可以对结果进行排序sort_by查询字符串参数。
得到/api/v2/社区/的帖子。json吗?sort_by=评论
的sort_by参数可以是以下值之一:
| 价值 | 描述 |
|---|---|
created_at |
按创造时间排序。默认的顺序 |
edited_at |
按上次编辑时间排序 |
updated_at |
按上次更新时间排序 |
recent_activity |
按帖子上最近的活动排序 |
票 |
按投票总数排序 |
评论 |
按评论数排序 |
拷贝的
控件附带加载相关记录包括查询字符串参数。支持以下副加载:
| 名字 | 将拷贝的 |
|---|---|
| 用户 | 作者 |
| 主题 | 主题 |
看到加载相关记录。
参数
| 名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| filter_by | 字符串 | 查询 | 假 | 使用提供的值筛选结果。取值为planned、not_planned、completed、answered或none。 |
| sort_by | 字符串 | 查询 | 假 | 使用提供的值对结果进行排序。取值为“created_at”、“edited_at”、“updated_at”、“recent_activity”、“votes”或“comments”。 |
代码示例
旋度
旋度https://｛子域名}.亚博zendesk.com/api/v2/community/users/｛user_id}/ posts.json\- v - u｛email_address}：｛密码}
去
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url：=“https://support.亚博zendesk.com/api/v2/community/posts?filter_by=&sort_by=”方法：=“获得”要求的事情，犯错：=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/community/posts”）。newBuilder（）。addQueryParameter（“filter_by”，"＂）。addQueryParameter（“sort_by”，"＂）；请求请求=新请求。构建器（）。url（urlBuilder。构建（））。方法（“获得”，零）。addHeader（“内容类型”，“application / json”）。addHeader（“授权”，凭证。基本（“电子邮件”，“你的密码”））。构建（）；响应响应=客户端。newCall（请求）。执行（）；
Nodejs
varaxios=需要（“axios”）；var配置=｛方法：“得到”，url：“https://support.亚博zendesk.com/api/v2/community/posts”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，参数个数：｛“filter_by”：＇＇，“sort_by”：＇＇，}，}；axios（配置）。然后（函数（响应）｛控制台。日志（JSON。stringify（响应。数据））；}）。抓（函数（错误）｛控制台。日志（错误）；}）；
Python
进口请求url=“https://support.亚博zendesk.com/api/v2/community/posts?filter_by=&sort_by=”头=｛“内容类型”：“application / json”，}响应=请求。请求（“获得”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应。文本）
鲁比（人名）
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/community/posts”）uri。查询=URI。encode_www_form（“filter_by”："＂，“sort_by”："＂）请求=网：：HTTP：：得到。新（uri，“内容类型”：“application / json”）请求。basic_auth“用户名”，“密码”响应=网：：HTTP。开始uri。主机名，uri。港口，use_ssl：真正的做|http|http。请求（请求）结束
示例响应(年代)
200好了
//状态200 OK｛“文章”：［｛“id”：35467，“标题”：“我怎么打开保险箱?”}]}
显示文章
获得社区/ api / v2 / /文章/ {post_id}
获取有关给定帖子的信息。
允许
- 代理
- 最终用户
- 匿名用户
拷贝的
支持以下副加载:
| 名字 | 将拷贝的 |
|---|---|
| 用户 | 作者 |
| 主题 | 主题 |
参数
| 名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| post_id | 整数 | 路径 | 真正的 | 帖子的唯一ID |
代码示例
旋度
旋度https://｛子域名}.亚博zendesk.com/api/v2/community/posts/｛post_id}. json\- v - u｛email_address}：｛密码}
去
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url：=“https://support.亚博zendesk.com/api/v2/community/posts/360039436873”方法：=“获得”要求的事情，犯错：=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/community/posts/360039436873”）。newBuilder（）；请求请求=新请求。构建器（）。url（urlBuilder。构建（））。方法（“获得”，零）。addHeader（“内容类型”，“application / json”）。addHeader（“授权”，凭证。基本（“电子邮件”，“你的密码”））。构建（）；响应响应=客户端。newCall（请求）。执行（）；
Nodejs
varaxios=需要（“axios”）；var配置=｛方法：“得到”，url：“https://support.亚博zendesk.com/api/v2/community/posts/360039436873”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，}；axios（配置）。然后（函数（响应）｛控制台。日志（JSON。stringify（响应。数据））；}）。抓（函数（错误）｛控制台。日志（错误）；}）；
Python
进口请求url=“https://support.亚博zendesk.com/api/v2/community/posts/360039436873”头=｛“内容类型”：“application / json”，}响应=请求。请求（“获得”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应。文本）
鲁比（人名）
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/community/posts/360039436873”）请求=网：：HTTP：：得到。新（uri，“内容类型”：“application / json”）请求。basic_auth“用户名”，“密码”响应=网：：HTTP。开始uri。主机名，uri。港口，use_ssl：真正的做|http|http。请求（请求）结束
示例响应(年代)
200好了
//状态200 OK｛“职位”：｛“author_id”：888887，“content_tag_ids”：［6776，4545]，“特色”：真正的，“id”：35467，“标题”：“文章标题”}}
创建后
POST / api / v2 /社区/职位
将帖子添加到指定的主题。
允许
- 代理
- 最终用户
具有帮助中心管理器角色的代理可以选择性地提供一个author_id作为帖子对象。如果提供了，则文章的作者将被设置为author_id关键。
具有帮助中心管理器角色的代理可以选择性地提供一个created_at作为帖子对象。如果没有提供created_at设置为当前时间。
提供一个notify_subscribers属性的值为false时，将阻止帖子主题的订阅者接收帖子创建电子邮件通知。这在一次创建多个帖子时非常有用。在JSON对象的根目录中指定属性，而不是在“post”对象中。或者，您可以附加现有的内容标签通过指定它们的id。
代码示例
旋度
旋度https://｛子域名}.亚博zendesk.com/api/v2/community/posts.json\- d'{"post": {"title": "Help!"， "details": "My printer is fire!"， "topic_id": 10046}， "notify_subscribers": false}'\- v - u｛email_address}：｛密码}-x post -h“application / json内容类型:#设置帖子的作者:旋度https://｛子域名}.亚博zendesk.com/api/v2/community/posts.json\- d”{“post”:{“标题”:“救命!”,“细节”:“我的打印机是着火了!”,“author_id”:10056年,“topic_id”:10046}}”\- v - u｛email_address}：｛密码}-x post -h“application / json内容类型:#将内容标签附加到帖子上:旋度https://｛子域名}.亚博zendesk.com/api/v2/community/posts.json\- d'{"post": {"title": "Help!"， "details": "My printer is fire!"， "author_id": 10056， "topic_id": 10046， "content_tag_ids": [6776, 4545]}}'\- v - u｛email_address}：｛密码}-x post -h“application / json内容类型:
去
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url：=“https://support.亚博zendesk.com/api/v2/community/posts”方法：=“职位”要求的事情，犯错：=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/community/posts”）。newBuilder（）；RequestBody身体=RequestBody。创建（MediaType。解析（“application / json”），"＂＂"＂＂）；请求请求=新请求。构建器（）。url（urlBuilder。构建（））。方法（“职位”，身体）。addHeader（“内容类型”，“application / json”）。addHeader（“授权”，凭证。基本（“电子邮件”，“你的密码”））。构建（）；响应响应=客户端。newCall（请求）。执行（）；
Nodejs
varaxios=需要（“axios”）；var配置=｛方法：“职位”，url：“https://support.亚博zendesk.com/api/v2/community/posts”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，}；axios（配置）。然后（函数（响应）｛控制台。日志（JSON。stringify（响应。数据））；}）。抓（函数（错误）｛控制台。日志（错误）；}）；
Python
进口请求url=“https://support.亚博zendesk.com/api/v2/community/posts”头=｛“内容类型”：“application / json”，}响应=请求。请求（“职位”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应。文本）
鲁比（人名）
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/community/posts”）请求=网：：HTTP：：帖子。新（uri，“内容类型”：“application / json”）请求。basic_auth“用户名”，“密码”响应=网：：HTTP。开始uri。主机名，uri。港口，use_ssl：真正的做|http|http。请求（请求）结束
示例响应(年代)
201年创建
//状态201创建｛“职位”：｛“author_id”：888887，“content_tag_ids”：［6776，4545]，“特色”：真正的，“id”：35467，“标题”：“文章标题”}}
更新后
把/ api / v2 /社区/文章/ {post_id}
允许
- 代理
- 创建帖子的最终用户
参数
| 名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| post_id | 整数 | 路径 | 真正的 | 帖子的唯一ID |
代码示例
旋度
旋度https://｛子域名}.亚博zendesk.com/api/v2/community/posts/｛post_id}. json\- d”{“post”:{“标题”:“救命!”,“细节”:“我的打印机是着火了!”,“topic_id”:10046}}”\- v - u｛email_address}：｛密码}-x放-h“application / json内容类型:
去
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url：=“https://support.亚博zendesk.com/api/v2/community/posts/360039436873”方法：=“把”要求的事情，犯错：=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/community/posts/360039436873”）。newBuilder（）；RequestBody身体=RequestBody。创建（MediaType。解析（“application / json”），"＂＂"＂＂）；请求请求=新请求。构建器（）。url（urlBuilder。构建（））。方法（“把”，身体）。addHeader（“内容类型”，“application / json”）。addHeader（“授权”，凭证。基本（“电子邮件”，“你的密码”））。构建（）；响应响应=客户端。newCall（请求）。执行（）；
Nodejs
varaxios=需要（“axios”）；var配置=｛方法：“把”，url：“https://support.亚博zendesk.com/api/v2/community/posts/360039436873”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，}；axios（配置）。然后（函数（响应）｛控制台。日志（JSON。stringify（响应。数据））；}）。抓（函数（错误）｛控制台。日志（错误）；}）；
Python
进口请求url=“https://support.亚博zendesk.com/api/v2/community/posts/360039436873”头=｛“内容类型”：“application / json”，}响应=请求。请求（“把”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应。文本）
鲁比（人名）
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/community/posts/360039436873”）请求=网：：HTTP：：把。新（uri，“内容类型”：“application / json”）请求。basic_auth“用户名”，“密码”响应=网：：HTTP。开始uri。主机名，uri。港口，use_ssl：真正的做|http|http。请求（请求）结束
示例响应(年代)
200好了
//状态200 OK｛“职位”：｛“author_id”：888887，“content_tag_ids”：［6776，4545]，“特色”：真正的，“id”：35467，“标题”：“文章标题”}}
删除帖子
删除/ api / v2 /社区/文章/ {post_id}
允许
- 代理
- 创建帖子的最终用户
参数
| 名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| post_id | 整数 | 路径 | 真正的 | 帖子的唯一ID |
代码示例
旋度
旋度https://｛子域名}.亚博zendesk.com/api/v2/community/posts/｛post_id}. json\- v - u｛email_address}：｛密码}- x删除
去
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url：=“https://support.亚博zendesk.com/api/v2/community/posts/360039436873”方法：=“删除”要求的事情，犯错：=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/community/posts/360039436873”）。newBuilder（）；请求请求=新请求。构建器（）。url（urlBuilder。构建（））。方法（“删除”，零）。addHeader（“内容类型”，“application / json”）。addHeader（“授权”，凭证。基本（“电子邮件”，“你的密码”））。构建（）；响应响应=客户端。newCall（请求）。执行（）；
Nodejs
varaxios=需要（“axios”）；var配置=｛方法：“删除”，url：“https://support.亚博zendesk.com/api/v2/community/posts/360039436873”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，}；axios（配置）。然后（函数（响应）｛控制台。日志（JSON。stringify（响应。数据））；}）。抓（函数（错误）｛控制台。日志（错误）；}）；
Python
进口请求url=“https://support.亚博zendesk.com/api/v2/community/posts/360039436873”头=｛“内容类型”：“application / json”，}响应=请求。请求（“删除”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应。文本）
鲁比（人名）
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/community/posts/360039436873”）请求=网：：HTTP：：删除。新（uri，“内容类型”：“application / json”）请求。basic_auth“用户名”，“密码”响应=网：：HTTP。开始uri。主机名，uri。港口，use_ssl：真正的做|http|http。请求（请求）结束
示例响应(年代)
204无内容
//状态204无内容零