Query Inbound Route Settings

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

Endpoint

POST /api/v1.1.0/inroute/query?token={token}

Request Parameters


Name	Importance	Type	Description
`name`	Required	String	Inbound Route name. An inbound route: Set `name` to the inbound route name. Example: `"name":"route1"` Multiple inbound routes: Set `name` to the inbound route name. Separate multiple inbound routes with `,`. Example: `"name": "route1,route2"` All inbound routes: Set `name` to `all`.

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.
`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

POST /api/v1.1.0/inroute/query?token=277ac400357b509b4a587ff2157f7ad5 HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: api.yeastarcloud.com
{
    "name": "Routein"
}

Response Example

HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
    "status": "Success",
    "inroutes": [
        {
            "id": "4",
            "name": "Routein",
            "did": "",
            "caller_id": "",
            "trunks": "siptrunk",
            "desttype": "ivr",
            "dest": "6500"
        }
    ]
}