Zoho crm Logo

评分规则

Zoho CRM 提供了一个系统,用于根据您定义的特定需求规则对模块中的不同记录进行排名。记录的分数是基于规则计算的值。通过此功能,系统可以帮助您找到最有价值的记录。请参阅 多重评分规则 以了解更多关于评分规则的信息。请参阅 限制表 了解不同版本的限制。

目的

要检索在您的Zoho CRM组织中配置的评分规则列表。

端点

  • GET /settings/automation/scoring_rules
  • GET /settings/automation/scoring_rules/{rule_ID}

请求详情

请求 URL

检索所有评分规则:
{api-domain}/crm/{version}/settings/automation/scoring_rules

获取特定评分规则:
{api-domain}/crm/{version}/settings/automation/scoring_rules/{rule_ID}

支持的模块

潜在客户,Account,联系人,交易和自定义

标题

授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.settings.scoring_rules.{operation_type}

可能的操作类型

全部 - 完全访问评分规则 
读取 - 获取评分规则

参数

  • module string, optional

    指定CRM模块的API名称,以便为特定模块筛选评分规则。

  • layout_ID string, optional

    指定布局ID以检索特定布局的评分规则。

  • active Boolean, optional

    指定是否仅获取活跃或非活跃的评分规则。默认情况下,响应中包含活跃和非活跃的评分规则。
    可能的值:
    active - 仅获取活跃的评分规则。
    false - 仅获取非活跃的评分规则。

  • name string, optional

    指定要检索的评分规则的名称。

  • per_page number, optional

    指定每页响应中包含的记录数。默认值为50。

  • page number, optional

    指定要从中检索记录的页码,用于分页结果。默认值为1。

示例请求

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

响应 JSON 

  • layoutJSON object

    表示与规则关联的布局,包括其ID和名称。

  • created_time string

    表示评分规则创建的日期和时间,采用 ISO 8601 格式。

  • modified_time string

    表示评分规则最后更新的日期和时间,采用 ISO 8601 格式。

  • field_rulesJSON object

    表示评分规则中定义的字段特定规则列表。

  • score number

    表示根据特定规则分配的分数。

  • criteria JSON object

    表示定义评分规则逻辑的条件或标准。

  • id string

    表示评分规则的唯一ID。

  • module JSON object

    包含评分规则适用的模块详细信息。

  • name string

    表示评分规则的唯一名称。

  • modified_by JSON object

    最后修改评分规则的用户详细信息,包括他们的姓名和用户ID。

  • active Boolean

    指示评分规则当前是活跃还是非活跃。
    可能的值:
    True - 评分规则是活跃的。
    False - 评分规则是非活跃的。

  • description string

    表示评分规则的描述。

  • signal_rules JSON array

    表示为评分规则定义的信号特定规则。

  • signal JSON object

    与评分规则相关的信号的详细信息,包括其ID和命名空间。

  • created_by JSON object

    表示创建评分规则的用户,包括他们的姓名和用户ID。

可能的错误

  • INVALID_REQUEST_METHODHTTP 400

    请求方法不正确。
    解决方法:使用 HTTP GET 方法来进行此 API 调用。使用其他请求方法将导致此错误。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    您用于进行此 API 调用的访问令牌不具有所需的范围。
    解决方法:生成一个具有此 API 所需范围的新访问令牌。请参阅本页开头的范围部分以获取所需范围的列表。

  • NO_PERMISSIONHTTP 403

    您没有权限获取评分规则。
    解决方法:用户没有读取评分规则数据的权限。请联系您的系统管理员。

  • INVALID_URL_PATTERNHTTP 404

    请求的URL不正确。
    解决方法:请指定一个有效的请求URL。有关详细信息,请参阅本页开头的请求URL部分。

  • INTERNAL_ERRORHTTP 500

    服务器中出现意外且未处理的异常。 
    解决方法:请联系支持团队,邮箱:support@zohocrm.com。

示例响应

Copied{
    "scoring_rules": [
        {
            "layout": {
                "api_name": "Standard",
                "id": "4876876000000091055"
            },
            "created_time": "2022-04-06T15:19:51+05:30",
            "modified_time": "2022-04-06T16:56:04+05:30",
            "field_rules": [
                {
                    "score": 10,
                    "criteria": {
                        "group_operator": "AND",
                        "group": [
                            {
                                "group_operator": "AND",
                                "group": [
                                    {
                                        "comparator": "equal",
                                        "field": {
                                            "api_name": "Company",
                                            "id": "4876876000000002591"
                                        },
                                        "value": "Zoho"
                                    },
                                    {
                                        "comparator": "equal",
                                        "field": {
                                            "api_name": "Phone",
                                            "id": "4876876000000002601"
                                        },
                                        "value": "123456890"
                                    }
                                ]
                            },
                            {
                                "comparator": "equal",
                                "field": {
                                    "api_name": "Designation",
                                    "id": "4876876000000002597"
                                },
                                "value": "review"
                            }
                        ]
                    },
                    "id": "4876876000000945003"
                },
                {
                    "score": 10,
                    "criteria": {
                        "group_operator": "AND",
                        "group": [
                            {
                                "group_operator": "AND",
                                "group": [
                                    {
                                        "comparator": "contains",
                                        "field": {
                                            "api_name": "Company",
                                            "id": "4876876000000002591"
                                        },
                                        "value": "Zoho"
                                    },
                                    {
                                        "comparator": "equal",
                                        "field": {
                                            "api_name": "Phone",
                                            "id": "4876876000000002601"
                                        },
                                        "value": "123456890"
                                    }
                                ]
                            },
                            {
                                "comparator": "equal",
                                "field": {
                                    "api_name": "Designation",
                                    "id": "4876876000000002597"
                                },
                                "value": "review"
                            }
                        ]
                    },
                    "id": "4876876000000945014"
                }
            ],
            "module": {
                "api_name": "Leads",
                "id": "4876876000000002175"
            },
            "name": "Rule 1",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "4876876000000327001"
            },
            "active": true,
            "description": "Rule for Module Leads",
            "id": "4876876000000945002",
            "signal_rules": [
                {
                    "score": 10,
                    "id": "4876876000000945016",
                    "signal": {
                        "namespace": "Email_Incoming__s",
                        "id": "4876876000000112019"
                    }
                },
                {
                    "score": 8,
                    "id": "4876876000000945017",
                    "signal": {
                        "namespace": "EmailInsight_Click__s",
                        "id": "4876876000000112023"
                    }
                }
            ],
            "created_by": {
                "name": "Patricia Boyle",
                "id": "4876876000000327001"
            }
        }
    ]
}