批量读取API - 概述
Bulk Read API允许您高效地获取大量数据。它对于导出大量数据或备份数据而不显著影响您的API限制非常有用。
注意
- 异步处理:响应不会立即可用。
- 通过回调通知:当数据准备就绪时,您可以在指定的回调URL处接收通知。
- 轮询选项:或者,您可以定期检查作业状态。
- 结果只能以可下载的CSV文件或ICS文件的形式提供。
- 您只能将记录作为ICS文件导出到Events模块。
Zoho CRM中的批量读取API是如何工作的
批量读取API遵循三步处理过程:
步骤1:创建批量读取任务
- 发起一个POST API调用来创建一个批量读取任务。
- 提供模块名称、需要导出的字段列表以及筛选条件来指定您需要的数据。
- 响应中包含一个独特的工作 ID(id),它作为您请求的参考。
步骤2:检查工作状态
- 如果您希望在工作完成时自动通知,创建工作时请指定一个回调URL。
- 或者,您可以通过使用作业ID进行GET API 调用,定期查询作业状态。
步骤3:下载结果
- 一旦工作成功完成,API响应会在result属性中包含一个download_url。
- 调用download_url来下载ZIP文件。
- ZIP文件包含以CSV或ICS格式导出的数据。