查询指定租间的所有IVR流程(queryIVRFlowList)
场景描述
查询指定租间的所有IVR(Interactive Voice Response)流程
接口方法
POST
接口URI
https://域名/apiaccess/rest/cc-management/v1/ivrFlow/queryIVRFlowList,例如域名是service.besclouds.com
请求说明
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
X-APP-Key |
string |
False |
appKey字段,用户标识,请联系运营人员获取appKey |
2 |
Authorization |
string |
True |
鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) |
响应说明
- 响应状态码: 200
表2 响应体参数 序号
名称
参数类型
是否必选
说明
1
schema
object
True
-
1.1
result
array[object]
False
IVR信息
1.1.1
isLoad
number
False
流程是否加载 0:否 1:是
1.1.2
accessCode
string
False
流程接入码
1.1.3
maxCallNum
integer
False
流程最大并发呼叫数
1.1.4
description
string
False
流程描述
1.1.5
id
number
False
流程编号
1.1.6
flowFileName
string
False
流程文件名
1.1.7
flowType
number
False
流程类型
0:未明确的业务类型
1:GSL业务文件类型
2:VoiceXML业务文件类型
3:第三方IVR的业务类型
4:CCIVR支持的VXML流程
5:CCXMLL流程
6:WaitScript流程
1.2
retCode
string
False
返回码 0:成功 其他:失败
1.3
message
string
False
返回信息
- 响应状态码: 400
错误的请求:请检查请求路径及参数
- 响应状态码: 401
未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。
- 响应状态码: 403
鉴权失败
- 响应状态码: 404
请求的内容未找到:请检查请求的路径。
- 响应状态码: 500
业务失败:请依次确认您请求中各参数的取值。
错误码
无。
报文样例
请求头:
Content-Type:application/json Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX X-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX
响应参数:
{ "result": [ { "isLoad": 1, "accessCode": "90500", "maxCallNum": null, "description": "异常处理", "id": 1, "flowFileName": "defaultIVR.GSL", "flowType": 1 }, { "isLoad": 1, "accessCode": "90501", "maxCallNum": null, "description": "1015", "id": 2, "flowFileName": "defaultIVR.GSL", "flowType": 1 } ], "retCode": "0", "message": "success" }