执行评分规则
执行评分规则 API 使开发者能够在不同模块上执行评分规则,确保根据评分规则中定义的标准计算分数并更新记录。
评分规则可通过两种方式执行:通过指定评分规则 ID或使用布局 ID。通过评分规则 ID 执行时,所有指定的规则必须对应同一模块。相反,如果通过布局 ID 执行,将应用与该布局关联的所有已启用评分规则。如果未提供请求正文,API 将为指定模块相关的所有已启用规则安排执行。这些规则将应用于过去六个月内创建或有过活动的记录。
目的
在 Zoho CRM 组织内为特定模块执行评分规则。
端点
- PUT /{module_api_name}/actions/run_scoring_rules
请求详情
请求 URL
{api-domain}/crm/{version}/{module_api_name}/actions/run_scoring_rules
支持的模块
潜在客户、Account、联系人、交易和自定义
标题
授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.settings.scoring_rules.{operation_type}
可能的操作类型
ALL - 对评分规则的完全访问权限
Update - 执行评分规则
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/Leads/actions/run_scoring_rules"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X PUT
-d @executerules.json注意
如果未提供请求体,API 将为与指定模块相关的所有布局所关联的所有已启用的评分规则安排执行。
使用规则 ID 执行评分规则
评分规则可以通过指定其唯一的评分规则 ID 来安排执行。使用此方法时,所有评分规则都属于同一模块。使用此方法,您一次最多可以执行五个启用的评分规则。
输入 JSON
- scoring_rulesJSON array,必填
表示要执行的评分规则的唯一 ID。
示例输入
Copied{
"scoring_rules" : [
"4876876000000965604",
"4876876000000945002"
]
}使用布局 ID 执行评分规则
要计划执行与模块内特定布局关联的所有已启用的评分规则,您可以在输入主体中指定布局 ID。
输入 JSON
- layoutJSON object,必填
表示要执行评分规则的布局的唯一 ID。
示例输入
Copied{
"layout" : {
"id" :"4876876000000091055"
}
}可能的错误
- INVALID_REQUEST_METHODHTTP 400
请求方法不正确。
解决方案:请使用 HTTP PUT 方法进行此 API 调用。使用其他任何请求方法都会导致此错误。 - AMBIGUITY_DURING_PROCESSINGHTTP 400
您在请求正文中同时指定了布局 ID 和评分规则 ID。
解决方案:请仅指定布局 ID 或评分规则 ID 之一以执行。 - INVALID_DATAHTTP 400
评分规则 ID 或布局 ID 似乎无效
解决方案:请为执行指定有效的规则 ID 或布局 ID。 - INVALID_DATAHTTP 400
模块名称似乎无效
解决方案:请在请求的 URL 中指定受支持的有效模块名称。 - INVALID_DATAHTTP 400
给定的 ID 不属于指定的模块
解决方案:请指定与该模块对应的评分规则。 - INVALID_DATAHTTP 400
提交执行的启用评分规则超过五条
解决方案:在按规则 ID 执行时,将要执行的规则数量限制为 5 条。 - CANNOT_PERFORM_ACTIONHTTP 400
指定的模块没有任何布局的评分规则
解决方案:请创建评分规则或指定另一个有效的模块。 - OAUTH_SCOPE_MISMATCHHTTP 401
用于发起此 API 调用的访问令牌不具备所需的权限范围。
解决方法:生成一个包含此 API 所需权限范围的新访问令牌。有关所需权限范围的列表,请参见本页开头的范围部分。 - NO_PERMISSIONHTTP 403
您没有权限执行评分规则。
解决方法:该用户没有执行评分规则的权限。请联系您的系统管理员。 - INVALID_URL_PATTERNHTTP 404
请求 URL 不正确。
解决方法:指定有效的请求 URL。有关详细信息,请参阅本页开头的请求 URL部分。 - INTERNAL_ERRORHTTP 500
服务器发生了意外且未处理的异常。
解决方案:请联系 support@zohocrm.com 的支持团队。
示例响应
CopiedExecution by Scoring Rule IDs:
{
"scoring_rules": [
{
"code": "SCHEDULED",
"details": {
"job_id": "4876876000000984013"
},
"message": "scoring rules successfully scheduled to run",
"status": "success"
},
{
"code": "SCHEDULED",
"details": {
"job_id": "4876876000000984013"
},
"message": "scoring rules successfully scheduled to run",
"status": "success"
}
]
}
Execution by Layout ID:
{
"code": "SCHEDULED",
"details": {
"job_id": "4876876000000984011"
},
"message": "The scoring rules of the specified layout successfully scheduled to run",
"status": "success"
}