REST API 文档

  • 从线索模块的第 1 页获取记录
  • 获取已批准的记录
  • 获取已转化的记录
  • 获取包含公司字段的记录
+
    • 记录 API - 示例
      • 从线索模块的第 1 页获取记录
      • 获取已批准的记录
      • 获取已转化的记录
      • 获取包含公司字段的记录
      • 按条件搜索记录
      • 按关键字搜索记录

获取记录 - 示例

本节中使用的例子使用REST API资源来检索、插入、更新和删除记录,以及其他与记录相关的操作。

从线索模块的第1页获取记录列表

用途

从线索模块的第1页获取记录列表。

请求 URL

https://www.zohoapis.com.cn/crm/v2/{module_api_name}

module_api_name - 模块的API名称。

作用域

scope=ZohoCRM.modules.all
(or)
scope=ZohoCRM.modules.{module_name}.{operation_type}

可能的模块名称 可能的操作类型
线索,客户,联系人,商机,市场活动,任务,服务支持,活动(event),通话,解决方案,产品,供货商,价格表,报价,销售订单,采购订单,发货单,定制模块,备注,审批,数据分析,搜索和活动(activities) ALL - 对记录的完全访问
READ - 从模块获取记录

请求方法

GET

参数

参数名称 数据类型 描述 可能的值
fields(可选) 字符串 列出所有关于某字段的模块记录 用逗号分隔多个字段 API 名称。例如:Last_Name,Email
sort_order (可选) 字符串 通过升序或降序对可用的记录列表进行排序 asc - 升序排序
desc - 降序排序
sort_by (可选) 字符串 根据给定的字段对可用的记录列表进行排序 字段 API 名称
例如:Email
converted (可选) 字符串 获取已转化的记录列表 true - 只获取已转化的记录
false - 只获取未转化的记录
both - 获取所有记录
approved (可选) 字符串 获取已批准的记录列表 true - 只获取已批准的记录
false - 只获取未经批准的记录
both - 获取所有记录
page (可选) 整型 从指定页中获取记录列表。页面编号默认值是 1 只支持正整数值
per_page (可选) 整型 获取每页的可用记录列表。每页的默认值是 200 只支持正整数值
cvid (可选) 整型 根据自定义视图获取记录列表 {custom_view_id}
Curl

样本请求:

curl "https://www.zohoapis.com.cn/crm/v2/Leads?page=1&per_page=2"

-X GET

-H "Authorization: Zoho-oauthtoken d92d401c803988c5cb849d0b4215f52

复制样本代码

样本响应:

获取已批准的记录

用途

用来获取已批准的记录列表

请求 URL

https://www.zohoapis.com.cn/crm/v2/Tasks?approved=true

作用域

scope=ZohoCRM.modules.all
(or)
scope=ZohoCRM.modules.{module_name}.{operation_type}

可能的模块名称 可能的操作类型
线索,客户,联系人,商机,市场活动,任务,服务支持,活动(event),通话,解决方案,产品,供货商,价格表,报价,销售订单,采购订单,发货单,定制模块,备注,审批,数据分析,搜索和活动(activities) ALL - 对记录的完全访问
READ - 从模块获取记录

请求方法

GET

参数

参数名称 数据类型 描述 可能的值
fields(可选) 字符串 列出所有关于某字段的模块记录 用逗号分隔多个字段 API 名称。例如:Last_Name,Email
sort_order (可选) 字符串 按升序或降序对可用的记录列表进行排序 asc - 升序排序
desc - 降序排序
sort_by (可选) 字符串 根据给定的字段对可用的记录列表进行排序 字段 API 名称
例如:Email
converted (可选) 字符串 获取已转化的记录列表 true - 只获取已转化的记录
false - 只获取未转化的记录
both - 获取所有记录
approved (可选) 字符串 获取已批准的记录列表 true - 只获取已批准的记录
false - 只获取未经批准的记录
both - 获取所有记录
page (可选) 整型 从指定页中获取记录列表。页面编号默认值是 1 只支持正整数值
per_page (可选) 整型 获取每页的可用记录列表。每页的默认值是 200 只支持正整数值
cvid (可选) 整型 根据自定义视图获取记录列表 {custom_view_id}

请求方法

GET

Curl

样本请求:

curl "https://www.zohoapis.com.cn/crm/v2/Tasks?approved=true"

-X GET

-H "Authorization: Zoho-oauthtoken d92d401c803988c5cb849d0b4215f52

复制样本代码

样本响应:

获取已转化的记录

用途

用来获取已转化的记录列表。

请求 URL

https://www.zohoapis.com.cn/crm/v2/Leads?converted=true

作用域

scope=ZohoCRM.modules.all
(or)
scope=ZohoCRM.modules.{module_name}.{operation_type}

可能的模块名称 可能的操作类型
线索,客户,联系人,商机,市场活动,任务,服务支持,活动(event),通话,解决方案,产品,供货商,价格表,报价,销售订单,采购订单,发货单,定制模块,备注,审批,数据分析,搜索和活动(activities) ALL - 对记录的完全访问
READ - 从模块获取记录

请求方法

GET

参数

参数名称 数据类型 描述 可能的值
fields(可选) 字符串 列出所有关于某字段的模块记录 用逗号分隔多个字段 API 名称。例如:Last_Name,Email
sort_order (可选) 字符串 按升序或降序对可用的记录列表进行排序 asc - 升序排序
desc - 降序排序
sort_by (可选) 字符串 根据给定的字段对可用的记录列表进行排序 字段 API 名称
例如:Email
converted (可选) 字符串 用来获取已转化的记录列表 true - 只获取已转化的记录
false - 只获取未转化的记录
both - 获取所有记录
approved (可选) 字符串 用来获取已批准的记录列表 true - 只获取已批准的记录
false - 只获取未经批准的记录
both - 获取所有记录
page (可选) 整型 从指定页中获取记录列表。页面编号默认值是 1 只支持正整数值
per_page (可选) 整型 获取每页的可用记录列表。每页的默认值是 200 只支持正整数值
cvid (可选) 整型 根据自定义视图获取记录列表 {custom_view_id}

请求方法

GET

Curl

样本请求:

curl "https://www.zohoapis.com.cn/crm/v2/Leads?converted=true"

-X GET

-H "Authorization: Zoho-oauthtoken d92d401c803988c5cb849d0b4215f52

复制样本代码

样本响应:

获取包含公司字段的记录

用途

获取包含公司字段的记录列表。

请求 URL

https://www.zohoapis.com.cn/crm/v2/Leads?fields=Company

作用域

scope=ZohoCRM.modules.all
(or)
scope=ZohoCRM.modules.{module_name}.{operation_type}

可能的模块名称 可能的操作类型
线索,客户,联系人,商机,市场活动,任务,服务支持,活动(event),通话,解决方案,产品,供货商,价格表,报价,销售订单,采购订单,发货单,定制模块,备注,审批,数据分析,搜索和活动(activities) ALL - 对记录的完全访问
READ - 从模块获取记录

请求方法

GET

参数

参数名称 数据类型 描述 可能的值
fields(可选) 字符串 列出所有关于某字段的模块记录 用逗号分隔多个字段 API 名称。例如:Last_Name,Email
sort_order (可选) 字符串 按升序或降序对可用的记录列表进行排序 asc - 升序排序
desc - 降序排序
sort_by (可选) 字符串 根据给定的字段对可用的记录列表进行排序 字段 API 名称
示例: Email
converted (可选) 字符串 获取已转化的记录列表 true - 只获取已转化的记录
false - 只获取未转化的记录
both - 获取所有记录
approved (可选) 字符串 获取已批准的记录列表 true - 只获取已批准的记录
false - 只获取未经批准的记录
both - 获取所有记录
page (可选) 整型 从指定页中获取记录列表。页面编号默认值是 1 只支持正整数值
per_page (可选) 整型 获取每页的可用记录列表。每页的默认值是 200 只支持正整数值
cvid (可选) 整型 基于自定义视图获取记录列表 {custom_view_id}

请求方法

GET

Curl

样本请求:

curl "https://www.zohoapis.com.cn/crm/v2/Leads?fields=Company"

-X GET

-H "Authorization: Zoho-oauthtoken d92d401c803988c5cb849d0b4215f52

复制样本代码

样本响应:

按照条件搜素记录

用途

检索与您的搜索条件匹配的记录

请求 URL

https://www.zohoapis.com.cn/crm/v2/{module_api_name}/search

module_api_name - 模块的API名称。

作用域

scope=ZohoCRM.modules.all
(or)
scope=ZohoCRM.modules.{module_name}.{operation_type}

可能的模块名称 可能的操作类型
线索,客户,联系人,商机,市场活动,任务,服务支持,活动(events),通话,解决方案,产品,供货商,价格表,报价,销售订单,采购订单,发货单,定制模块,备注和活动(activities)。 ALL - 对记录的完全访问
READ - 获取模块中的记录

请求方法

GET

参数

参数名称 数据类型 描述
criteria 字符串 按照下面显示的条件执行搜索。 (({apiname}:{starts_with|equals}:{value}) 和 ({apiname}:{starts_with|equals}:{value})) 你可以最多通过 10 个条件(相同或不同列)执行搜索,如上所示条件包含“等于(equals)”和“开始于(starts_with)”。
email 字符串 {email} - 按照邮箱执行模块搜索。指定模块的所有邮箱字段都将被搜索和列出。
phone 字符串 {Phone} - 按照电话号码执行模块搜索。指定模块的所有电话字段都将被搜索和列出。
page (可选) 整型 从指定页中获取记录列表。页面编号默认值是 1
per_page (可选) 整型 获取每页的可用记录列表。每页的默认值是 200
Curl Java PHP Python
复制样本代码

样本请求:

curl "https://www.zohoapis.com.cn/crm/v2/Leads/search?criteria=((Last_Name:starts_with:G) and (Email:equals:deborah@healthnet.com))"

-X GET

-H "Authorization: Zoho-oauthtoken d92d401c803988c5cb849d0b4215f52"

复制样本代码

样本请求:

Search by Phone:

ZCRMModule module = ZCRMModule.getInstance("Contacts"); // 模块 API 名称
BulkAPIResponse response = module.searchByPhone("123456789", 1, 10);// 获取某页的某几条记录
List<ZCRMRecord> records = (List<ZCRMRecord>) response.getData(); //匹配的记录

复制样本代码

样本请求:

Search by Email:

ZCRMModule module = ZCRMModule.getInstance("Contacts"); // 模块 API 名称
BulkAPIResponse response = module.searchByEmail("bruce@wayne.com", 1, 10);// 获取某页的某几条记录
List<ZCRMRecord> records = (List<ZCRMRecord>) response.getData(); //匹配的记录

复制样本代码

样本请求:

$zcrmModuleIns = ZCRMModule::getInstance("Products");
$bulkAPIResponse=$zcrmModuleIns->searchRecords("ip");
$records = $bulkAPIResponse->getData(); // $records - ZCRMRecord 的实例数组。

复制样本代码

样本请求:

zclient, api_obj = ZohoCRMClient.get_client_objects(conf_file_location)
accounts_module = api_obj.load_crm_module(“Accounts”)
records = accounts_module.search_records(“test”, “test@domain.com“)
records.each do |r_id, r_obj|
print “r_id”, “r_obj.class”
end

复制样本代码

样本请求:

try:

  module_ins=ZCRMModule.get_instance('Products') #module API Name

  resp=module_ins.search_records('Orange') #search key word

    print resp.status_code

  resp_info=resp.info

    print resp_info.count

    print resp_info.page

    print resp_info.per_page

    print resp_info.is_more_records

  record_ins_arr=resp.data

    for record_ins in record_ins_arr:

        print record_ins.entity_id

        print record_ins.owner.id

        print record_ins.created_by.id

        print record_ins.modified_by.id

        print record_ins.created_time

        print record_ins.modified_time

        print record_ins.get_field_value('Product_Name')

        print record_ins.get_field_value('Product_Code')

        print record_ins.get_field_value('Vendor_Name')

        print record_ins.get_field_value('Commission_Rate')

        print record_ins.get_field_value('Qty_in_Demand')

        print record_ins.get_field_value('Tax')

        print record_ins.get_field_value('Unit_Price')

        print record_ins.get_field_value('Reorder_Level')

        print record_ins.get_field_value('Usage_Unit')

        print record_ins.get_field_value('Qty_Ordered')

        print record_ins.get_field_value('Qty_in_Stock')

        print record_ins.get_field_value('Sales_Start_Date')

        print record_ins.get_field_value('Sales_End_Date')

        print record_ins.get_field_value('Taxable')

        print record_ins.get_field_value('Support_Expiry_Date')

        print record_ins.get_field_value('Manufacturer')

        print record_ins.get_field_value('Description')

        print record_ins.field_data

        print "\n\n"

except ZCRMException as ex:

    print ex.status_code

    print ex.error_message

    print ex.error_code

    print ex.error_details

    print ex.error_content

复制样本响应

样本响应:按照条件

按照邮箱搜索记录

样本请求:

curl "https://www.zohoapis.com.cn/crm/v2/Leads/search?email=p.daly@zylker.com"

-X GET

-H "Authorization: Zoho-oauthtoken d92d401c803988c5cb849d0b4215f52"

复制样本响应

样本响应:

按照条件搜索记录

用途

根据特定的单词检索记录

请求 URL

https://www.zohoapis.com.cn/crm/v2/{module_api_name}/search

module_api_name - 模块的API名称。

作用域

scope=ZohoCRM.modules.all
(or)
scope=ZohoCRM.modules.{module_name}.{operation_type}

可能的模块名称 可能的操作类型
线索,客户,联系人,商机,市场活动,任务,服务支持,活动(events),通话,解决方案,产品,供货商,价格表,报价,销售订单,采购订单,发货单,定制模块,备注和活动(activities)。 ALL - 对记录的完全访问
READ - 获取模块中的记录

请求方法

GET

参数

参数名称 数据类型 描述
email 字符串 {email} - 按照邮箱执行模块搜索。指定模块的所有邮箱字段都将被搜索和列出。
phone 字符串 {Phone} - 按照电话号码执行模块搜索。指定模块的所有电话字段都将被搜索和列出。
word 字符串 {Word}- 按照指定关键字执行全局搜索。
page (可选) 整型 从指定页中获取记录列表。页面编号默认值是 1
per_page (可选) 整型 获取每个页面的可用记录列表。每页的默认值是 200
Curl Java PHP Python
复制样本代码

样本请求:

curl "https://www.zohoapis.com.cn/crm/v2/Leads/search?word=Partner"

-X GET

-H "Authorization: Zoho-oauthtoken d92d401c803988c5cb849d0b4215f52"

复制样本代码

样本请求:

Search by Phone:

ZCRMModule module = ZCRMModule.getInstance("Contacts"); // 模块 API 名称
BulkAPIResponse response = module.searchByPhone("123456789", 1, 10);// 获取某页的某几条搜索记录
List<ZCRMRecord> records = (List<ZCRMRecord>) response.getData(); //匹配的记录

复制样本代码

样本请求:

按照邮箱搜索:

ZCRMModule module = ZCRMModule.getInstance("Contacts"); // 模块 API 名称
BulkAPIResponse response = module.searchByEmail("bruce@wayne.com", 1, 10);// 获取某页的某几条搜索记录
List<ZCRMRecord> records = (List<ZCRMRecord>) response.getData(); //匹配的记录

复制样本代码

样本请求:

$zcrmModuleIns = ZCRMModule::getInstance("Products");
$bulkAPIResponse=$zcrmModuleIns->searchRecords("ip");
$records = $bulkAPIResponse->getData(); // $records - ZCRMRecord 的实例数组。

复制样本代码

样本请求:

zclient, api_obj = ZohoCRMClient.get_client_objects(conf_file_location)
accounts_module = api_obj.load_crm_module(“Accounts”)
records = accounts_module.search_records(“test”, “test@domain.com“)
records.each do |r_id, r_obj|
print “r_id”, “r_obj.class”
end

复制样本代码

样本请求:

try:

  module_ins=ZCRMModule.get_instance('Products') #module API Name

  resp=module_ins.search_records('Orange') #search key word

    print resp.status_code

  resp_info=resp.info

    print resp_info.count

    print resp_info.page

    print resp_info.per_page

    print resp_info.is_more_records

  record_ins_arr=resp.data

    for record_ins in record_ins_arr:

        print record_ins.entity_id

        print record_ins.owner.id

        print record_ins.created_by.id

        print record_ins.modified_by.id

        print record_ins.created_time

        print record_ins.modified_time

        print record_ins.get_field_value('Product_Name')

        print record_ins.get_field_value('Product_Code')

        print record_ins.get_field_value('Vendor_Name')

        print record_ins.get_field_value('Commission_Rate')

        print record_ins.get_field_value('Qty_in_Demand')

        print record_ins.get_field_value('Tax')

        print record_ins.get_field_value('Unit_Price')

        print record_ins.get_field_value('Reorder_Level')

        print record_ins.get_field_value('Usage_Unit')

        print record_ins.get_field_value('Qty_Ordered')

        print record_ins.get_field_value('Qty_in_Stock')

        print record_ins.get_field_value('Sales_Start_Date')

        print record_ins.get_field_value('Sales_End_Date')

        print record_ins.get_field_value('Taxable')

        print record_ins.get_field_value('Support_Expiry_Date')

        print record_ins.get_field_value('Manufacturer')

        print record_ins.get_field_value('Description')

        print record_ins.field_data

        print "\n\n"

except ZCRMException as ex:

    print ex.status_code

    print ex.error_message

    print ex.error_code

    print ex.error_details

    print ex.error_content

复制样本响应

样本响应:按照关键字

备注:

  • 由于搜索关键字是“合作伙伴”,响应将显示任意字段中包含“合作伙伴”关键字的所有记录。

按照邮箱搜索

样本请求:

curl "https://www.zohoapis.com.cn/crm/v2/Leads/search?email=p.daly@zylker.com"

-X GET

-H "Authorization: Zoho-oauthtoken d92d401c803988c5cb849d0b4215f52"

复制样本代码

样本响应: