Query Inbound Route Settings

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

Request URL

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

Request parameters

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

Valid values:

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

    Example: "id":"5"

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

    Example: "id":"5,6"

  • all: Query settings of all inbound routes.

    Example: "id":"all"

Response parameters

Parameter Type Description
status String Request result.
  • Success
  • Failed
inroutes Array <InroutesInfo> Inbound route information.
InroutesInfo
Parameter Type Description
id Integer The unique ID of an inbound route.
name String The name of an inbound route.
did String DID pattern.
caller_id String Caller ID pattern.
trunks String Trunk name.
desttype String Destination type.
  • hangup
  • extension
  • extrange
  • voicemail
  • ivr
  • ringgroup
  • queue
  • conference
  • disa
  • callback
  • outroute
  • faxtoemail
dest String The specific destination.

Examples

Request example

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

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