Zoho crm Logo

人才培育

目的

Zia 会根据互联网上可用的数据在 Zoho CRM 中丰富数据。当你启用数据丰富功能后,某些字段会作为触发器,根据你设置的映射规则,丰富其他字段中的数据。例如,如果你将公司名称设置为其中一个触发字段,那么在创建或更新记录时输入该字段的数据,其他字段会根据该信息自动得到丰富。

个人信息丰富主要关注与个人相关的细节,例如其职位、联系方式、社交媒体资料和职业背景。这类数据有助于个性化互动并与联系人建立更牢固的关系。

US用此 API 在人员(个人)级别初始化或触发数据增强。此 API 会安排一个作业。请注意,你想要通过此 API 触发增强的模块,必须存在增强配置。
此 API 仅在 IN、AU、CA、US 和 SA 数据中心可用。请注意,你必须已经从市场安装了 Web Amigo 扩展,才能US用人员增强 API。

端点

  • POST /__zia_people_enrichment

请求详情

请求 URL

{api-domain}/crm/{version}/__zia_people_enrichment

标题

授权:Zoho-oauthtoken <访问令牌>

范围

ZohoCRM.settings.intelligence.ALL
(或)
ZohoCRM.settings.intelligence.CREATE

参数
  • module必填

    您想要触发或初始化增强的数据模块的 API 名称。使用 获取模块 API 来获取模块的 API 名称。

  • record_id可选

    您希望触发增强的数据记录的 ID。使用 获取记录 API 来获取模块中数据记录的 ID。

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/__zia_people_enrichment?module=Leads"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"
-X POST

输入 JSON

  • 基于以下内容丰富, JSON 对象

    要触发数据丰富操作的字段详细信息。请注意,您必须在输入中至少提供以下值之一。Zia 会根据这些值在网络上查找信息,并按照丰富配置对字段进行丰富。请注意,这些键的值必须至少为三个字符且只能为英文。

    • namestring

      此人的姓名。如果包含此键,您还必须包含“company”或“website”键。

    • 邮箱字符串

      此人的电子邮件地址。

    • 公司字符串

      该人员现在或曾经工作的公司名称。

    • 社交JSON 对象

      此人的 Facebook、LinkedIn 和 Twitter 账号。

示例输入

Copied{
    "__zia_people_enrichment": [
        {
            "enrich_based_on": {
                "name": "Test",
                "email": "sales@zohocorp.com",
                "company": {
                    "name": "zoho",
                    "website": "www.zoho.com"
                },
                "social": {
                    "facebook": "facebook.com/zoho",
                    "linkedin": "linkedin.com/zoho",
                    "twitter": "twitter.com/zoho"
                }
            }
        }
    ]
}

响应 JSON

  • codestring

    表示 API 状态的代码。“SCHEDULED”表示作业已被安排。

  • detailsJSON 对象

    已计划任务的唯一 ID。使用此 ID 在 获取组织配置 API 中获取增强的详细信息。

  • statusboolean

    增强的状态。

可能的错误

  • INVALID_DATAHTTP 400
    • 输入中一个或多个键的 API 名称不正确。
      解决方案:请参阅 “details” 键以获取不正确的键,并为其指定有效的值。
    • 模块的 API 名称不正确。
      解决方案:请输入正确的模块 API 名称。使用 获取模块 API 来获取模块的 API 名称。
    • 记录 ID 无效。
      解决方案:使用 获取记录 API 以获取模块中记录的 ID。
    • 键的值长度小于三个字符。
      解决方案:这些键的值必须至少为三个字符。
    • 您输入的值为其他语言。
      解决方案:这些键的值必须仅为英文。
    • 输入中键的数据类型不是字符串。
      解决方案:输入键的值必须为字符串。
  • MANDATORY_NOT_FOUNDHTTP 400

    您在输入中未指定键“enrich_based_on”。
    解决方法:“enrich_based_on”是必填输入键。

  • EXPECTED_FIELD_MISSINGHTTP 400

    您未在 "enrich_based_on" JSON 对象中指定任何键。
    解决方法:请在 "enrich_based_on" JSON 对象中至少指定 "name"、"email"、"social" 或 "company" 之一。

  • DEPENDENT_FIELD_MISSINGHTTP 400

    “company”和“name”是相互依赖的字段。您在输入中只指定了其中一个。
    解决方法: 请在输入中同时指定“company”和“name”两个字段。

  • LIMIT_EXCEEDEDHTTP 400

    您已为您的组织创建了超过 1500 个人员丰富化记录。
    解决方法: 您的组织最多只能创建 1500 个丰富化记录,也就是说,您最多可以使用不同字段组合在输入中调用此 API 15000 次。

  • REQUIRED_PARAM_MISSINGHTTP 400

    您在请求中未指定“module”参数。 
    解决方法:“module”是请求中的必填参数。

  • 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": [
        {
            "code": "SCHEDULED",
            "details": {
                "id": "1941874000003019012"
            },
            "message": "People Enrichment scheduled successfully",
            "status": "success"
        }
    ]
}