查询对话规则列表
场景描述
分页查询对话规则列表，查询条件：limit-每页记录数，page-当前页数，keyword-搜索关键字，completeOnly-规则是否完整。
接口方法
POST
接口URI
https://域名/apiaccess/CCSQM/rest/ccisqm/v1/conversation-rules/queryRules，例如域名是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 |
False |
操作员标识 可在登录后，进入员工管理页面，查看接口返回的userId |
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
|---|---|---|---|---|
1.1 |
limit |
number |
True |
分页信息，每页记录数 |
1.2 |
page |
number |
False |
分页信息，当前页数 |
1.3 |
keyword |
string(128) |
False |
搜索关键字 |
1.4 |
incompleteOnly |
boolean |
False |
是否搜索完整的规则 |
响应说明
- 响应状态码: 200
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
|---|---|---|---|---|
1.1 |
data |
array[object] |
False |
返回数据 |
1.1.1 |
rule_id |
string |
False |
规则标识 |
1.1.2 |
score |
string |
False |
规则分数 |
1.1.3 |
rule_name |
string |
False |
规则名称 |
1.1.4 |
flows |
array[object] |
False |
规则关联的对话逻辑 |
1.1.4.1 |
expression |
string |
False |
表达式 |
1.1.4.2 |
min |
number |
False |
对话逻辑至少要出现几个 |
1.1.4.3 |
name |
string |
False |
对话逻辑名称 |
1.1.4.4 |
id |
string |
False |
对话逻辑标识 |
1.1.4.5 |
dialogRuleId |
string |
False |
规则标识 |
1.1.4.6 |
tenantId |
string |
False |
租户标识 |
1.1.5 |
description |
string |
False |
规则描述 |
1.1.6 |
completeness |
object |
False |
规则完成程度对象 |
1.1.6.1 |
hasConversationFlow |
boolean |
False |
是否设置完成了规则对话逻辑 |
1.1.6.2 |
sentenceComplete |
boolean |
False |
是否设置完成了规则适用的句子 |
1.1.6.3 |
ruleComplete |
boolean |
False |
是否设置完成了规则内容 |
1.1.6.4 |
hasDescription |
boolean |
False |
是否设置完成了规则描述 |
1.2 |
resultCode |
string |
False |
返回码，0405000表示成功，其他表示失败 |
1.3 |
paging |
object |
False |
分页信息 |
1.3.1 |
total |
number |
False |
总数 |
1.4 |
resultDesc |
string |
False |
返回描述 |
- 响应状态码: 400
错误的请求：请检查请求路径及参数。
- 响应状态码: 401
未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。
- 响应状态码: 404
请求的内容未找到：请检查请求的路径。
- 响应状态码: 500
业务失败：请依次确认您请求中各参数的取值。
错误码
无。
报文样例
- 场景描述：分页查询对话规则列表.
x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ********************************
请求参数:
{ "limit": 10, "page": 1, "incompleteOnly": false }响应参数:
{ "data": [{ "rule_id": "922202599711576064", "score": "1", "rule_name": "对话规则", "flows": [{ "expression": "must 923000490218754048 and 923001105690923008", "min": null, "tenantId": "202106114153", "name": "cs", "errorCode": null, "id": "923000489761574912", "ruleId": "922202599711576064", "errorMsg": null }], "description": "对话规则", "completeness": { "hasConversationFlow": true, "sentenceComplete": true, "ruleComplete": true, "hasDescription": true } }], "resultCode": "0405000", "paging": { "total": 1 }, "resultDesc": "操作成功" }
