灵途小工单灵途小工单
首页文档
进入工作台
开发文档OpenAPI

开始使用

  • 介绍
  • 快速开始
  • 认证与权限

业务 API

  • 账号与空间
  • 工单
  • 客户
  • 供应商
  • 收支
  • 标签与统计
  • 交流

接口约定

  • 请求与响应
  • 附件
  • 错误与重试
目录 · 附件

开始使用

  • 介绍
  • 快速开始
  • 认证与权限

业务 API

  • 账号与空间
  • 工单
  • 客户
  • 供应商
  • 收支
  • 标签与统计
  • 交流

接口约定

  • 请求与响应
  • 附件
  • 错误与重试

附件

先上传,后关联。附件只通过鉴权入口读取。

上传与关联

各业务的 POST attachments 接受 multipart/form-data,字段为 file,同样要求 Idempotency-Key。工单及客户供应商跟进单文件最多 20MB;收支凭证最多 10MB;交流图片或视频最多 100MB。

上传返回 id、objectKey、name、mimeType、size、downloadUrl。工单关联 id;客户和供应商创建跟进使用 attachmentKey、attachmentName、attachmentSize、attachmentMimeType;收支使用 attachmentKey 与 attachmentName;交流使用 media 对象。

收支凭证接受常见图片与 PDF,并检查文件内容;工单支持图片、办公文件、Markdown、HTML 等已开放类型。HTML 下载为附件,不作为 API 页面执行。

下载权限

downloadUrl 是需 Bearer Key 的相对地址,请与 API 服务域名拼接。未关联附件只有上传者可读取;已关联附件还检查对应业务的读取权限。

历史附件使用 objectKey 进行引用;仅服务返回的下载入口可用于受控读取,不把私有对象存储地址作为公开链接分享。

接口参考

GET

下载附件

/api/v1/workspaces/{workspaceId}/tickets/attachments/{attachmentId}

cURL
curl --request GET "$XGD_BASE_URL/api/v1/workspaces/$WORKSPACE_ID/tickets/attachments/{attachmentId}" \
  --header "Authorization: Bearer $AGENT_API_KEY"

成功返回文件流。权限、字段类型与错误处理见本页业务说明及错误与重试。

GET

下载附件

/api/v1/workspaces/{workspaceId}/customers/attachments/{attachmentId}

cURL
curl --request GET "$XGD_BASE_URL/api/v1/workspaces/$WORKSPACE_ID/customers/attachments/{attachmentId}" \
  --header "Authorization: Bearer $AGENT_API_KEY"

成功返回文件流。权限、字段类型与错误处理见本页业务说明及错误与重试。

GET

下载附件

/api/v1/workspaces/{workspaceId}/suppliers/attachments/{attachmentId}

cURL
curl --request GET "$XGD_BASE_URL/api/v1/workspaces/$WORKSPACE_ID/suppliers/attachments/{attachmentId}" \
  --header "Authorization: Bearer $AGENT_API_KEY"

成功返回文件流。权限、字段类型与错误处理见本页业务说明及错误与重试。

GET

下载附件

/api/v1/workspaces/{workspaceId}/finance/attachments/{attachmentId}

cURL
curl --request GET "$XGD_BASE_URL/api/v1/workspaces/$WORKSPACE_ID/finance/attachments/{attachmentId}" \
  --header "Authorization: Bearer $AGENT_API_KEY"

成功返回文件流。权限、字段类型与错误处理见本页业务说明及错误与重试。

GET

下载附件

/api/v1/workspaces/{workspaceId}/community/attachments/{attachmentId}

cURL
curl --request GET "$XGD_BASE_URL/api/v1/workspaces/$WORKSPACE_ID/community/attachments/{attachmentId}" \
  --header "Authorization: Bearer $AGENT_API_KEY"

成功返回文件流。权限、字段类型与错误处理见本页业务说明及错误与重试。

上一篇请求与响应下一篇错误与重试

本页内容

上传与关联下载权限接口参考

深圳市灵途造物科技有限责任公司

客户需求,有记录,有跟进。

© 2026 灵途造物|粤ICP备2025506773号-3