查询呼出路由

查询单个呼出路由、多个呼出路由或所有呼出路由的设置。

请求地址

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

请求参数

参数 是否必选 类型 描述
id Integer 呼出路由的唯一 ID。

取值范围

  • 单个呼出路由 id:查询指定呼出路由的设置。

    例如:"id":"1"

  • 多个呼出路由 id:查询多个呼出路由的设置。多个呼出路由 id 用半角逗号(,)隔开。

    例如:"id":"1,2"

  • all:查询所有呼出路由的设置。

响应参数

参数 类型 描述
status String 请求结果。
  • Success:成功。
  • Failed:失败。
outroutes Array<OutrouteInfo> 呼出路由信息。
OutrouteInfo
参数 类型 描述
id Integer 呼出路由的唯一 ID。
name String 呼出路由的名称。
prefix String 呼出模式。
strip Integer 删除前缀位数。
prepend String 前置号码。
trunks String 中继名称。
extensions Integer 分机号码。
extensionsgroup String 分机组。

示例

请求示例

查询 id 为1的呼出路由的详细信息。

POST /api/v2.0.0/outroute/query?token=277ac400357b509b4a587ff2157f7ad5
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150

{
    "id": "1"
}

响应示例

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",
	"outroutes": [
		{
			"id": "1",
			"name": "Route_out",
			"prefix": "159XXXXXXXX",
			"strip": "",
			"prepend": "",
			"trunks": "siptrunk",
			"extensions": "1020,1001,1000",
			"extensionsgroup": ""
		}
	]
}