文件和附件APIs
附件提供了关于联系人或公司的更多信息,这些信息通常无法显示。您可能还需要向您的联系人发送图片、文本文件、视频或任何其他类型的文件。文件和附件API允许您获取附件列表,并上传或下载照片或文件。
获取附件列表
目的
获取与Zoho CRM中的记录关联的附件列表。
端点
- GET /{module_api_name}/{record_ID}/Attachments
Request 详情
Request URL
{api-domain}/crm/{version}/{module_api_name}/{record_id}/Attachments
支持的模块
潜在客户,账户,联系人,交易,活动,任务,案例,事件,呼叫,解决方案,产品,供应商,价格书,报价,销售订单,采购订单,发票,自定义,预约,服务和备注
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.modules.ALL
(或者)
ZohoCRM.modules.{模块名称}.{操作类型}
(和)
ZohoCRM.modules.attachments.{操作类型}
可能的模块名称
潜在客户,账户,联系人,交易,活动,任务,案例,事件,电话,解决方案,产品,供应商,价格表,报价,销售订单,采购订单,发票,自定义,预约,服务和笔记
可能的操作类型
全部 - 对附件的完全访问权限
读取 - 获取附件数据
参数
- fields string, mandatory
指定您希望在响应中接收其详细信息的字段的API名称。
样本请求
Response JSON Keys
- 所有者JSON 对象
代表记录的所有者,包括他们的姓名,ID和电子邮件。
- Modified_Time string
附件最后修改的日期和时间。
- File_Name string
代表上传附件的名称。
- Created_Time string
附件添加到记录的日期和时间。
- Size integer
附件的大小(以字节为单位)。
- Parent_Id JSON 对象
代表父记录的名称和ID。
- $editable boolean
代表用户是否可以编辑附件。
可能的值:
- 真:用户可以编辑附件。
- 假:用户无法编辑附件。
- $file_id string
代表存储在Zoho文件系统(ZFS)中的附件的唯一文件ID。
- $se_module string
代表父模块的API名称(例如,Leads,Deals,Contacts)。
- Modified_By JSON 对象
代表最后修改附件的用户(包括 ID,姓名和电子邮件)。
- id string
代表相关记录的唯一ID。
- Created_By JSON 对象
代表添加附件到记录的用户的名称,ID和电子邮件。
可能的错误
- INVALID_REQUEST_METHODHTTP 400
请求方法不正确。
解决方案: 使用 HTTP POST 方法来进行此API调用。任何其他请求方法都会导致此错误。 - AUTHORIZATION_FAILEDHTTP 400
用户没有足够的权限来阅读附件
解决方案:用户没有阅读附件详情的权限。请联系您的系统管理员。 - REQUIRED_PARAM_MISSINGHTTP 400
缺少预期的参数之一
解决方案:指定必需的参数。请参阅上面的参数部分以获取更多详细信息。 - INVALID_MODULEHTTP 400
给出的模块名称似乎无效
解决方案:您指定的模块名称无效,或者没有标签权限,或者该模块可能已从可用模块中删除。请指定一个有效的模块API名称。 - INVALID_MODULEHTTP 400
给定的模块在API中不受支持
解决方案:像Documents和Projects这样的模块不受支持。请指定一个有效的模块API名称。 - AUTHENTICATION_FAILUREHTTP 401
您没有使用有效的访问令牌授权API调用。
解决方案:在请求头中包含一个有效的访问令牌以授权API调用。 - OAUTH_SCOPE_MISMATCHHTTP 401
未授权
解决方案:创建一个具有有效范围的新访问令牌。请参考本页开头的范围部分。 - NO_PERMISSIONHTTP 403
被拒绝读取附件详情的权限
解决方案:用户没有读取附件详情的权限。请联系您的系统管理员。 - INVALID_URL_PATTERNHTTP 404
请求的URL不正确。
解决方案:指定一个有效的请求URL。请参考本页开头的请求URL部分以获取更多详细信息。 - INTERNAL_ERRORHTTP 500
服务器中出现意外且未处理的异常。
解决方案:联系support@zohocrm.com的支持团队。