POST /CCSQM/rest/ccisqm/v1/conversation-rules/getOneRule
场景描述
根据ID查询对话规则,查询条件:rule_id,唯一标识,必填。
接口方法
POST
接口URI
https://域名/apiaccess/CCSQM/rest/ccisqm/v1/conversation-rules/getOneRule,例如域名是service.besclouds.com
请求说明
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
Content-Type |
string |
False |
固定填 application/json; charset=UTF-8。 |
2 |
x-app-key |
string |
False |
appKey标识 |
3 |
Authorization |
string |
True |
鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) |
4 |
x-UserId |
string |
True |
操作员标识 可在登陆后,进入员工管理页面,查看接口返回的userId |
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
rule_id |
string |
True |
规则标识 |
响应说明
- 响应状态码: 200
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1.1 |
severity |
string |
False |
规则级别一般规则和重要规则:"normal" "critical" |
1.2 |
rule_id |
string |
False |
规则标识 |
1.3 |
score |
string |
False |
规则分数 |
1.4 |
other |
object |
False |
附加条件 |
1.4.1 |
call_end |
number |
False |
呼叫开始时间:填写时间戳,单位秒 |
1.4.2 |
call_from |
number |
False |
呼叫结束时间:填写时间戳,单位秒 |
1.5 |
min |
string |
False |
对话逻辑至少要出现几个 |
1.6 |
method |
string |
False |
取值范围:
|
1.7 |
rule_name |
string |
False |
规则名称 |
1.8 |
flows |
array[object] |
False |
规则使用到的对话逻辑 |
1.8.1 |
flow_id |
string |
False |
对话逻辑标识 |
1.8.2 |
flow_name |
string |
False |
对话逻辑名称 |
1.9 |
resultCode |
string |
False |
返回码,0405000表示成功,其他表示失败 |
1.10 |
description |
string |
False |
规则描述 |
1.11 |
completeness |
object |
False |
规则完整度对象 |
1.11.1 |
hasConversationFlow |
boolean |
False |
是否有对话逻辑 |
1.11.2 |
sentenceComplete |
boolean |
False |
规则中句子是否设定完整 |
1.11.3 |
ruleComplete |
boolean |
False |
规则是否完整,当其余三个项目都为true时,值为true |
1.11.4 |
hasDescription |
boolean |
False |
是否有规则描述 |
1.12 |
resultDesc |
string |
False |
返回描述 |
- 响应状态码: 400
错误的请求:请检查请求路径及参数。
- 响应状态码: 401
未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。
- 响应状态码: 404
请求的内容未找到:请检查请求的路径。
- 响应状态码: 500
业务失败:请依次确认您请求中各参数的取值。
错误码
无。
报文样例
- 场景描述:根据ID查询对话规则,查询条件:rule_id,唯一标识,必填。
x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ********************************
请求参数:
{ "rule_id": "922202599711576064" }
响应参数:
{ "severity": "normal", "rule_id": "922202599711576064", "score": "1", "other": { "call_end": 1625020693, "call_from": 1622515089 }, "min": "1", "method": "positive", "rule_name": "对话规则", "flows": [{ "flow_id": "923000489761574912", "flow_name": "cs" }], "resultCode": "0405000", "description": "对话规则", "completeness": { "hasConversationFlow": true, "sentenceComplete": true, "ruleComplete": true, "hasDescription": true }, "resultDesc": "操作成功" }