查询IVR树
- 查询IVR树的相关信息，可以查询整个树包含子节点信息，也可以不包含子节点信息
查询IVR树提供3个接口
- 通过企业id查询IVR树记录
- 通过企业id和IVR树id查询唯一一条IVR树记录
- 通过企业id和IVR树名称查询唯一一条IVR树记录
1、通过企业id查询IVR树记录
URL
- GET
- URL：
http://voip-host/api/v1/voip/cti/app/ivr/tree/{appId}
请求参数
| 参数名称 |
类型 |
是否必选 |
示例 |
描述 |
| appId |
String |
必填 |
eca23f68c66d4acfceee77c200200359 |
应用ID。 |
| allTree |
boolean |
选填 |
true |
是否将整棵树都查询出来，默认不查整棵树。 |
| limit |
int |
选填 |
1 |
URL参数，查询条数，可用于分页，最大为10。 |
| offset |
int |
选填 |
0 |
URL参数，查询起始位置，可用于分页。 |
示例
请求示例
http://voip-host/api/v1/voip/cti/app/ivr/tree/776c3a0f2a7b3f3c6cff9ba0a6ecd445?allTree=false&limit=2&offset=0
正常返回示例（非整棵树）
{
"code": 0,
"message": "OK",
"data": [
{
"id": 4037,
"appId": "776c3a0f2a7b3f3c6cff9ba0a6ecd445",
"description": "ivr树整个直接导入",
"dbUpdateTime": "2022-01-12T03:21:39.000+0000",
"dbCreateTime": "2022-01-12T02:29:36.000+0000",
"ivrStatus": 1,
"ivrName": "余额查询简单IVR",
"createUser": "dujun",
"updateUser": "dujun",
"headerNodeId": 3252,
"version": "1.0.0"
},
{
"id": 5034,
"appId": "776c3a0f2a7b3f3c6cff9ba0a6ecd445",
"description": "ivr树整个直接导入1",
"dbUpdateTime": "2022-01-12T02:44:27.000+0000",
"dbCreateTime": "2022-01-12T02:44:27.000+0000",
"ivrStatus": 1,
"ivrName": "欢迎语-》放音收号-》转坐席",
"createUser": "dujun",
"updateUser": "dujun",
"headerNodeId": 4189,
"version": "1.0.0"
}
]
}
2、通过企业id和IVR树id查询唯一一条IVR树记录
URL
- GET
- URL：
http://voip-host/api/v1/voip/cti/app/ivr/tree/id/{appId}/{ivrTreeId}
请求参数
| 参数名称 |
类型 |
是否必选 |
示例 |
描述 |
| appId |
String |
必填 |
eca23f68c66d4acfceee77c200200359 |
应用ID。 |
| ivrTreeId |
long |
必填 |
94322 |
ivr树的唯一id。 |
| allTree |
boolean |
选填 |
true |
是否将整棵树都查询出来，默认不查整棵树。 |
示例
请求示例
http://voip-host/api/v1/voip/cti/app/ivr/tree/id/776c3a0f2a7b3f3c6cff9ba0a6ecd445/4037?allTree=false
正常返回示例（非整棵树）
{
"code": 0,
"message": "OK",
"data": {
"id": 4037,
"appId": "776c3a0f2a7b3f3c6cff9ba0a6ecd445",
"description": "ivr树整个直接导入",
"dbUpdateTime": "2022-01-12T03:21:39.000+0000",
"dbCreateTime": "2022-01-12T02:29:36.000+0000",
"ivrStatus": 1,
"ivrName": "余额查询简单IVR",
"createUser": "dujun",
"updateUser": "dujun",
"headerNodeId": 3252,
"version": "1.0.0"
}
}
3、通过企业id和IVR树名称查询唯一一条IVR树记录
URL
- GET
- URL：
http://voip-host/api/v1/voip/cti/app/ivr/tree/name/name/{appId}/{ivrName}
请求参数
| 参数名称 |
类型 |
是否必选 |
示例 |
描述 |
| appId |
String |
必填 |
eca23f68c66d4acfceee77c200200359 |
应用ID。 |
| ivrName |
long |
必填 |
欢迎语-》放音收号-》转坐席 |
ivr树的名称。 |
| allTree |
boolean |
选填 |
true |
是否将整棵树都查询出来，默认不查整棵树。 |
示例
请求示例
http://10.189.7.218:7701/api/v1/voip/cti/app/ivr/tree/name/name/776c3a0f2a7b3f3c6cff9ba0a6ecd445/%E6%AC%A2%E8%BF%8E%E8%AF%AD-%E3%80%8B%E6%94%BE%E9%9F%B3%E6%94%B6%E5%8F%B7-%E3%80%8B%E8%BD%AC%E5%9D%90%E5%B8%AD?allTree=false
正常返回示例（非整棵树）
{
"code": 0,
"message": "OK",
"data": {
"id": 5027,
"appId": "776c3a0f2a7b3f3c6cff9ba0a6ecd445",
"description": "ivr树整个直接导入1",
"dbUpdateTime": "2022-01-11T09:25:07.000+0000",
"dbCreateTime": "2022-01-11T08:23:41.000+0000",
"ivrStatus": 3,
"ivrName": "欢迎语-》放音收号-》转坐席",
"createUser": "dujun",
"updateUser": "dujun",
"headerNodeId": 4117,
"version": "1.0.0"
}
}
返回参数
| 参数名称 |
类型 |
示例 |
描述 |
| code |
int |
0 |
状态码。 |
| message |
string |
OK |
请求成功或者失败描述信息。 |
| data |
json |
{json} |
返回的ivr树信息。 |
| id |
long |
962220 |
ivr树唯一id。 |
| appId |
string |
776c3a0f2a7b3f3c6cff9ba0a6ecd445 |
企业id。 |
| description |
string |
描述信息 |
描述信息。 |
| dbUpdateTime |
string |
2021-01-11T09:25:07.000+0000 |
修改时间。 |
| dbCreateTime |
string |
2021-01-11T09:25:07.000+0000 |
创建时间。 |
| ivrStatus |
int |
3 |
ivr发布状态，1未发布，2发布中，3已发布，4编辑中，5发布失败，已发布的IVR不可修改和删除。 |
| ivrName |
string |
欢迎语-》放音收号-》转坐席 |
ivr名称。 |
| createUser |
string |
dujun |
创建者。 |
| updateUser |
string |
dujun |
更新者。 |
| headerNodeId |
long |
90899 |
头结点id。 |
| version |
string |
1.0.0 |
ivr树版本。 |
返回单个整棵ivr树示例
{
"code": 0,
"message": "OK",
"data": {
"id": 5027,
"appId": "776c3a0f2a7b3f3c6cff9ba0a6ecd445",
"description": "ivr树整个直接导入1",
"dbUpdateTime": "2022-01-11T09:25:07.000+0000",
"dbCreateTime": "2022-01-11T08:23:41.000+0000",
"ivrStatus": 3,
"ivrName": "欢迎语-》放音收号-》转坐席",
"createUser": "dujun",
"updateUser": "dujun",
"headerNodeId": 4117,
"version": "1.0.0",
"headerNode": {
"id": 4117,
"appId": "776c3a0f2a7b3f3c6cff9ba0a6ecd445",
"ext1": "第一个节点",
"description": "第一个节点",
"dbUpdateTime": "2022-01-11T08:23:42.000+0000",
"dbCreateTime": "2022-01-11T08:23:42.000+0000",
"ivrId": 5027,
"tailNodeIds": [
4118
],
"tailIVRNodeAOs": [
{
"id": 4118,
"appId": "776c3a0f2a7b3f3c6cff9ba0a6ecd445",
"ext1": "第一个节点",
"description": "第一个节点",
"dbUpdateTime": "2022-01-11T08:51:14.000+0000",
"dbCreateTime": "2022-01-11T08:23:42.000+0000",
"ivrId": 5027,
"keyNum": 0,
"preNodeId": 4117,
"tailNodeIds": [
4119,
4120,
4121,
4122,
4123
],
"tailIVRNodeAOs": [
{
"id": 4119,
"appId": "776c3a0f2a7b3f3c6cff9ba0a6ecd445",
"ext1": "第一个节点",
"description": "第一个节点",
"dbUpdateTime": "2022-01-11T08:23:42.000+0000",
"dbCreateTime": "2022-01-11T08:23:42.000+0000",
"ivrId": 5027,
"keyNum": 3,
"preNodeId": 4118,
"tailIVRNodeAOs": [],
"nodeStatus": 1,
"nodeType": 6,
"defaultNode": 0,
"nodeName": "听音乐节点",
"nodeWordType": 0,
"nodeWord": "啦啦啦啦啦啦啦啦啦啦，音乐真好听啊，啊啊啊啊啊啊啊啊，唱完了我就挂了哦",
"version": "1.0.0",
"nodeAttr": {},
"ivrEndSign": "",
"ivrStartSign": "",
"hangup": 1,
"checked": false,
"tempId": 4119
},
{
"id": 4120,
"appId": "776c3a0f2a7b3f3c6cff9ba0a6ecd445",
"ext1": "第一个节点",
"description": "第一个节点",
"dbUpdateTime": "2022-01-11T08:23:42.000+0000",
"dbCreateTime": "2022-01-11T08:23:42.000+0000",
"ivrId": 5027,
"keyNum": 2,
"preNodeId": 4118,
"tailIVRNodeAOs": [],
"nodeStatus": 1,
"nodeType": 2,
"defaultNode": 0,
"nodeName": "转人工坐席，指定一个坐席进行接听",
"nodeWordType": 0,
"nodeWord": "",
"version": "",
"nodeAttr": {
"sipAccount": "10000008000005"
},
"ivrEndSign": "endNode",
"ivrStartSign": "",
"hangup": 0,
"checked": false,
"tempId": 4120
},
{
"id": 4121,
"appId": "776c3a0f2a7b3f3c6cff9ba0a6ecd445",
"ext1": "",
"description": "",
"dbUpdateTime": "2022-01-11T08:23:42.000+0000",
"dbCreateTime": "2022-01-11T08:23:42.000+0000",
"ivrId": 5027,
"keyNum": 10,
"preNodeId": 4118,
"tailIVRNodeAOs": [],
"nodeStatus": 1,
"nodeType": 5,
"defaultNode": 0,
"nodeName": "重听节点，按*",
"nodeWordType": 0,
"nodeWord": "",
"version": "1.0.0",
"nodeAttr": {},
"ivrEndSign": "",
"ivrStartSign": "",
"hangup": 0,
"checked": false,
"tempId": 4121
},
{
"id": 4122,
"appId": "776c3a0f2a7b3f3c6cff9ba0a6ecd445",
"ext1": "",
"description": "",
"dbUpdateTime": "2022-01-11T08:23:42.000+0000",
"dbCreateTime": "2022-01-11T08:23:42.000+0000",
"ivrId": 5027,
"keyNum": 11,
"preNodeId": 4118,
"tailIVRNodeAOs": [],
"nodeStatus": 1,
"nodeType": 4,
"defaultNode": 0,
"nodeName": "返回上一层请按#",
"nodeWordType": 0,
"nodeWord": "",
"version": "1.0.0",
"nodeAttr": {},
"ivrEndSign": "",
"ivrStartSign": "",
"hangup": 0,
"checked": false,
"tempId": 4122
},
{
"id": 4123,
"appId": "776c3a0f2a7b3f3c6cff9ba0a6ecd445",
"ext1": "",
"description": "",
"dbUpdateTime": "2022-01-11T08:23:42.000+0000",
"dbCreateTime": "2022-01-11T08:23:42.000+0000",
"ivrId": 5027,
"keyNum": 1,
"preNodeId": 4118,
"tailNodeIds": [
4124
],
"tailIVRNodeAOs": [
{
"id": 4124,
"appId": "776c3a0f2a7b3f3c6cff9ba0a6ecd445",
"ext1": "",
"description": "",
"dbUpdateTime": "2022-01-11T08:23:42.000+0000",
"dbCreateTime": "2022-01-11T08:23:42.000+0000",
"ivrId": 5027,
"keyNum": 0,
"preNodeId": 4123,
"tailNodeIds": [
4127,
4125,
4128
],
"tailIVRNodeAOs": [
{
"id": 4127,
"appId": "776c3a0f2a7b3f3c6cff9ba0a6ecd445",
"ext1": "",
"description": "",
"dbUpdateTime": "2022-01-11T08:23:43.000+0000",
"dbCreateTime": "2022-01-11T08:23:42.000+0000",
"ivrId": 5027,
"keyNum": 5,
"preNodeId": 4124,
"tailNodeIds": [
4126
],
"tailIVRNodeAOs": [],
"nodeStatus": 1,
"nodeType": 6,
"defaultNode": 0,
"nodeName": "你的银行卡余额",
"nodeWordType": 0,
"nodeWord": "你的银行卡余额是${money}元",
"version": "1.0.0",
"nodeAttr": {},
"ivrEndSign": "",
"ivrStartSign": "",
"hangup": 0,
"checked": false,
"tempId": 4127
},
{
"id": 4125,
"appId": "776c3a0f2a7b3f3c6cff9ba0a6ecd445",
"ext1": "",
"description": "",
"dbUpdateTime": "2022-01-11T08:23:43.000+0000",
"dbCreateTime": "2022-01-11T08:23:42.000+0000",
"ivrId": 5027,
"keyNum": 3,
"preNodeId": 4124,
"tailNodeIds": [
4126
],
"tailIVRNodeAOs": [
{
"id": 4126,
"appId": "776c3a0f2a7b3f3c6cff9ba0a6ecd445",
"ext1": "",
"description": "",
"dbUpdateTime": "2022-01-11T08:23:43.000+0000",
"dbCreateTime": "2022-01-11T08:23:42.000+0000",
"ivrId": 5027,
"keyNum": 1,
"preNodeId": 4125,
"tailNodeIds": [
4118
],
"tailIVRNodeAOs": [],
"nodeStatus": 1,
"nodeType": 12,
"defaultNode": 0,
"nodeName": "任意节点，跳转到前面几层的节点",
"nodeWordType": 0,
"nodeWord": "",
"version": "1.0.0",
"nodeAttr": {},
"ivrEndSign": "",
"ivrStartSign": "",
"hangup": 0,
"checked": false,
"tempId": 4126
}
],
"nodeStatus": 1,
"nodeType": 6,
"defaultNode": 0,
"nodeName": "播放水费余额",
"nodeWordType": 0,
"nodeWord": "你的水费余额是${money}元",
"version": "1.0.0",
"nodeAttr": {},
"ivrEndSign": "",
"ivrStartSign": "",
"hangup": 0,
"checked": false,
"tempId": 4125
},
{
"id": 4128,
"appId": "776c3a0f2a7b3f3c6cff9ba0a6ecd445",
"ext1": "",
"description": "",
"dbUpdateTime": "2022-01-11T08:23:43.000+0000",
"dbCreateTime": "2022-01-11T08:23:42.000+0000",
"ivrId": 5027,
"keyNum": 4,
"preNodeId": 4124,
"tailNodeIds": [
4126
],
"tailIVRNodeAOs": [],
"nodeStatus": 1,
"nodeType": 6,
"defaultNode": 0,
"nodeName": "播放电费费余额",
"nodeWordType": 0,
"nodeWord": "你的电费余额是${money}元",
"version": "1.0.0",
"nodeAttr": {},
"ivrEndSign": "",
"ivrStartSign": "",
"hangup": 0,
"checked": false,
"tempId": 4128
}
],
"nodeStatus": 1,
"nodeType": 11,
"defaultNode": 0,
"nodeName": "余额判断节点",
"nodeWordType": 0,
"nodeWord": "",
"version": "1.0.0",
"nodeAttr": {
"judgeSourceValue": "2",
"targetNodes": {
"<": 4127,
"=": 4125,
">": 4128
}
},
"ivrEndSign": "",
"ivrStartSign": "",
"hangup": 0,
"checked": false,
"tempId": 4124
}
],
"nodeStatus": 0,
"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": 4123
}
],
"nodeStatus": 1,
"nodeType": 1,
"defaultNode": 0,
"nodeName": "余额查询请按1，转人工坐席请按2，听音乐请按3，从听请按心号键，返回上一层菜单请按景号键",
"nodeWordType": 0,
"nodeWord": "余额查询请按1，转人工坐席请按2，听音乐请按3，从听请按心号键，返回上一层菜单请按景号键",
"version": "1.0.0",
"nodeAttr": {
"repeat": "2",
"outTime": "10"
},
"ivrEndSign": "",
"ivrStartSign": "",
"hangup": 0,
"checked": false,
"tempId": 4118
}
],
"nodeStatus": 0,
"nodeType": 6,
"defaultNode": 0,
"nodeName": "欢迎语",
"nodeWordType": 0,
"nodeWord": "1,欢迎你，请按键导航",
"version": "1.0.0",
"nodeAttr": {},
"ivrEndSign": "",
"ivrStartSign": "startNode",
"hangup": 0,
"checked": false,
"tempId": 4117
}
}
}
服务端
