Zoho crm Logo

丰富配置

数据增强

Zia,Zoho CRM 的人工智能助手,可以帮助您确保您的 CRM 数据完整且最新。根据如公司网站、公司名称等少量信息,Zia 会爬取网页,并检索补充信息,如公司地址、电话、员工人数、CEO 的社交媒体账号以及其他公开信息。这称为数据丰富。更多详情请参考 本文。

当您启用数据丰富功能时,可以将互联网上可用的数据与Zoho CRM中的字段进行映射。系统定义字段的数据映射是默认进行的,但您也可以与自定义字段进行映射。此映射称为配置。

目的

使用此 API 获取数据增强配置的详细信息。此 API 会为您提供增强字段与其对应的 CRM 字段的映射关系,以实现数据增强。

端点

  • GET /settings/zia/data_enrichment

请求详情

请求 URL

{api-domain}/crm/{version}/settings/zia/data_enrichment

支持的模块

潜在客户、联系人、Account、Vendors和自定义

标题

授权:Zoho-oauthtoken<access-token>

范围

ZohoCRM.Zia.enrichment.ALL
(或)
ZohoCRM.Zia.enrichment.READ

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/zia/data_enrichment"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

响应 JSON

  • id字符串

    丰富配置的唯一ID。

  • type字符串

    丰富类型。可能的取值有organization表示组织丰富,以及personal表示个人丰富。

  • 模块JSON 对象

    为此配置创建的模块的 ID 和 API 名称。

  • 状态布尔值

    配置的状态。true 表示配置为激活状态,false 表示配置为禁用状态。

  • input_data_field_mappingJSON 数组 

    丰富字段与Zoho CRM中字段的映射。这些丰富字段是根据其触发的数据在其他字段中得到丰富的依据。例如,如果您在潜在客户模块中将“公司”配置为丰富字段,那么在创建或更新潜在客户时,只要您为公司字段输入值,其他字段的数据将会根据映射自动填充为丰富的数据。

    • enrich_fieldJSON 对象 

      丰富字段的名称和显示标签。Zia将会在互联网上查找有关此字段的数据。

    • CRM_field JSON 对象 

      CRM中该字段的唯一ID、名称和API名称。对此字段的输入会触发在output_data_field_mapping中指定字段的数据丰富过程。

  • output_data_field_mappingJSON 数组 

    Zoho CRM 中增强字段与字段的映射。每当为 "input_data_field_mapping" 中指定的字段输入数值时,CRM 中的这些字段将根据互联网上可用的数据被自动丰富。

    • enrich_fieldJSON 对象 

      增强字段的名称与显示标签。Zia 将通过互联网查找关于此字段的数据,并将其丰富到映射字段的数据中。

    • CRM_fieldJSON 对象 

      CRM 中字段的唯一 ID、名称和 API 名称。当启用富化且 Zia 找到相关数据后,CRM 中相应的字段将会被更新。

  • modified_timestring

    丰富详情最后一次修改的日期和时间,格式为 ISO8601。

  • modified_byJSON 对象

    修改丰富信息详情的用户的唯一ID和姓名。

可能的错误

  • NO_CONTENTHTTP 204

    您的组织未配置数据丰富。
    解决方法:为您的组织配置数据丰富。

  • FEATURE_NOT_ENABLEDHTTP 400

    您的账户尚未启用数据丰富功能。
    解决方法:请启用数据丰富功能或联系您的系统管理员。

  • FEATURE_NOT_SUPPORTEDHTTP 400

    数据丰富功能在您的CRM版本中不可用。
    解决方法:数据丰富功能仅适用于CRM企业版和旗舰版。请升级您的版本,或者联系 support@zohoCRM.com 获取支持。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    您没有访问此 API 的相应权限范围。
    解决方法:使用“权限范围”部分中提到的权限创建一个新令牌,然后重试此 API。

  • INTERNAL_SERVER_ERRORHTTP 500

    服务器中出现未处理和意外的异常。
    解决方法:请联系 support@zohocrm.com 寻求帮助。

示例回复

Copied{
    "data_enrichment": [
        {
            "id": "111112000000059747",
            "type": "organization",
            "module": {
                "id": "111112000000002405",
                "api_name": "Leads"
            },
            "status": true,
            "input_data_field_mapping": [
                {
                    "enrich_field": {
                        "name": "org_name",
                        "display_label": "Organization Name"
                    },
                    "crm_field": {
                        "id": "111112000000004381",
                        "api_name": "Company",
                        "name": "Company"
                    }
                },
                {
                    "enrich_field": {
                        "name": "email",
                        "display_label": "Email"
                    },
                    "crm_field": {
                        "id": "111112000000004391",
                        "api_name": "Email",
                        "name": "Email"
                    }
                },
                {
                    "enrich_field": {
                        "name": "org_website",
                        "display_label": "Website"
                    },
                    "crm_field": {
                        "id": "111112000000004399",
                        "api_name": "Website",
                        "name": "Website"
                    }
                }
            ],
            "created_time": "2024-05-13T19:35:23+09:00",
            "created_by": {
                "id": "111112000000055001",
                "name": "Patricia Boyle"
            },
            "modified_time": "2024-05-13T19:35:23+09:00",
            "modified_by": {
                "id": "111112000000055001",
                "name": "Patricia Boyle"
            }
        }
    ]
}