查询呼入路由

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

请求地址

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

请求参数

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

取值范围

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

    例如:"id":"5"

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

    例如:"id":"5,6"

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

响应参数

参数 类型 描述
status String 请求结果。
  • Success:成功。
  • Failed:失败。
inroutes Array<InrouteInfo> 呼入路由信息。
InrouteInfo
参数 类型 描述
id Integer 呼入路由的唯一 ID。
name String 呼入路由的名称。
did String DID 匹配模式。
caller_id String 来电匹配模式。
trunks String 中继。
desttype String 呼入目的地类型。
  • hangup:挂机。
  • extension:分机。
  • extrange:分机范围。
  • voicemail:语音邮箱。
  • ivr:IVR。
  • ringgroup:响铃组。
  • queue:队列。
  • conference:会议室。
  • disa:DISA。
  • callback:回拨。
  • outroute:呼出路由。
  • faxtoemail:传真到邮件。
dest String 具体目的地。

示例

请求示例

查询 id 为5的呼入路由的详细信息。

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

{
	"id": "5"
}

响应示例

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",
	"inroutes": [
		{
			"id": "5",
			"name": "Route_in",
			"did": "4000",
			"caller_id": "3000",
			"trunks": "To_6.36",
			"desttype": "extension",
			"dest": "4000"
		}
	]
}