指令列表
更新时间:2024-11-04
1、接口地址:【GET】{IP}:{PORT}/open/v{versionId}/instruction
2、说明:用于获取指令列表
3、入参【请求的param中】
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
pn | int | 是 | 查询页数,默认为1 |
ps | int | 是 | 每页条数,默认为20 |
keyword | string | 是 | 检索关键字 |
startTime | string | 是 | 开始时间 |
endTime | string | 是 | 结束时间 |
4、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
total | int | data | 总大小 |
pn | int | data | 查询页数 |
ps | int | data | 每页大小 |
list | list | data | 数据列表 |
id | string | list | 指令 ID |
agentId | string | list | agentId |
instructionName | string | list | 指令名称 |
instructionMark | string | list | 指令标识 |
instructionDescription | string | list | 指令描述 |
instructionType | string | list | 指令类型「system/custom/third」 |
failedAnswer | string | list | 指令失败话术 |
created | string | list | 创建时间 |
inVariables | T | list | 关联传入变量 |
id | string | inVariables | 变量 |
name | string | inVariables | 变量名 |
outVariables | T | list | 关联传出变量 |
id | string | outVariables | 变量 ID |
name | string | outVariables | 变量名 |
示例:
JSON
1{
2 "time": 1614050254346,
3 "data": {
4 "total": 3,
5 "pn": 1,
6 "ps": 20,
7 "list": [
8 {
9 "id": "xxxxxxxxxxxxxxxxxxxxxxx",
10 "agentId": "xxxxxxxxxxxxxxxxxxxxxxx",
11 "instructionName": "xxx",
12 "instructionMark": "xxx",
13 "instructionType": "third",
14 "instructionDescription": "xxx",
15 "failedAnswer": "xxx",
16 "created": "2021-02-22 20:27:33",
17 "inVariables": [
18 {
19 "id": "xxxxxxxxxxxxxxxxxxxxxxxx",
20 "name": "xxx"
21 }
22 ],
23 "outVariables": [
24 {
25 "id": "xxxxxxxxxxxxxxxxxxxxxxx",
26 "name": "xxx"
27 }
28 ]
29 },
30 {
31 "id": "xxxxxxxxxxxxxxxxxxxxxxxx",
32 "agentId": "xxxxxxxxxxxxxxxxxxxxxxxxxx",
33 "instructionName": "xxx",
34 "instructionMark": "xxx",
35 "instructionType": "custom",
36 "instructionDescription": null,
37 "failedAnswer": null,
38 "created": "2021-02-22 14:56:10",
39 "inVariables": null,
40 "outVariables": null
41 },
42 ...
43 ]
44 },
45 "code": 200,
46 "msg": "OK"
47}