Query Inbound Route Settings
Query the basic settings of an inbound route, multiple inbound routes, or all inbound routes.
Endpoint
POST /api/v0.0.1/inroute/query?token={token}&type={type}
Request Parameters
| Name | Importance | Type | Description |
| name | Required | String | Inbound Route name.
Example: “name”:”route1″
Example: “name”: “route1,route2”
|
Response Parameters
| Name | Type | Description |
| inroutes | Object | Object parameter. |
| id | Int | Inbound Route ID. |
| name | String | Inbound Route name. |
| did | String | DID pattern. |
| caller_id | String | Caller ID pattern. |
| desttype | String | Destination type:
|
| dest | String | The specific destination. |
Examples
Request Example
POST /api/v0.0.1/inroute/query?token=277ac400357b509b4a587ff2157f7ad5&type=json HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 172.16.6.150
{
“name”: “all”
}
POST /api/v0.0.1/inroute/query?token=277ac400357b509b4a587ff2157f7ad5&type=xml HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 172.16.6.150
<?xml version=”1.0″ encoding=”UTF-8″ ?>
<xml>
<name>all</name>
</xml>
Response Example
HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
<?xml version=”1.0″ encoding=”utf-8″?>
<xml>
<status>Success</status>
<inroutes>
<item id=”0″>
<id></id>
<name>test</name>
<did></did>
<caller_id></caller_id>
<desttype>extension</desttype>
<dest>102</dest>
</item>
</inroutes>
</xml>
HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
“status”: “Success”,
“inroutes”: [
{
“id”: “”,
“name”: “test”,
“did”: “”,
“caller_id”: “”,
“desttype”: “extension”,
“dest”: “102”
}
]
}