Query Information of an Outbound Route

Query the detailed configurations of an outbound route.

Request URL

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

Request parameters

Parameter Required Type Description
id Yes Integer The unique ID of the outbound route.
Note: You can query the outbound route's ID using Search Specific Outbound Routes.

Response parameters

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.
data Object<Outroute_Details> The detailed information of the outbound route.
Outroute_Details
Parameter Type Description
id Integer The unique ID of the outbound route.
name String The name of the outbound route.
outbound_cid String The outbound caller ID of the outbound route.
dial_pattern_list Array<Dialpattern_List> The dial pattern list.
trunk_list Array<Trunk_List> The list of the selected trunk in the outbound route.
ext_list Array<Ext_List> Th information list of the selected extensions.
pos Integer The current position of the outbound route in the list.
pin_protect String Outbound route password.
  • disable
  • single_pin
  • pin_list
pin String Single PIN code.
pin_list Integer The ID of the selected PIN list.

available_time

String

The available time of the outbound route.

  • always: Always available.
  • global: Based on business hours configured for the time zone.
  • route_scope: Based on custom business hours.
  • custom: Based on custom time periods.

enb_holiday

Integer

Whether the outbound route is available during holidays.

  • 0: Disabled
  • 1: Enabled

enb_office_time

Integer
Whether the outbound route is available during business hours.
  • 0: Disabled
  • 1: Enabled

enb_out_of_office_time

Integer
Whether the outbound route is available outside business hours.
  • 0: Disabled
  • 1: Enabled

office_time_list

 Array<Time_Setting>

Custom business hours.

timezone_id

Integer

The ID of the time zone.
Dialpattern_List
Parameter Type Description
id Integer The unique ID of the dial pattern.
pattern String The dial pattern matching rules.
strip Integer The number of digits that will be stripped from the beginning of a dialed number before the call is placed.
prepend String The digits that will be prepended to the phone number before the call is placed.
Trunk_List
Parameter Type Description
id Integer The unique ID of the selected trunk.
name String Trunk name.
type String Trunk type.
Ext_List
Parameter Type Description
ext_number String Extension number.
ext_name String The name of the extension/extension group/organization.
type String The type of the selected item.
  • extension
  • ext_group
  • organization
id Integer The unique ID of the selected extension/extension group/organization.
Time_Setting
Parameter Type Description
months String The months during which the business hour applies.
  • all: Every month.
  • jan: January.
  • feb: February.
  • mar: March.
  • apr: April.
  • may: May.
  • jun: June.
  • jul: July.
  • aug: August.
  • sep: September.
  • oct: October.
  • nov: November.
  • dec: December.
days_of_week String The days of the week on which the business hour applies.
  • all: Every day.
  • sun: Sunday.
  • mon: Monday.
  • tue: Tuesday.
  • wed: Wednesday.
  • thu: Thursday.
  • fri: Friday.
  • sat: Saturday.
days String The days of the month on which the business hour applies.
  • all: Every day of the month.
  • 1-31: The specified day or days of the month.

office_times

 Array<Time_Period> The list of office time periods.
time_condition_switch Integer Whether the advanced time condition is enabled.
  • 0: Disabled.
  • 1: Enabled.
Time_Period
Parameter Type Description
value String The time period, in the format HH:MM-HH:MM.

Examples

Request example

GET /openapi/v1.0/outbound_route/get?id=11&access_token=nIAuSgDUim0uZgrNuha8hfzwbvY41NWR HTTP/1.1
Host: 192.168.5.150:8088

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": {
        "id": 11,
        "name": "shared-trunk",
        "outbound_cid": "",
        "dial_pattern_list": [
            {
                "id": 12,
                "pattern": "55033X.",
                "strip": 5
            },
            {
                "id": 22,
                "pattern": "123X.",
                "strip": 1,
                "prepend": "55033"
            }
        ],
        "trunk_list": [
            {
                "id": 27,
                "name": "test-peer-trunking",
                "type": "peer"
            }
        ],
        "ext_list": [
            {
                "ext_number": "2010",
                "ext_name": "Wayne Willis",
                "type": "extension",
                "id": 58
            }
        ],
        "pos": 4,
        "pin_protect": "single_pin",
        "pin": "1234"
    }
}