查询IVR树子节点信息
查询IVR树子节点提供3个接口
- 通过企业id查询IVR树子节点记录
- 通过企业id和IVR树id查询IVR树子节点记录
- 通过企业id和IVR树子节点id查询唯一一条IVR树子节点记录
1、通过企业id查询IVR树子节点记录
URL
- GET
- URL：
http://voip-host/api/v1/voip/cti/app/ivr/node/{appId}
请求参数
| 参数名称 |
类型 |
是否必选 |
示例 |
描述 |
| appId |
String |
必填 |
eca23f68c66d4acfceee77c200200359 |
应用ID。 |
| limit |
int |
选填 |
1 |
URL参数，查询条数，可用于分页，最大为10。 |
| offset |
int |
选填 |
0 |
URL参数，查询起始位置，可用于分页。 |
示例
请求示例
http://voip-host/api/v1/voip/cti/app/ivr/node/776c3a0f2a7b3f3c6cff9ba0a6ecd445?limit=1&offset=0
正常返回示例（非整棵树）
{
"code": 0,
"message": "OK",
"data": [
{
"id": 3254,
"appId": "776c3a0f2a7b3f3c6cff9ba0a6ecd445",
"ext1": "",
"description": "",
"dbUpdateTime": "2022-01-13T03:30:34.000+0000",
"dbCreateTime": "2022-01-12T02:29:36.000+0000",
"ivrId": 4037,
"keyNum": 1,
"tailIVRNodeAOs": [],
"nodeStatus": 1,
"nodeType": 8,
"defaultNode": 0,
"nodeName": "请输入你的4位身份信息，按景号键结束",
"nodeWordType": 0,
"nodeWord": "请输入你的4位身份信息，按景号键结束",
"version": "1.0.0",
"nodeAttr": {
"callBackUrl": "http://voiptest.netease.im/voip/mock/ivr/callback",
"variableName": "accountId",
"minKey": "2",
"maxKey": "4",
"endKey": "#",
"repeat": "3",
"outTime": "30"
},
"ivrEndSign": "",
"ivrStartSign": "",
"hangup": 0,
"checked": false,
"tempId": 3254
}
]
}
2、通过企业id和IVR树id查询IVR树子节点记录
URL
- GET
- URL：
http://voip-host/api/v1/voip/cti/app/ivr/node/tree/{appId}/{ivrTreeId}
请求参数
| 参数名称 |
类型 |
是否必选 |
示例 |
描述 |
| appId |
String |
必填 |
eca23f68c66d4acfceee77c200200359 |
应用ID。 |
| ivrTreeId |
long |
必填 |
94322 |
ivr树的唯一id。 |
| limit |
int |
选填 |
1 |
URL参数，查询条数，可用于分页，最大为10。 |
| offset |
int |
选填 |
0 |
URL参数，查询起始位置，可用于分页。 |
示例
请求示例
http://voip-host/api/v1/voip/cti/app/ivr/node/tree/776c3a0f2a7b3f3c6cff9ba0a6ecd445/4037?limit=1&offset=0
正常返回示例
{
"code": 0,
"message": "OK",
"data": [
{
"id": 3254,
"appId": "776c3a0f2a7b3f3c6cff9ba0a6ecd445",
"ext1": "",
"description": "",
"dbUpdateTime": "2022-01-13T03:30:34.000+0000",
"dbCreateTime": "2022-01-12T02:29:36.000+0000",
"ivrId": 4037,
"keyNum": 1,
"tailIVRNodeAOs": [],
"nodeStatus": 1,
"nodeType": 8,
"defaultNode": 0,
"nodeName": "请输入你的4位身份信息，按景号键结束",
"nodeWordType": 0,
"nodeWord": "请输入你的4位身份信息，按景号键结束",
"version": "1.0.0",
"nodeAttr": {
"callBackUrl": "http://voiptest.netease.im/voip/mock/ivr/callback",
"variableName": "accountId",
"minKey": "2",
"maxKey": "4",
"endKey": "#",
"repeat": "3",
"outTime": "30"
},
"ivrEndSign": "",
"ivrStartSign": "",
"hangup": 0,
"checked": false,
"tempId": 3254
}
]
}
3、通过企业id和IVR树子节点id查询唯一一条IVR树子节点记录
URL
- GET
- URL：
http://voip-host/api/v1/voip/cti/app/ivr/node/id/{appId}/{ivrNodeId}
请求参数
| 参数名称 |
类型 |
是否必选 |
示例 |
描述 |
| appId |
String |
必填 |
776c3a0f2a7b3f3c6cff9ba0a6ecd445 |
应用ID。 |
| ivrNodeId |
long |
必填 |
3254 |
IVR树子节点id。 |
示例
请求示例
http://voip-host/api/v1/voip/cti/app/ivr/node/id/776c3a0f2a7b3f3c6cff9ba0a6ecd445/3254
正常返回示例
{
"code": 0,
"message": "OK",
"data": {
"id": 3254,
"appId": "776c3a0f2a7b3f3c6cff9ba0a6ecd445",
"ext1": "",
"description": "",
"dbUpdateTime": "2022-01-13T03:30:34.000+0000",
"dbCreateTime": "2022-01-12T02:29:36.000+0000",
"ivrId": 4037,
"keyNum": 1,
"tailIVRNodeAOs": [],
"nodeStatus": 1,
"nodeType": 8,
"defaultNode": 0,
"nodeName": "请输入你的4位身份信息，按景号键结束",
"nodeWordType": 0,
"nodeWord": "请输入你的4位身份信息，按景号键结束",
"version": "1.0.0",
"nodeAttr": {
"callBackUrl": "http://voiptest.netease.im/voip/mock/ivr/callback",
"variableName": "accountId",
"minKey": "2",
"maxKey": "4",
"endKey": "#",
"repeat": "3",
"outTime": "30"
},
"ivrEndSign": "",
"ivrStartSign": "",
"hangup": 0,
"checked": false,
"tempId": 3254
}
}
返回参数
| 参数名称 |
类型 |
示例 |
描述 |
| id |
long |
2346 |
IVR子节点id。 |
| appId |
String |
eca23f68c66d4acfceee77c200200359 |
应用ID。 |
| ivrId |
long |
5034 |
IVR树唯一id，创建子节点必须先创建ivr树，然后再VIR树下创建子节点，不支持修改。 |
| keyNum |
int |
1 |
当前节点对应的触发按键，比如按1，就会跳转到当前的节点上，非头节点keyNum不可为空，且取值为0 ~ 11，10表示*，11表示#。 |
| preNodeId |
long |
5609 |
头结点id。 |
| tailNodeIds |
list |
[5034,5478] |
尾结点list。 |
| nodeType |
int |
1 |
1放音收号节点.2转到具体的坐席节点.3转到坐席组节点.4返回上层节点.5重听节点.6放音节点.7异常节点.8回调节点.9转其他ivr树节点.10放音收号超时节点.11判断节点.12跳转到任意节点，不同类型的节点对应的个性化属性不一样，需要在nodeAttr里面进行配置，不支持修改。 |
| nodeName |
String |
欢迎语 |
IVR节点的名称。 |
| nodeWordType |
String |
1 |
播放类型：取值为: 0文本，1语音, 默认文本方式0。 |
| nodeWord |
string |
欢迎致电网易云信运营商中台公司，下面你可以根据导航按键进行导航 |
需要播放的类容，可以是文本，也可以用户自定义的语音文件。 |
| version |
string |
1.0.0 |
版本号。 |
| nodeAttr |
json |
{json} |
节点属性，每一种节点属性不一样，下面会详细说明。 |
| ivrEndSign |
string |
endNode |
IVR树结束节点标识，值为：endNode，慎用，节点有了此标志，会结束ivr流程（但是不会挂机），即使子节点后还有节点也会结束IVR流程。 |
| ivrStartSign |
string |
startNode |
IVR树开始节点标识，值为：startNode。 |
| hangup |
string |
0 |
hangup取值为0和1，0标识不挂断，1表示挂断，默认为0，如果节点有标识为挂断，那么当前节点动作执行之后就会立即挂断通话，即使后面有子节点也不会执行。 |
| description |
string |
第一个ivr |
描述信息。 |
服务端
