Query Outbound Route Settings

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

Endpoint

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

Request Parameters


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

Response Parameters


Name	Type	Description
`outroutes`	Object	Object paramter.
`id`	Int	Outbound route ID.
`name`	String	Outbound route name.
`prefix`	String	Dial pattern of the outbound route.
`strip`	String	How many digits will be stripped from the front of the dialed number before the call is placed.
`prepend`	String	The prepend will be added to the beginning of a dialed number.
`trunks`	String	Trunk name.
`extensions`	String	Extension number.
`extensionsgroup`	String	Extension group.

Examples

Request Example

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

Response Example

HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
    "status": "Success",
    "outroutes": [
        {
            "id": "5",
            "name": "route1,
            "prefix": "6.",
            "strip": "1",
            "prepend": "",
            "trunks": "SIP1",
            "extensions": "1000,1001,1002",
            "extensionsgroup": ""
        }
    ]
}