Query Outbound Route List

Query the outbound route list.

Request URL

GET {base_url}/{api_path}/outbound_route/list?access_token={access_token}

Request parameters

Table 1.
Parameter Required Type Description
page No Integer Define which page is displayed.
page_size No Integer Define how many records per page.
sort_by No String Define the sorting field.
Valid value:
  • id
  • pos
  • name
  • outb_cid
order_by No String Define the display order.

Valid value:

  • asc: Ascending order.
  • desc: Descending order.

Response parameters

Table 2.
Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
total_number Integer The total number of outbound routes.
last_pos Integer The last position in the outbound route list.
data Array<Outroute_Info> The basic information of the outbound route.
Outroute_Info
Table 3.
Parameter Type Description
id Integer The unique ID of the outbound route.
name String The name of the outbound route.
dial_pattern Array<String> The dial pattern of the outbound route.
trunk Array<Trunk_List> The information of the selected trunk in the outbound route.
pos Integer The current position of the outbound route in the list.
Trunk_List
Table 4.
Parameter Type Description
id Integer The unique ID of the selected trunk.
name String The name of the selected trunk.

Examples

Request example

GET /openapi/v1.0/outbound_route/list?page=1&page_size=20&sort_by=outb_cid&order_by=asc&access_token=nIAuSgDUim0uZgrNuha8hfzwbvY41NWR HTTP/1.1
Host: 192.168.5.150:8088

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 4,
    "last_pos": 4,
    "data": [
        {
            "id": 21,
            "name": "outbound_to_34",
            "dial_pattern": [
                "X."
            ],
            "trunk": [
                {
                    "id": 35,
                    "name": "peer-to-34"
                }
            ],
            "pos": 1
        },
        {
            "id": 9,
            "name": "to-41-fqdn",
            "dial_pattern": [
                "X."
            ],
            "trunk": [
                {
                    "id": 27,
                    "name": "test-peer-trunking"
                }
            ],
            "pos": 2
        },
        {
            "id": 13,
            "name": "outbound_to_cloud",
            "dial_pattern": [
                "9X."
            ],
            "trunk": [
                {
                    "id": 27,
                    "name": "test-peer-trunking"
                }
            ],
            "pos": 3
        },
        {
            "id": 11,
            "name": "shared-trunk",
            "dial_pattern": [
                "55033X.",
                "123X."
            ],
            "trunk": [
                {
                    "id": 27,
                    "name": "test-peer-trunking"
                }
            ],
            "pos": 4
        }
    ]
}