Zoho crm Logo

获取组织丰富详情

目的

获取您的组织的丰富数据详情。

端点

  • GET /__zia_org_enrichment
  • GET /__zia_org_enrichment/{job_ID}

请求详情

请求 URL

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

获取特定富集信息:
{api-domain}/crm/{version}/__zia_org_enrichment/{{job_id}}
job_id 是你在创建组织信息富集时获得的 ID。

标题

授权: Zoho-oauthtoken <access-token>

范围

ZohoCRM.settings.intelligence.ALL/READ
(或)
ZohoCRM.settings.intelligence.READ

参数

  • page可选

    用于获取相应页面的记录列表。默认值为1。只接受正整数值。

  • per_page可选

    用于获取每页可用的记录数量。默认值和最大值均为100。仅接受正整数值。

  • sort_by可选

    用于根据创建时间对响应进行排序。可接受的值为created_time。

  • sort_order可选

    用于以升序或降序对响应进行排序。可选值为asc或desc。

  • 状态可选

    使用 创建组织丰富 API,根据已安排任务的状态获取响应。可能的取值包括 已完成(COMPLETED)、已安排(SCHEDULED)、失败(FAILED) 和 未找到数据(DATA_NOT_FOUND)。

样本请求

Copiedcurl "https://www.zohoapis.com/crm/v8/__zia_org_enrichment"
-X GET
-H "Authorization: Zoho-oauthtoken <access-token>"

获取所有组织增强信息时的响应

当您获取所有已创建的组织增强信息时,您将获得该任务的“id”、“状态”、“创建时间”和“创建人”。

获取所有富集项时的示例响应

Copied{
    "__zia_org_enrichment": [
        {
            "id": "111112000000071191",
            "status": "COMPLETED",
            "created_time": "2024-05-12T23:51:22Z",
            "created_by": {
                "id": "111112000000055001",
                "name": "Patricia Boyle"
            }
        },
        {
            "id": "111112000000071157",
            "status": "SCHEDULED",
            "created_time": "2024-05-12T23:55:02Z",
            "created_by": {
                "id": "111112000000055001",
                "name": "Patricia Boyle"
            }
        }
    ],
    "info": {
        "per_page": 200,
        "count": 2,
        "page": 1,
        "more_records": false
    }
}

获取特定组织丰富信息时的响应

当你通过其ID获取特定的组织丰富信息时,你将获得已丰富字段的详细信息。

可能的错误

  • NO_CONTENTHTTP 204

    您的组织尚未创建数据丰富化。
    解决方法:为您的组织创建数据丰富化。

  • INVALID_DATAHTTP 400
    • 您为“sort_by”参数提供了无效的值。
      解决方法:只能按创建时间排序。
    • “status”参数的值不正确。
      解决方法:可能的值为COMPLETED(已完成)、SCHEDULED(已计划)、FAILED(失败)和DATA_NOT_FOUND(数据未找到)。
    • “sort_order”参数的值无效。
      解决方法:该参数可能的值为asc(升序)和desc(降序)。
  • FEATURE_NOT_ENABLEDHTTP 400

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

  • FEATURE_NOT_SUPPORTEDHTTP 400

    数据增强功能在您的CRM版本中不可用。
    解决方法:数据增强功能仅适用于CRM的Enterprise和Ultimate版本。请升级您的版本或联系support@zohoCRM.com。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    您没有访问此 API 的相应权限范围。
    解决方法:请根据“权限范围”部分中提到的权限,新建一个令牌并再次尝试调用此 API。

  • NO_PERMISSIONHTTP 403

    您没有管理或查看数据增强权限,无法访问此功能。
    解决方法:请联系您的系统管理员。

  • INTERNAL_SERVER_ERRORHTTP 500

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

特定组织丰富的示例响应

Copied{
    "__zia_org_enrichment": [
        {
            "enrich_based_on": {
                "name": "ABC",
                "website": "www.zoho.com"
            },
            "enriched_data": {
                "address": [
                    {
                        "city": "Chengalpattu District",
                        "country": "India",
                        "fill_address": "Estancia IT Park, Plot no. 140, 151, GST Road, Vallancheri",
                        "pin_code": "603202",
                        "state": "Tamil Nadu"
                    }
                ],
                "id": "jRsJ7grCwzJfs4B384k4zY3OFsLIE+EGt9AwDDtb4j4=",
                "industries": [
                    {
                        "description": "Includes information and data processing services, computer programming, systems design, consultancy, hosting and other computer related services.",
                        "name": "Computer Programming Services"
                    }
                ],
                "name": "ZOHO",
                "primary_contact": "844-316-5544",
                "primary_email": "sales@zohocorp.com",
                "secondary_email": "press@zohocorp.com",
                "social_media": [
                    {
                        "media_type": "TWITTER",
                        "media_url": [
                            "twitter.com/zoho"
                        ]
                    }
                ],
                "website": "https://www.zoho.com"
            },
            "id": "554023000004092135",
            "status": "COMPLETED"
        }
    ]
}