附件
您可以上传一个文件并将其附加到票据注释。附件以链接的形式出现在Zendesk代理界面的票据注释中。亚博如果启用了票据通知，则该附件将作为通知电子邮件中的链接显示。
使用Attachments API上传要附加的文件。方法将上载的文件附加到票据注释票API当向您正在创建或更新的票据添加注释时。
详细信息和示例请参见使用API添加票据附件．
这个API用于票证附件。要将文件附加到帮助中心中的项目，请参见文章的附件在帮助中心API文档中。
JSON格式
附件被表示为具有以下属性的JSON对象:
| 的名字 | 类型 | 只读 | 强制性的 | 描述 |
|---|---|---|---|---|
| content_type | 字符串 | 真正的 | 假 | 图像的内容类型。示例:image/png |
| content_url | 字符串 | 真正的 | 假 | 可以下载附件图像文件的完整URL。该文件可能托管在外部，因此要注意不要无意中发送Zendesk身份验证凭据。亚博看到使用url属性 |
| 删除 | 布尔 | 真正的 | 假 | 如果是，表示附件已删除 |
| file_name | 字符串 | 真正的 | 假 | 镜像文件的名称 |
| 高度 | 字符串 | 真正的 | 假 | 图像文件的高度，以像素为单位。如果高度未知，则返回null |
| id | 整数 | 真正的 | 假 | 创建时自动分配 |
| 内联 | 布尔 | 真正的 | 假 | 如果为真，则从附件列表中排除该附件，并且可以在票据的注释中引用该附件的URL。默认为false |
| malware_access_override | 布尔 | 真正的 | 假 | 如果为真，则可以下载标记为恶意软件的附件。如果为false，则不能下载这样的附件。 |
| malware_scan_result | 字符串 | 真正的 | 假 | 恶意软件扫描的结果。取值:“malware_found”、“malware_not_found”、“failed_to_scan” |
| mapped_content_url | 字符串 | 真正的 | 假 | 附件图像文件已映射到的URL |
| 大小 | 整数 | 真正的 | 假 | 图像文件的大小(以字节为单位) |
| 缩略图 | 数组 | 真正的 | 假 | 附件对象的数组。注意，照片缩略图没有缩略图 |
| url | 字符串 | 真正的 | 假 | 访问附件详细信息的URL |
| 宽度 | 字符串 | 真正的 | 假 | 图像文件的宽度，以像素为单位。如果width未知，则返回null |
表示为的文件附件对象
例子
｛“content_type”：“图像/ png”，“content_url”：“https://company.亚博zendesk.com/attachments/my_funny_profile_pic.png”，“file_name”：“my_funny_profile_pic.png”，“id”：928374，“大小”：166144，“缩略图”：［｛“content_type”：“图像/ png”，“content_url”：“https://company.亚博zendesk.com/attachments/my_funny_profile_pic_thumb.png”，“file_name”：“my_funny_profile_pic_thumb.png”，“id”：928375，“大小”：58298｝］｝
上传文件
POST / api / v2 /上传
上传一个可以附加到票据注释的文件。它不会将文件附加到注释。详细信息和示例请参见用API附加票证注释．
端点有一个required文件名查询参数。该参数指定当附加到票据注释时文件将被命名为什么(为代理提供关于文件的更多上下文)。该参数不能指定上传到本地系统的文件。虽然这两个名称可以不同，但它们的文件扩展名必须相同。如果它们不匹配，代理的浏览器或文件读取器在试图打开附件时可能会报错。
的内容类型头必须包含一个可识别的MIME类型，正确描述所上传文件的类型。如果不能发送已识别的正确类型，可能会导致不希望发生的行为。例如，浏览器内的音频播放可能会被浏览器的安全机制中断，因为上传的mp3类型不正确。
将多个文件添加到同一个上传是通过分割请求来处理的，并将从第一个请求接收到的API令牌传递给每个后续请求。令牌有效期为3天。
请注意:即使私人的附件在Zendesk Support实例中亚博启用，上传的文件对任何经过身份验证的用户都可见content_URL指定于JSON响应直到上传令牌被使用为止。一旦文件与票据或帖子相关联，可见性将限制为具有访问带有附件的票据或帖子的用户。
允许
- 最终用户
旋度
旋度“https://{子域名}.zendes亚博k.com/api/v2/uploads ?文件名= user_crash.log&token = {optional_token}”＼——data-binary @crash.log＼- h“内容类型:文本/普通”＼- v - u｛email_address｝：｛密码｝＼- x的帖子
示例响应(年代)
201年创建
//状态201已创建｛“上传”：｛“附件”：｛“content_type”：“图像/ png”，“content_url”：“https://company.亚博zendesk.com/attachments/token/tyBq1ms40dFaHefSIigxZpwGg/?name=crash.png”，“删除”：假，“file_name”：“crash.png”，“高度”：“62”，“id”：1503729607981，“内联”：假，“mapped_content_url”：“https://company.亚博zendesk.com/attachments/token/tyBq1ms40dFaHefSIigxZpwGg/?name=crash.png”，“大小”：5172，“缩略图”：［］，“url”：“https://company.亚博zendesk.com/api/v2/attachments/1503729607981.json”，“宽度”：“80”｝，“附件”：［｛“content_type”：“图像/ png”，“content_url”：“https://company.亚博zendesk.com/attachments/token/tyBq1ms40dFaHefSIigxZpwGg/?name=crash.png”，“删除”：假，“file_name”：“crash.png”，“高度”：“62”，“id”：1503729607981，“内联”：假，“mapped_content_url”：“https://company.亚博zendesk.com/attachments/token/tyBq1ms40dFaHefSIigxZpwGg/?name=crash.png”，“大小”：5172，“缩略图”：［］，“url”：“https://company.亚博zendesk.com/api/v2/attachments/1503729607981.json”，“宽度”：“80”｝］，“令牌”：“LXJdriewLBP8JrtzzkN7Ne4k6”｝｝
删除上传
删除/ api / v2 /上传/{牌}
允许
- 最终用户
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| 令牌 | 字符串 | 路径 | 真正的 | 上传附件的令牌 |
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/uploads/｛令牌｝＼- v - u｛email_address｝：｛密码｝- x删除
示例响应(年代)
204无内容
//状态204无内容零
显示附件
GET / api / v2 /附件/ {attachment_id}
显示附件详细信息。你可以得到的值attachment_id通过列出票据的注释来参数。看到评论列表．列表中的每个注释都有一个附件列表，该列表指定id对于每个附件。
允许
- 代理
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| attachment_id | 整数 | 路径 | 真正的 | 附件的ID |
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/attachments/｛attachment_id｝＼- v - u｛email_address｝：｛密码｝
示例响应(年代)
200好了
// Status 200 OK｛“附件”：｛“content_type”：“应用程序/二进制”，“content_url”：“https://company.亚博zendesk.com/attachments/myfile.dat”，“file_name”：“myfile.dat”，“id”：498483，“大小”：2532，“缩略图”：［］，“url”：“https://company.亚博zendesk.com/api/v2/attachments/498483.json”｝｝
更新恶意软件附件
把/ api / v2 /附件/ {attachment_id}
切换启用或限制代理访问检测到恶意软件的附件。
允许
- 管理员
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| attachment_id | 整数 | 路径 | 真正的 | 附件的ID |
例子的身体
｛“附件”：｛“malware_access_override”：真正的｝｝
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/attachments/｛attachment_id｝. json＼- h“application / json内容类型:- d'{"附件":{"malware_access_override": true}}'＼- v - u｛email_address｝：｛密码｝- x将
示例响应(年代)
200好了
// Status 200 OK｛“附件”：｛“content_type”：“应用程序/二进制”，“content_url”：“https://company.亚博zendesk.com/attachments/myfile.dat”，“file_name”：“myfile.dat”，“id”：498483，“大小”：2532，“缩略图”：［］，“url”：“https://company.亚博zendesk.com/api/v2/attachments/498483.json”｝｝
编辑评论附件
把/ api / v2 /票/ {ticket_id} /评论/ {comment_id} / {attachment_id} /修订/附件
编校允许您永久地删除票据上现有注释中的附件。一旦从注释中删除，附件就会被一个空的“reacted .txt”文件所取代。
修订是永久性的。无法撤消编校或查看已删除的内容。一旦票据被关闭，就不可能再编辑其附件。
此外，如果要编校内联附件，可以使用include_inline_images参数中的评论列表操作获取内联附件ID，并在请求URL中使用它。
允许
- 管理员
- 代理时对专业账号的座席启用删票功能
- 分配给具有编校票据内容权限的自定义角色的代理(仅限企业)
参数
| 的名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| attachment_id | 整数 | 路径 | 真正的 | 附件的ID |
| comment_id | 整数 | 路径 | 真正的 | 注释的ID |
| ticket_id | 整数 | 路径 | 真正的 | 机票的ID |
旋度
旋度https://｛子域名｝.亚博zendesk.com/api/v2/tickets/｛ticket_id｝/评论/｛comment_id｝/附件/｛attachment_id｝/编辑＼- h“application / json内容类型:- v - u｛email_address｝：｛密码｝-X PUT -d“{}”
示例响应(年代)
200好了
// Status 200 OK｛“附件”：｛“content_type”：“应用程序/二进制”，“content_url”：“https://company.亚博zendesk.com/attachments/myfile.dat”，“file_name”：“myfile.dat”，“id”：498483，“大小”：2532，“缩略图”：［］，“url”：“https://company.亚博zendesk.com/api/v2/attachments/498483.json”｝｝