Menu

CRM 帮助

getRecords 方法

目的

您可以使用 getRecords 方法获取 API 请求中指定的所有用户数据。

请求 URL

XML 格式：
https://crm.zoho.com.cn/crm/private/xml/Leads/getRecords?authtoken=Auth Token&scope=crmapi

JSON 格式：
https://crm.zoho.com.cn/crm/private/json/Leads/getRecords?authtoken=Auth Token&scope=crmapi

请求参数

参数 数据类型 说明
authtoken* 字符串 验证您的 Zoho 凭据的加密字母数字字符串。
scope* 字符串 将数值指定为crmapi
selectColumns 字符串 模块（可选列）即线索（姓氏、网站、邮件）或全部
fromIndex 整数值 默认值 - 1
toIndex 整数值 默认值 - 20
最大值 - 200
sortColumnString 字符串 如果您使用sortColumnString参数，默认情况下数据按升序排列。
sortOrderString 字符串 默认值 - asc
如果您想要按降序排序，那么您必须通过 sortOrderString=desc。
lastModifiedTime DateTime 默认值：null
如果您指定了时间，已修改的数据将在配置时间后获取。
newFormat 整数值 newFormat=1：插入来自您的 CRM 账户的数据时排除有 "null" 的字段。
newFormat=2:插入来自您的 CRM 账户的数据时将有 "null" 的字段包括在内。
版本 整数值 version = 1：（默认值）这将基于之前的 API 执行即在进行强化之前获取响应。
version = 2： 这将基于上一次 API 执行获取响应。

* - 必填参数

注意：

  • 参考发布说明页面了解关于 API 执行中进行的强化的更多信息。

捕获错误

CRM API 提供独一无二的错误代码，可轻松为您的程序中出现的问题排除障碍，同时在 CRM 和您的应用程序之间完成数据同步。 如需了解关于不同错误代码和对应定义的更多内容，请参考错误代码。

其它说明

  • 从您的 Zoho CRM 中检索数据时，应用用户字段级别安全设置。 因此，如需获取所有用户数据，使用有最高角色（例如： CEO 和概要文件（例如： 管理员）的用户 ID。
  • fromIndex 和 toIndex 是可选参数。 默认情况下fromIndex 为 1 而 toIndex 为 20。
  • sortColumnString 和 sortOrderString 也是可选参数
  • lastModifiedTime参数的值应该采用年-月-日 小时：分钟：秒格式

示例

获取按账户名称排序的（降序） JSON 格式的所有账户（从 20 到 200）

URL 格式：

https://crm.zoho.com.cn/crm/private/json/Accounts/getRecords?newFormat=1&authtoken=sbdjEDBDJ445791323
&scope=crmapi&fromIndex=20&toIndex=200&sortColumnString=Account Name&sortOrderString=desc

获取 2008-05-27 00:00:00 后修改/创建的 XML 格式的所有账户

URL 格式：

https://crm.zoho.com.cn/crm/private/xml/Accounts/getRecords?newFormat=1&authtoken=sbdjEDBDJ1323
&scope=crmapi&lastModifiedTime=2008-05-27 00:00:00

获取 version = 1 的线索

https://crm.zoho.com.cn/crm/private/xml/Leads/getRecords?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(First Name,Last Name,Email,Company,Campaign Source)&version=1
这将返回响应，如下所示：

<Leads>
<row no="1">
<FL val="LEADID">2000000022020</FL>
<FL val="Company">Zillium</FL>
<FL val="First Name">Scott</FL>
<FL val="Last Name">James</FL>
<FL val="Email">scott@zillum.com</FL>
<FL val="CAMPAIGNID">2000000072001</FL>
<FL val="Campaign Source">Webinar</FL>
</row>
</Leads>

获取 version = 2 的线索

这将返回响应，如下所示：

<Leads>
<row no="1">
<FL val="LEADID">2000000022020</FL>
<FL val="Company">Zillium</FL>
<FL val="First Name">Scott</FL>
<FL val="Last Name">James</FL>
<FL val="Email">scott@zillum.com</FL>
</row>
</Leads>

 在未指定 newFormat 参数的情况下获取线索

注意：

  • 没有关于响应格式的指定时，默认值 "1" 分配给 newFormat 参数，即 newFormat = 1。

https://crm.zoho.com.cn/crm/private/xml/Leads/getRecords?authtoken=Auth Token&scope=crmapi&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company,No of Employees,Annual Revenue,Created By,Created Time)

这将返回响应，如下所示：

<Leads>
<row no="1">
<FL val="LEADID">2000000022020</FL>
<FL val="SMOWNERID">2000000018005</FL>
<FL val="Lead Owner">John</FL>
<FL val="Company">Zillium</FL>
<FL val="First Name">Scott</FL>
<FL val="Last Name">James</FL>
<FL val="No of Employees">10</FL>
<FL val="Annual Revenue">1000.0</FL>
<FL val="SMCREATORID">2000000016908</FL>
<FL val="Created By">John</FL>
<FL val="Created Time">2010-03-16 10:04:52</FL>
<FL val="Modified Time">2010-03-16 10:04:52</FL>
</row>
</Leads>

 newFormat=6 时获取

https://crm.zoho.com.cn/crm/private/xml/Leads/getRecords?authtoken=Auth Token&scope=crmapi
&newFormat=2&selectColumns=Leads(Lead Owner,First Name,Last Name,Company,Designation,Email,Phone,Fax,Mobile,Website,Lead Source,Lead Status,No of Employees,Annual Revenue)
这将返回响应，如下所示：

<Leads>
<row no="1">
<FL val="LEADID">2000000022020</FL>
<FL val="SMOWNERID">2000000018005</FL>
<FL val="Lead Owner">John</FL>
<FL val="Company">Zillium</FL>
<FL val="First Name">Scott</FL>
<FL val="Last Name">James</FL>
<FL val="Designation">null</FL>
<FL val="Email">null</FL>
<FL val="Phone">null</FL>
<FL val="Fax">null</FL>
<FL val="Mobile">null</FL>
<FL val="Website">null</FL>
<FL val="Lead Source">null</FL>
<FL val="Lead Status">null</FL>
<FL val="No of Employees">0</FL>
<FL val="Annual Revenue">0.0</FL>
</row>

 fromIndex=1, toIndex=25 时调用

https://crm.zoho.com.cn/crm/private/xml/Leads/getRecords?authtoken=Auth Token&scope=crmapi
&newFormat=1
&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company)
&fromIndex=1&toIndex=25

注意：

  • 这将返回 1 到 25 条记录。

使用 lastModifiedTime 调用

https://crm.zoho.com.cn/crm/private/xml/Leads/getRecords?authtoken=Auth Token&scope=crmapi
&newFormat=1&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company)
&lastModifiedTime=2010-04-21 11:09:23

注意：

  • 如果您指定了时间，已修改的数据将在配置时间后获取。

 newFormat=1 时从线索中选择所有字段

https://crm.zoho.com.cn/crm/private/xml/Leads/getRecords?authtoken=Auth Token&scope=crmapi
&newFormat=1&selectColumns=All

注意：

  • 这将返回所有有数值的字段。

 newFormat=2 时从线索中选择所有字段

https://crm.zoho.com.cn/crm/private/xml/Leads/getRecords?authtoken=Auth Token&scope=crmapi
&newFormat=2&selectColumns=All

注意：

  • 这将返回所有字段，包括 null 值字段。

 使用 lastModifiedTime、fromIndex 和 toIndex 调用

https://crm.zoho.com.cn/crm/private/xml/Leads/getRecords?authtoken=Auth Token&scope=crmapi&newFormat=1
&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company)
&lastModifiedTime=2010-04-21 11:09:23
&fromIndex=1
&toIndex=25

使用 lastModifiedTime、fromIndex 和 toIndex 调用（针对账户模块）

https://crm.zoho.com.cn/crm/private/xml/Accounts/getRecords?authtoken=Auth Token&scope=crmapi&newFormat=1
&selectColumns=Accounts(Account Owner,Account Name,Phone,Industry)
&lastModifiedTime=2010-04-21 11:09:23
&fromIndex=1
&toIndex=25

测试程序

您可以使用所附程序运行并测试在您的 Java 环境中 getRecords 方法的工作效果。
Java 程序包含以下内容：

  • 票据生成格式
  • 参数及其数值
  • 方法的实际使用

点击此处下载程序

依然找不到您想要的内容？

请给我们写邮件：support-crm@zohocorp.com.cn

© 2018, Zoho Corporation.保留所有权利.

北京市海淀区后屯路28号KPHZ国际技术转移中心三层 400-660-8680 京ICP备15015257号 京ICP证150718号