查询 IVR

查询单个 IVR、多个 IVR 或所有 IVR 的详细信息。

请求地址

{base_url}/{api_path}/ivr/query?token={token}

请求参数

参数 是否必选 类型 描述
number 是 String IVR 号码。

取值范围：

  • 单个 IVR 号码：查询指定 IVR 的信息。

    例如："number":"6500"

  • 多个 IVR 号码：查询多个 IVR 的信息。多个 IVR 号码用半角逗号（,）隔开。

    例如："number":"6500,6501,6502"

  • all：查询所有 IVR 的信息。

    例如："number":"all"

响应参数

参数 类型 描述
status String 请求结果。
  • Success：成功。
  • Failed：失败。
ivr Array <IVRInfo> IVR 信息列表。
IVRInfo
参数 类型 描述
number String IVR 号码。
ivrname String IVR 名称。
prompt String IVR 提示音。
promptrepeat Integer 提示音播放次数。
responsetimeout Integer 响应超时时间。
digittimeout Integer 按键超时时间。
dialext String 允许拨打分机号码。
  • on：允许。
  • off：不允许。
dialoutboundroutes String 允许从呼出路由拨出。
  • on：允许。
  • off：不允许。
dialtocheckvoicemail String 允许查阅语音留言。
  • on：允许。
  • off：不允许。

示例

请求示例

查询 IVR 6500 的信息。

POST /api/v2.0.0/ivr/query?token=1e3b3ebb6a974cb42ed31de5413df52d
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150

{
	"number": "6500"
}
响应示例
HTTP/1.1 200 OK
Server: Boa/0.94.14rc21
Accept-Ranges: bytes
Connection: close
Content-Type: application/json
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE

{
	"status": "Success",
	"ivr": [
		{
			"number": "6500",
			"ivrname": "6500",
			"prompt": "[Default]",
			"promptrepeat": "3",
			"responsetimeout": "3",
			"digittimeout": "3",
			"dialext": "on",
			"dialoutboundroutes": "off",
			"dialtocheckvoicemail": "off"
		}
	]
}