您可以添加附件(如图像和pdf)来帮助文章居中。每个附件的文件大小限制为20 MB。有关更多信息,请参见在知识库中创建和编辑文章亚博官方app在Ze亚博ndesk帮助。

JSON格式

文章附件表示为JSON对象,具有以下属性:

名字 类型 只读 强制性的 描述
article_id 整数 相关文章,如果有的话
content_type 字符串 真正的 文件类型。例如:图像/ png
content_url 字符串 真正的 可以下载附件文件的URL
created_at 字符串 真正的 创建文章附件的时间
file_name 字符串 真正的 文件名
id 整数 真正的 创建文章附件时分配的ID
内联 布尔 附加的文件显示在内联附件的管理界面中。它的URL可以在文章的HTML正文中引用。内联附件是直接嵌入到文章正文中的图像文件。如果为false,则在附件列表中列出该附件。默认值为false
大小 整数 真正的 附件文件大小(以字节为单位)
updated_at 字符串 真正的 文章附件最后更新的时间
url 字符串 真正的 文章附件的URL

例子

             
“article_id”23“content_type”“应用程序/ pdf”“content_url”“https://company.亚博zendesk.com/hc/article_attachments/200109629/party_invitation.pdf”“created_at”“2012 - 04 - 04 - t09:14:57z”“file_name”“party_invitation.pdf”“id”1428“内联”“大小”58298}

创建非关联附件

  • POST / api / v2 / help_center /文章/附件

您可以将此端点用于批量导入。它允许您上传文件,而不将其与文章关联,直到稍后。看到将批量附件关联到文章

注意:尽快将附件与文章关联起来。例如,如果您使用端点批量导入内联图像,则只有登录的最终用户才能看到这些图像;匿名用户没有权限查看未关联的图像。此外,我们不时清除与任何文章无关的旧文章附件。为确保上传的文件不会丢失,请将其与文章关联。

允许

  • 代理

代码示例

旋度
              
旋度https://子域名}.亚博zendesk.com/api/v2/help_center/articles/attachments.json- f“内联= true”- f(电子邮件保护)- v - uemail_address}密码}- x的帖子
              
进口“fmt”“输入输出”“net/http”函数主要url:=“https://support.亚博zendesk.com/api/v2/help_center/articles/attachments”方法:=“职位”要求的事情犯错:=httpNewRequest方法url如果犯错! =fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=&http客户端}res犯错:=客户端要求的事情如果犯错! =fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! =fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttp*OkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://support.亚博zendesk.com/api/v2/help_center/articles/attachments”newBuilderRequestBody身体=RequestBody创建MediaType解析“application / json”""""请求请求=请求构建器urlurlBuilder构建方法“职位”身体addHeader“内容类型”“application / json”addHeader“授权”凭证基本“电子邮件”“你的密码”构建响应响应=客户端newCall请求执行
Nodejs
              
varaxios=需要“axios”var配置=方法“职位”url“https://support.亚博zendesk.com/api/v2/help_center/articles/attachments”“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"}}axios配置然后函数响应控制台日志JSONstringify响应数据}函数错误控制台日志错误}
Python
              
进口请求url=“https://support.亚博zendesk.com/api/v2/help_center/articles/attachments”=“内容类型”“application / json”}响应=请求请求“职位”url身份验证=“<用户名>”' <密码> '=打印响应文本
鲁比(人名)
              
需要“net/http”uri=URI“https://support.亚博zendesk.com/api/v2/help_center/articles/attachments”请求=HTTP帖子uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应=HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

201年创建
              
//状态201创建“article_attachment”“article_id”23“content_type”“应用程序/ jpeg”“content_url”“https://company.亚博zendesk.com/hc/article_attachments/200109629/logo.jpg”“file_name”“logo.jpg”“id”1428“内联”真正的“大小”1428}}

列出物品附件

  • GET / api / v2 / help_center /文章/ {article_id} /附件

列出文章的所有附件。

请注意:默认情况下,分页返回每页的最大附件数,即100。

允许

  • 代理
  • 最终用户,只要他们可以查看相关的文章

参数

名字 类型 要求 描述
article_id 整数 路径 真正的 文章的唯一ID

代码示例

旋度
              
旋度https://子域名}.亚博zendesk.com/api/v2/help_center/articles/article_id}/ attachments.json- v - uemail_address}密码}
              
进口“fmt”“输入输出”“net/http”函数主要url:=“https://support.亚博zendesk.com/api/v2/help_center/articles/360026053753/attachments”方法:=“获得”要求的事情犯错:=httpNewRequest方法url如果犯错! =fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=&http客户端}res犯错:=客户端要求的事情如果犯错! =fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! =fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttp*OkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://support.亚博zendesk.com/api/v2/help_center/articles/360026053753/attachments”newBuilder请求请求=请求构建器urlurlBuilder构建方法“获得”addHeader“内容类型”“application / json”addHeader“授权”凭证基本“电子邮件”“你的密码”构建响应响应=客户端newCall请求执行
Nodejs
              
varaxios=需要“axios”var配置=方法“得到”url“https://support.亚博zendesk.com/api/v2/help_center/articles/360026053753/attachments”“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"}}axios配置然后函数响应控制台日志JSONstringify响应数据}函数错误控制台日志错误}
Python
              
进口请求url=“https://support.亚博zendesk.com/api/v2/help_center/articles/360026053753/attachments”=“内容类型”“application / json”}响应=请求请求“获得”url身份验证=“<用户名>”' <密码> '=打印响应文本
鲁比(人名)
              
需要“net/http”uri=URI“https://support.亚博zendesk.com/api/v2/help_center/articles/360026053753/attachments”请求=HTTP得到uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应=HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK“article_attachments”“article_id”23“content_type”“应用程序/ jpeg”“content_url”“https://company.亚博zendesk.com/hc/article_attachments/200109629/logo.jpg”“file_name”“logo.jpg”“id”1428“内联”真正的“大小”1428}“article_id”23“content_type”“应用程序/ pdf”“content_url”“https://company.亚博zendesk.com/hc/article_attachments/200109629/party_invitation.pdf”“file_name”“party_invitation.pdf”“id”2857“内联”“大小”58298}]}

创建文章附件

  • POST / api / v2 / help_center{/地区}/文章/ {article_id} /附件

为指定的对象创建附件文章.您可以指定附件是否为内联与否。默认为false。

允许

  • 代理

参数

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

代码示例

旋度
              
旋度https://子域名}.亚博zendesk.com/api/v2/help_center/articles/article_id}/ attachments.json- f“内联= true”- f(电子邮件保护)- v - uemail_address}密码}- x的帖子
              
进口“fmt”“输入输出”“net/http”函数主要url:=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /附件”方法:=“职位”要求的事情犯错:=httpNewRequest方法url如果犯错! =fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=&http客户端}res犯错:=客户端要求的事情如果犯错! =fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! =fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttp*OkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /附件”newBuilderRequestBody身体=RequestBody创建MediaType解析“application / json”""""请求请求=请求构建器urlurlBuilder构建方法“职位”身体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配置然后函数响应控制台日志JSONstringify响应数据}函数错误控制台日志错误}
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“article_attachment”“article_id”23“content_type”“应用程序/ jpeg”“content_url”“https://company.亚博zendesk.com/hc/article_attachments/200109629/logo.jpg”“file_name”“logo.jpg”“id”1428“内联”真正的“大小”1428}}

列出文章块附件

  • GET / api / v2 / help_center{/地区}/文章/ {article_id} /附件/块

列出文章的所有块附件。块附件是非内联的附件。

请注意{/地区}是管理员和代理的可选参数。终端用户和匿名用户必须填写。

允许

  • 代理
  • 最终用户,只要他们可以查看相关的文章

参数

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

代码示例

旋度
              
旋度https://子域名}.亚博zendesk.com/api/v2/help_center/语言环境}/文章/article_id}/附件/ block.json- v - uemail_address}密码}
              
进口“fmt”“输入输出”“net/http”函数主要url:=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /附件/块”方法:=“获得”要求的事情犯错:=httpNewRequest方法url如果犯错! =fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=&http客户端}res犯错:=客户端要求的事情如果犯错! =fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! =fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttp*OkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /附件/块”newBuilder请求请求=请求构建器urlurlBuilder构建方法“获得”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配置然后函数响应控制台日志JSONstringify响应数据}函数错误控制台日志错误}
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“article_attachments”“article_id”23“content_type”“应用程序/ pdf”“content_url”“https://company.亚博zendesk.com/hc/article_attachments/200109629/logo.pdf”“file_name”“logo.pdf”“id”1428“内联”“大小”1428}“article_id”23“content_type”“应用程序/ msword”“content_url”“https://company.亚博zendesk.com/hc/article_attachments/200109629/results.doc”“file_name”“results.doc”“id”2857“内联”“大小”234}]}

列出文章内联附件

  • GET / api / v2 / help_center{/地区}/文章/ {article_id} /附件/内联

列出文章的所有内联附件。

请注意{/地区}是管理员和代理的可选参数。终端用户和匿名用户必须填写。

允许

  • 代理
  • 最终用户,只要他们可以查看相关的文章

参数

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

代码示例

旋度
              
旋度https://子域名}.亚博zendesk.com/api/v2/help_center/语言环境}/文章/article_id}/附件/ inline.json- v - uemail_address}密码}
              
进口“fmt”“输入输出”“net/http”函数主要url:=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /附件/内联”方法:=“获得”要求的事情犯错:=httpNewRequest方法url如果犯错! =fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=&http客户端}res犯错:=客户端要求的事情如果犯错! =fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! =fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttp*OkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /附件/内联”newBuilder请求请求=请求构建器urlurlBuilder构建方法“获得”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配置然后函数响应控制台日志JSONstringify响应数据}函数错误控制台日志错误}
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“article_attachments”“article_id”23“content_type”“应用程序/ jpeg”“content_url”“https://company.亚博zendesk.com/hc/article_attachments/200109629/logo.jpg”“file_name”“logo.jpg”“id”1428“内联”真正的“大小”1428}“article_id”23“content_type”“应用程序/ gif”“content_url”“https://company.亚博zendesk.com/hc/article_attachments/200109629/footer.gif”“file_name”“footer.gif”“id”2857“内联”真正的“大小”234}]}

显示物品附件

  • GET / api / v2 / help_center{/地区}/文章/ {article_id} /附件/ {article_attachment_id}

显示指定附件的属性。

请注意{/地区}是管理员和代理的可选参数。终端用户和匿名用户必须填写。请注意:省略{/ article_id}访问不关联的文章附件。

允许

  • 代理
  • 最终用户,只要他们可以查看相关的文章

参数

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

代码示例

旋度
              
旋度https://子域名}.亚博zendesk.com/api/v2/help_center/语言环境}/ /文章/附件article_attachment_id}. json- v - uemail_address}密码}
              
进口“fmt”“输入输出”“net/http”函数主要url:=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 1428 /附件/ 360026053753”方法:=“获得”要求的事情犯错:=httpNewRequest方法url如果犯错! =fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=&http客户端}res犯错:=客户端要求的事情如果犯错! =fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! =fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttp*OkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 1428 /附件/ 360026053753”newBuilder请求请求=请求构建器urlurlBuilder构建方法“获得”addHeader“内容类型”“application / json”addHeader“授权”凭证基本“电子邮件”“你的密码”构建响应响应=客户端newCall请求执行
Nodejs
              
varaxios=需要“axios”var配置=方法“得到”url“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 360026053753 /附件/ 1428”“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"}}axios配置然后函数响应控制台日志JSONstringify响应数据}函数错误控制台日志错误}
Python
              
进口请求url=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 1428 /附件/ 360026053753”=“内容类型”“application / json”}响应=请求请求“获得”url身份验证=“<用户名>”' <密码> '=打印响应文本
鲁比(人名)
              
需要“net/http”uri=URI“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/ 1428 /附件/ 360026053753”请求=HTTP得到uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应=HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK“article_attachment”“article_id”23“content_type”“应用程序/ jpeg”“content_url”“https://company.亚博zendesk.com/hc/article_attachments/200109629/logo.jpg”“file_name”“logo.jpg”“id”1428“内联”真正的“大小”1428}}

删除文章附件

  • 删除/ api / v2 / help_center{/地区}/文章/附件/ {article_attachment_id}

允许

  • 代理

参数

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

代码示例

旋度
              
旋度https://子域名}.亚博zendesk.com/api/v2/help_center/articles/attachments/article_attachment_id}. json- v - uemail_address}密码}- x删除
              
进口“fmt”“输入输出”“net/http”函数主要url:=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/附件/ 1428”方法:=“删除”要求的事情犯错:=httpNewRequest方法url如果犯错! =fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=&http客户端}res犯错:=客户端要求的事情如果犯错! =fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! =fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttp*OkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/附件/ 1428”newBuilder请求请求=请求构建器urlurlBuilder构建方法“删除”addHeader“内容类型”“application / json”addHeader“授权”凭证基本“电子邮件”“你的密码”构建响应响应=客户端newCall请求执行
Nodejs
              
varaxios=需要“axios”var配置=方法“删除”url“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/附件/ 1428“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"}}axios配置然后函数响应控制台日志JSONstringify响应数据}函数错误控制台日志错误}
Python
              
进口请求url=“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/附件/ 1428”=“内容类型”“application / json”}响应=请求请求“删除”url身份验证=“<用户名>”' <密码> '=打印响应文本
鲁比(人名)
              
需要“net/http”uri=URI“https://support.亚博zendesk.com/api/v2/help_center{/地区}/文章/附件/ 1428”请求=HTTP删除uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应=HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

204无内容
              
//状态204无内容