人员提升详情
目的
要获取您组织的增强数据详情。
此 API 仅在 IN、AU、CA、US 和 SA 数据中心可用。请注意,您必须已从应用市场安装 Web Amigo 扩展才能US用人员信息增强 API。
端点
- GET /__zia_people_enrichment
- GET /__zia_people_enrichment/{job_ID]
请求详情
请求 URL
{api-domain}/crm/{version}/__zia_people_enrichment
获取特定的补全信息:
{api-domain}/crm/{version}/__zia_people_enrichment/{{job_id}}
job_id 是你创建人员补全时收到的ID。
标题
授权:Zoho-oauthtoken <access-token>
范围
ZohoCRM.settings.intelligence.ALL
(或)
ZohoCRM.settings.intelligence.READ
参数
- page可选
用于获取相应页面的记录列表。默认值为1。只接受正整数。
- per_page可选
用于获取每页可用的记录列表。默认值和最大可能值为100。仅接受正整数值。
- sort_by可选
用于根据创建时间对响应进行排序。可接受的值为created_time。
- sort_order可选
用于将响应按升序或降序排序。可选值为 asc 或 desc。
- status可选
使用 创建人员丰富 API,根据已安排作业的状态获取响应。可能的取值有 COMPLETED(已完成)、SCHEDULED(已安排)、FAILED(失败) 和 DATA_NOT_FOUND(未找到数据)。
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/__zia_people_enrichment"
-X GET
-H "Authorization: Zoho-oauthtoken <access-token>"获取所有人员扩展信息时的响应
当您获取所有已创建的人员丰富数据时,您将获得该任务的“id”、“状态”、“创建时间”和“创建者”。
获取所有丰富数据时的示例响应
Copied{
"__zia_people_enrichment": [
{
"id": "111111000000066005",
"status": "SCHEDULED",
"created_time": "2024-07-27T07:12:13Z",
"created_by": {
"id": "111111000000050755",
"name": "Patricia Boyle"
}
}
]
}获取特定人员信息时的响应
当你通过其ID获取特定的人员信息增强时,你会得到所增强字段的详细信息。
可能的错误
- NO_CONTENTHTTP 204
您的组织尚未创建数据丰富。请注意,此错误仅在您获取特定丰富数据时适用。
解决方法:为您的组织创建数据丰富。 - INVALID_DATAHTTP 400
请注意,此错误仅在你获取所有扩展信息时适用。
- 你为 "sort_by" 参数提供了无效的值。请注意,此错误仅在你获取特定扩展信息时适用。
解决方法:你只能按创建时间排序。 - "status" 参数的值不正确。
解决方法:可用的值为 COMPLETED(已完成)、SCHEDULED(已安排)、FAILED(失败)、以及 DATA_NOT_FOUND(未找到数据)。 - "sort_order" 参数的值无效。
解决方法:此参数可用的值为 asc(升序)和 desc(降序)。
- 你为 "sort_by" 参数提供了无效的值。请注意,此错误仅在你获取特定扩展信息时适用。
- FEATURE_NOT_ENABLEDHTTP 400
您的账户未启用数据增强功能。
解决方法:请启用数据增强功能或联系您的系统管理员。 - FEATURE_NOT_SUPPORTEDHTTP 400
您的CRM版本不支持数据丰富功能。
解决方法:数据丰富功能仅适用于CRM的企业版和旗舰版。请升级您的版本或联系 support@zohoCRM.com 获取支持。 - OAUTH_SCOPE_MISMATCHHTTP 401
您没有访问此 API 的正确权限范围。
解决方法:创建一个包含“权限范围”部分所述权限的新令牌,然后重试此 API。 - NO_PERMISSIONHTTP 403
您没有管理或查看数据增强的权限来访问此功能。
解决方法:请联系您的系统管理员。 - INTERNAL_SERVER_ERRORHTTP 500
服务器发生未处理和意外的异常。
解决方法:请联系support@zohocrm.com获取帮助。
特定人员提升的示例回复
Copied{
"__zia_people_enrichment": [
{
"enriched_data": {
"website": "spacex.com",
"email_infos": [
{
"type": "PROFESSIONAL",
"email": "e.musk@teslamotors.com"
},
{
"type": "PERSONAL",
"email": "elon.musk@spacex.com"
},
{
"type": "PERSONAL",
"email": "emusk@spacex.com"
},
{
"type": "PERSONAL",
"email": "emusk@solarcity.com"
},
{
"type": "PERSONAL",
"email": "elon@spacex.com"
},
{
"type": "PROFESSIONAL",
"email": "elon.musk@teslamotors.com"
},
{
"type": "PROFESSIONAL",
"email": "emusk@tesla.com"
},
{
"type": "PROFESSIONAL",
"email": "emusk@teslamotors.com"
},
{
"type": "PROFESSIONAL",
"email": "elon@teslamotors.com"
},
{
"type": "PROFESSIONAL",
"email": "elon@solarcity.com"
},
{
"type": "PROFESSIONAL",
"email": "elonmuskoffice@spacex.com"
},
{
"type": "PERSONAL",
"email": "elonmusk@gmail.com"
},
{
"type": "PERSONAL",
"email": "elonmusk@yahoo.com"
},
{
"type": "PERSONAL",
"email": "elonmuskoffice@teslamotors.com"
},
{
"type": "PERSONAL",
"email": "elon_musk@aztecgrill.com"
},
{
"type": "PERSONAL",
"email": "elon.musk@tesla.com"
}
],
"gender": null,
"company_info": {
"industries": [
"Automotive"
],
"name": "Spacex",
"experiences": [
{
"end_period": null,
"company_name": "Tesla",
"title": "Chief Executive Officer",
"primary": false,
"start_period": null
},
{
"end_period": "2002",
"company_name": "Paypal",
"title": "Co Founder",
"primary": false,
"start_period": "1999"
},
{
"end_period": "1999",
"company_name": "Zip2 Corp. (Acquired by Compaq / Alta Vista)",
"title": "Co Founder",
"primary": false,
"start_period": "1995"
},
{
"end_period": null,
"company_name": "Spacex",
"title": "Chief Executive Officer and Chief Technology Officer",
"primary": true,
"start_period": "2002"
},
{
"end_period": null,
"company_name": "Solarcity",
"title": "Chairman and Co Founder",
"primary": false,
"start_period": "2006"
}
]
},
"last_name": "Musk",
"educations": [
{
"majors": null,
"school_name": "Wharton School",
"degrees": null
},
{
"majors": [
"Economics"
],
"school_name": "The Wharton School",
"degrees": [
"Bachelors",
"Bachelor of Arts"
]
},
{
"majors": [
"Physics",
"Philosophy"
],
"school_name": "Stanford University",
"degrees": [
"Doctorates",
"Doctor of Philosophy"
]
},
{
"majors": [
"Physics"
],
"school_name": "University of Pennsylvania",
"degrees": [
"Bachelors",
"Bachelor of Science"
]
}
],
"skills": null,
"primary_address_info": {
"continent": "North America",
"country": "United States",
"name": "El Segundo, California, United States",
"region": "California",
"primary": true
},
"name": "Elon Musk",
"primary_email": "e.musk@teslamotors.com",
"id": "0Z3xGk0Aip0yvSi+sIQjxQ==",
"designation": "Chief Executive Officer",
"first_name": "Elon",
"primary_contact": "+1 310-414-6555",
"social_media": [
{
"media_type": "facebook.com",
"media_url": [
"facebook.com/elon.musk.7"
]
},
{
"media_type": "crunchbase.com",
"media_url": [
"crunchbase.com/person/elon-musk"
]
},
{
"media_type": "flickr.com",
"media_url": [
"flickr.com/people/elonmusk"
]
},
{
"media_type": "instagram.com",
"media_url": [
"instagram.com/elonmusk"
]
},
{
"media_type": "klout.com",
"media_url": [
"klout.com/elonmusk"
]
},
{
"media_type": "about.me",
"media_url": [
"about.me/elonmusk"
]
},
{
"media_type": "linkedin.com",
"media_url": [
"linkedin.com/in/emusk"
]
},
{
"media_type": "twitter.com",
"media_url": [
"twitter.com/elonmusk"
]
}
]
},
"enrich_based_on": {
"social": {
"twitter": "twitter.com/elonmusk",
"facebook": "facebook.com/elonmusk",
"linkedin": "linkedin.com/elonmusk"
},
"name": "elon musk",
"company": {
"website": "www.spacex.com",
"name": "spacex"
},
"email": "elonmusk@gmail.com"
},
"id": "1941874000003442382",
"status": "COMPLETED"
}
]
}