Zoho crm Logo

创建评分规则

创建评分规则 API 允许你定义评分规则,这些规则可以应用于特定布局,或在你的 Zoho CRM 组织中全局应用于所有布局。评分规则可以使用字段规则、信号规则,或两者的组合来构建。请参阅 多个评分规则 以了解更多有关评分规则的信息。

下表概述了基于不同版本的Zoho CRM的评分规则的可用性和限制。

支持的 Edit版本和限制:

Edit版本多布局支持每个模块的启用规则数每个模块的规则总数每条规则的条件数
标准版 (S)否1110
ZohoOne 标准版 (Y)否1110
专业版 (P, R)否1120
开发者版 (D)是 - 2 个布局15305
企业版 (E, A)是 - 4 个布局255030
ZohoOne 企业版 (Z)是 - 4 个布局255030
CrmPlus (C)是 - 7 个布局408050
旗舰版 (U)是 - 7 个布局408050

目的

为 Zoho CRM 组织中的某个模块创建评分规则。

注意

仅线索、联系人和其他人员类模块支持信号规则。非人员类模块(例如交易和Account)不支持信号规则。

端点

  • POST /settings/automation/scoring_rules

请求详情

请求 URL

{api-domain}/crm/{version}/settings/automation/scoring_rules

支持的模块

线索、Account、联系人、交易和自定义

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.settings.scoring_rules.{operation_type}

可能的操作类型

ALL - 对评分规则拥有完全访问权限
CREATE - 创建评分规则

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/automation/scoring_rules"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d @createrules.json
-X POST

输入 JSON

  • scoring_rulesJSON array,必填

    包含评分规则对象的数组。

  • name string,必填

    表示评分规则的唯一名称。该字段的最大长度为 25 个字符。

  • 模块JSON object,必填

    表示定义评分规则所针对的模块。该对象必须包含该模块的 ID 和 API 名称。

  • 描述字符串,可选

    表示评分规则的描述。此字段的最大长度为 500 个字符。

  • layoutJSON object,可选

    表示评分规则关联的布局。该对象必须包含布局的 ID 和 API 名称。

  • active Boolean,可选

    指示评分规则是否处于启用状态。 
    可能的取值:
    true - 规则处于启用状态。这是默认值。
    false - 规则处于未启用状态。

  • field_rulesJSON array, 如果已指定 signal_rules,则为可选

    与评分规则关联的字段规则对象数组。每个字段规则必须包含:

    • score数值,必填

      表示分配给特定规则的分数。该键的取值范围为 -100 到 100。

    • 条件JSON object,必需

      表示条件的详细信息,包括:

      • group_operator string,必填

        用于组合条件的逻辑运算符。可选值为 and 或 or。

      • groupJSON array,必填

        用于定义评分条件的条件对象数组。每个条件必须包含:

        • fieldJSON object,必填

          指定要评估的字段。

        • comparator 字符串字符串,必填

          比较运算符。支持的运算符包括 equals, starts_with, in, not_equal, greater_equal, greater_than, less_equal, less_than 和 between。

        • value string,必填

          要与该字段值进行比较的值。

  • Signal_rulesJSON array,如果指定了 field_rules 则可选

    为此评分规则定义的 Signal 规则对象数组。每个 Signal 规则必须包含:

    • score数字,必填

      将分数 asSigned 给此 Signal 规则。该键的取值范围为 -100 到 100。

    • SignalJSON object,必填

      表示 Signal 的详细信息。您可以使用 Signals API 获取 Signal 详细信息。

      • namespace string,必填

        Signal 的命名空间。

      • id string,必填

        Signal 的唯一标识符。

  • custom_fieldsJSON array,可选

    允许用户将评分映射到现有字段的自定义字段对象数组。每个自定义字段包括:

    • field_label string,必填

      自定义字段在用户界面中显示的标签。

    • reference_fieldJSON object,必填

      用于将自定义字段映射到特定评分。

      • api_name string,必填

        要映射的评分的 API 名称。可能的取值包括 Positive_Score, Negative_Score, Touch_Point_Score, Touch_Point_Positive_Score, Touch_Point_Negative_Score 和 Score。

注意

必须至少指定 field_rules 或 signal_rules 之一。

评分规则的自定义字段限制

下表根据您使用的 Zoho CRM 版本,概述可为评分规则创建的自定义字段的最大数量。无论版本如何,单个评分规则可添加的字段数量上限为 六。请注意,自定义字段必须在相应模块的整数型自定义字段数量限制之内。 

Edit版本限制   
标准版 (S)6
Zoho One 标准版 (Y)6
专业版 (P, R)6
开发者版 (D)6
企业版 (A, E)30
Zoho One 企业版 (Z)30
CRM 增强版 (C)30
旗舰版 (U)30

注意

在创建评分规则时新建的任何自定义字段,将在删除该评分规则时一并删除。

示例输入

Copied{
    "scoring_rules": [
        {
            "name": "Rule 01",
            "description": "Rule for Module Leads",
            "module": {
                "id": "4876876000000002175",
                "api_name": "Leads"
            },
            "layout": {
                "id": "4876876000000091055",
                "api_name": "Standard"
            },
            "active": false,
            "field_rules": [
                {
                    "score": 10,
                    "criteria": {
                        "group_operator": "OR",
                        "group": [
                            {
                                "field": {
                                    "api_name": "Company"
                                },
                                "comparator": "equal",
                                "value": "zoho"
                            },
                            {
                                "field": {
                                    "api_name": "Designation"
                                },
                                "comparator": "contains",
                                "value": "review"
                            }
                        ]
                    }
                },
                {
                    "score": 10,
                    "criteria": {
                        "group_operator": "OR",
                        "group": [
                            {
                                "field": {
                                    "api_name": "Company"
                                },
                                "comparator": "not_equal",
                                "value": "Zylker"
                            },
                            {
                                "field": {
                                    "api_name": "Designation"
                                },
                                "comparator": "equal",
                                "value": "review"
                            }
                        ]
                    }
                }
            ],
            "signal_rules": [
                {
                    "score": 10,
                    "signal": {
                        "namespace": "Email_Incoming__s",
                        "id": "4876876000000112019"
                    }
                },
                {
                    "score": 8,
                    "signal": {
                        "namespace": "EmailInsight_Click__s",
                        "id": "4876876000000112023"
                    }
                }
            ],
            "custom_fields": [
                {
                    "field_label": "Positive Total",
                    "reference_field": {
                        "api_name": "Positive_Score"
                    }
                },
                {
                    "field_label": "Touchpoint Positive",
                    "reference_field": {
                        "api_name": "Touch_Point_Positive_Score"
                    }
                }
            ]
        }
    ]
}

可能的错误

  • INVALID_REQUEST_METHODHTTP 400

    请求方法不正确。
    解决方案: 使用 HTTP POST 方法来进行此 API 调用。任何其他请求方法都会导致此错误。

  • INVALID_DATAHTTP 400

    您指定了无效或不受支持的模块,或无效的布局。
    解决方法:请指定有效的模块和布局详细信息。

  • INVALID_DATAHTTP 400

    您指定的规则名称超过了25个字符,或者描述超过了500个字符。
    解决方案:请将名称和描述分别限制在25个字符和500个字符以内。

  • MANDATORY_NOT_FOUNDHTTP 400

    您在输入中未指定必填字段。
    解决方案:请指定所有必填字段。有关更多信息,请参见输入 JSON部分。

  • EXPECTED_FIELD_MISSINGHTTP 400

    您尚未指定字段规则或信号规则。
    解决方案: 指定字段规则和/或信号规则以创建评分规则。

  • DUPLICATE_DATAHTTP 400

    已存在符合指定条件或具有相同名称的评分规则
    解决方法:为该规则指定不同的条件或名称。

  • ALREADY_USEDHTTP 400

    指定的条件已在同一规则中以不同的索引出现。
    解决方案:请指定其他条件。

  • NOT_SUPPORTEDHTTP 400

    您已为非人员模块指定了 Signal 规则。Signal 规则不支持用于非人员模块。
    解决方案:请为指定的模块使用字段规则。

  • INVALID_DATAHTTP 400

    您为 score 键指定了无效的值。请为该键指定一个有效值。
    解决方案:有关更多详细信息,请参阅输入 JSON部分。

  • ACTIVE_STATE_LIMIT_EXCEEDEDHTTP 400

    您已超出您的账户所允许的活动规则数量。
    解决方法:将活动规则的数量限制在允许的范围内。有关更多详情,请参阅本页开头的功能限制表格。

  • LIMIT_EXCEEDEDHTTP 400

    您已经创建了评分规则的最大允许数量。
    解决方法:将规则数量限制在允许的最大上限内。有关详细信息,请参阅本页开头的功能限制表格 。

  • FEATURE_NOT_SUPPORTEDHTTP 400

    您正在尝试为不受支持的版本创建多个评分规则。
    解决方法:请联系系统管理员。

  • NOT_SUPPORTEDHTTP 400

    所提供的字段在给定的布局中不可用。
    解决方案:指定该布局中可用的字段。

  • NOT_SUPPORTEDHTTP 400

    在条件中指定了布局或评分字段。
    解决方法:请在条件中指定有效的字段。

  • 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": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "4876876000009019118"
            },
            "message": "scoring rule created successfully",
            "status": "success"
        }
    ]
}