Query Outbound Route Settings

Query basic settings of an outbound route, multiple outbound routes, or all outbound routes.

Request URL

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

Request parameters

Parameter Required Type Description
id Yes Integer The unique ID of an outbound route.

Valid values:

  • An outbound route id: Query settings of the specified outbound route.

    Example: "id":"1"

  • Multiple outbound route ids: Query settings of multiple outbound routes. Separate multiple ids with ,.

    Example: "id":"1,2"

  • all: Query settings of all outbound routes.

    Example: "id":"all"

Response parameters

Parameter Type Description
status String Request result.
  • Success
  • Failed
outroutes Array <OutroutesInfo> Outbound route information.
OutroutesInfo
Parameter Type Description
id Integer The unique ID of an outbound route.
name String The name of an outbound route.
prefix String Dial pattern.
strip String How many digits will be stripped from the front of the dialed number before the call is placed.
prepend String The prepended number will be added to the beginning of a dialed number.
trunks String Trunk name.
extensions String Extensions which are allowed to make outbound calls through this route.
extensionsgroup String Extension groups which are allowed to make outbound calls through this route.

Examples

Request example

Query basic settings of the outbound route with 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"
}

Response example

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": ""
		}
	]
}