查询多个呼出路由信息

请求 URL

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

请求参数

响应参数

Outroute_Details

参数	类型	说明
id	Integer	呼出路由的唯一 ID。
name	String	呼出路由名称。
outbound_cid	String	呼出路由去电显示号码。
dial_pattern_list	Object<Dialpattern_List>	呼出号码匹配规则列表。
trunk_list	Object<Trunk_List>	呼出路由中继列表。
ext_list	Object<Ext_List>	呼出路由分机列表。
pos	Integer	呼出路由在列表中的当前位置。
pin_protect	String	呼出路由密码。 disable：禁用 single_pin：单个密码 pin_list：PIN 码列表
pin	String	单个密码。
pin_list	Integer	PIN 码列表的唯一 ID。
available_time	String	呼出路由的可用时间。 always：总是可用。 global：使用各时区配置的办公时间。 route_scope：使用自定义办公时间。 custom：使用自定义时间段。
enb_holiday	Integer	是否允许在节假日期间使用呼出路由。 0：禁用 1：启用
enb_office_time	Integer	是否允许在办公时间使用呼出路由。 0：禁用 1：启用
enb_out_of_office_time	Integer	是否允许在非办公时间使用呼出路由。 0：禁用 1：启用
office_time_list	Array<Time_Setting>	自定义办公时间。
timezone_id	Integer	时区 ID。

Dialpattern_List

参数	类型	说明
id	Integer	呼出号码匹配规则的唯一 ID。
pattern	String	号码规则。
strip	Integer	删除的前缀位数。
prepend	String	增加的前缀号码。

Trunk_List

参数	类型	说明
id	Integer	中继的唯一 ID。
name	String	中继名称。
type	String	中继类型。

Ext_List

参数	类型	说明
ext_number	String	分机号码。
ext_name	String	分机/分机组/部门的名称。
type	String	所选项目的类型。 extension：分机 ext_group：分机组 organization：部门
id	Integer	分机/分机组/部门的唯一 ID。

Time_Setting

参数	类型	说明
months	String	办公时间适用的月份。 all：每月 jan：一月 feb：二月 mar：三月 apr：四月 may：五月 jun：六月 jul：七月 aug：八月 sep：九月 oct：十月 nov：十一月 dec：十二月
days_of_week	String	办公时间适用的星期。 all：每天 sun：周日 mon：周一 tue：周二 wed：周三 thu：周四 fri：周五 sat：周六
days	String	办公时间适用的日期。 all：每月的每一天 1-31：每月指定的日期
office_times	Array<Time_Period>	自定义时间段。
time_condition_switch	Integer	是否启用高级时间条件。 0：禁用。 1：启用。

Time_Period

参数	类型	说明
value	String	时间段，格式为 HH:MM-HH:MM。

示例

请求示例

GET /openapi/v1.0/outbound_route/query?ids=9,11,13&access_token=JP1mzonWn6tDLJHLMex2IQf2ZLKElEuF HTTP/1.1
Host: 192.168.5.150:8088

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": [
        {
            "id": 9,
            "name": "to-41",
            "outbound_cid": "",
            "dial_pattern_list": [
                {
                    "id": 10,
                    "pattern": "X.",
                    "strip": 0
                }
            ],
            "trunk_list": [
                {
                    "id": 27,
                    "name": "test-peer-trunking",
                    "type": "peer"
                }
            ],
            "ext_list": [
                {
                    "ext_number": "2002",
                    "ext_name": "Terrell Smith",
                    "type": "extension",
                    "id": 76
                },
                {
                    "ext_number": "2001",
                    "ext_name": "Phillip Huff",
                    "type": "extension",
                    "id": 77
                },
                {
                    "ext_number": "2003",
                    "ext_name": "Dave Harris",
                    "type": "extension",
                    "id": 75
                },
                {
                    "ext_number": "2005",
                    "ext_name": "Kristin Hale",
                    "type": "extension",
                    "id": 41
                },
                {
                    "ext_number": "2008",
                    "ext_name": "Anna Simmons",
                    "type": "extension",
                    "id": 61
                }
            ],
            "pos": 2,
            "pin_protect": "disable"
        },
        {
            "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"
        },
        {
            "id": 13,
            "name": "outbound_to_cloud",
            "outbound_cid": "",
            "dial_pattern_list": [
                {
                    "id": 14,
                    "pattern": "9X.",
                    "strip": 0
                }
            ],
            "trunk_list": [
                {
                    "id": 27,
                    "name": "test-peer-trunking",
                    "type": "peer"
                }
            ],
            "ext_list": [
                {
                    "ext_number": "2002",
                    "ext_name": "Terrell Smith",
                    "type": "extension",
                    "id": 76
                }
            ],
            "pos": 3,
            "pin_protect": "pin_list",
            "pin_list": 1
        }
    ]
}