Search Specific Outbound Routes

Search specific outbound routes from the Outbound Route list.

Request URL

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

Request parameters

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.
  • asc: Ascending order.
  • desc: Descending order.
search_value No String Search keyword.

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.
total_number Integer The total of the searched 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
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.

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>

The list of custom business hours.

timezone_id

Integer

The ID of the time zone.
Trunk_List
Parameter Type Description
id Integer The unique ID of the selected trunk.
name String The name of the selected trunk.
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/search?page=1&page_size=20&sort_by=pos&order_by=asc&search_value=shared&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": 1,
    "last_pos": 3,
    "data": [
        {
            "id": 11,
            "name": "shared-trunk",
            "dial_pattern": [
                "55033X."
            ],
            "pos": 3
        }
    ]
}