下载批量读取结果
目的
下载批量读取作业为CSV或ICS文件(仅适用于事件模块)。该文件将以.zip格式存在。提取它以获取CSV或ICS文件。
端点
- GET /read/{job_id}/result
Request 详细信息
Request URL
{api-domain}/crm/{version}/read/{job_id}/result
其中 job_id 是批量读取作业的唯一 ID。
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
scope=ZohoCRM.bulk.read
(或者)
scope=ZohoCRM.modules.{模块名称}.{操作类型}
可能的模块名称
潜在客户,账户,联系人,交易,活动,任务,案例,事件,电话,解决方案,产品,供应商,价格表,报价,销售订单,采购订单,发票,以及自定义
可能的操作类型
ALL - 完全访问相关记录
READ - 获取批量读取任务
注意
- 每分钟只允许下载10次请求。超过限制将导致用户收到错误(HTTP代码:429)的响应。
- 要了解更多关于批量API限制的信息,请点击这里。
- 只有在通过API限制数据访问选项在合规设置中被禁用时,才能获取到包含敏感健康数据的字段的值。如果该选项被启用,结果中的值将会是空的。
- 当从模块中请求所有字段时,批量读取API不会按照任何特定顺序排列字段。然而,如果你使用fields JSON数组指定一组字段,响应将保持与提供的顺序相同。
样本结果
CSV

ICS

对于CSV类型的导出,
- 如果在查询JSON中"fields"属性留空,CRM中可用的所有字段都会在CSV文件中列出。如果你只需要特定的字段,如上图所示,请指定导出的字段。
- "id"列默认添加到CSV文件中,它包含了导出记录的id。
- CSV文件中的"Data/Time"字段以ISO8601格式给出。
- 你可以在单个API调用中最多导出200,000条记录。
对于ICS类型的导出,
- 当你想将事件导出为ICS文件时,不支持"fields"属性。
- 如果你没有指定"file_type"为"ics",那么记录将默认以CSV格式导出。
- 你可以在单次API调用中最多导出20,000条记录。
- 要了解更多关于ICS文件的批量API限制,请点击这里。
可能的错误
- INVALID_URL_PATTERNHTTP 404
请检查尝试访问的URL是否正确
解决方案:指定的请求URL不正确。请指定一个有效的请求URL。请参考上述请求URL部分。 - OAUTH_SCOPE_MISMATCHHTTP 401
未经授权
解决方案:客户端没有ZohoCRM.bulk.read或ZohoCRM.modules.{module_name}.READ。创建具有有效范围的新客户端。请参考上述范围部分。 - NO_PERMISSIONHTTP 403
读取权限被拒绝
解决方案:用户没有读取记录的权限。请联系您的系统管理员。 - INTERNAL_ERRORHTTP 500
内部服务器错误
解决方案:服务器中出现意外且未处理的异常。请联系支持团队。 - INVALID_REQUEST_METHODHTTP 400
HTTP请求方法类型无效
解决方案:您指定了无效的HTTP方法来访问API URL。请指定一个有效的请求方法。请参考上述端点部分。 - AUTHORIZATION_FAILEDHTTP 400
用户没有足够的权限进行阅读。
解决方案:用户没有阅读记录的权限。请联系您的系统管理员。 - RESOURCE_NOT_FOUNDHTTP 404
请求的资源不存在。
解决方案:指定的工作ID无效。请指定一个有效的工作ID。