查询呼入路由列表

查询呼入路由列表信息。

请求 URL

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

请求参数


参数	是否必填	类型	说明
page	否	Integer	定义显示第几个页面。
page_size	否	Integer	定义每页显示几项查询结果。
sort_by	否	String	定义排序字段。取值范围： `id` `pos` `name`
order_by	否	String	定义显示顺序。取值范围： `asc`：升序 `desc`：降序

响应参数


参数	类型	说明
errcode	Integer	返回错误码。 `0`：请求成功。非零值：请求失败。注：更多错误码和错误信息说明，请参见错误码 & 错误信息。
errmsg	String	返回信息。 `SUCCESS`：请求成功。 `FAILURE`：请求失败。
total_number	Integer	呼入路由总数。
last_pos	Integer	呼入路由列表排序最大值。
data	Array <Inroute_Info>	呼入路由基本信息。

Inroute_Info


参数	类型	说明
id	Integer	呼入路由的唯一 ID。
pos	Integer	呼入路由在列表中的当前位置。
name	String	呼入路由名称。
default_destination	String	呼入路由的默认目的地。 `disabled` `end_call`：挂断 `extension`：分机 `pattern_to_ext`：匹配分机 `range_to_ext`：分机范围 `pattern_to_ext_list`：DID 号码匹配到指定分机。 `ext_vm`：分机语音信箱 `ivr`：IVR `call_flow`：通话流程 `ring_group`：响铃组 `queue`：队列 `group_vm`：群语音信箱 `conference`：会议室 `external_num`：外部号码 `outroute`：呼出路由 `play_greeting`：播放问候语后挂断 `fax_to_email`：发送传真到邮箱
default_desination_value	String	呼入路由默认目的地的具体值。
current_destination	String	呼入路由的当前目的地。 `end_call`：挂断 `extension`：分机 `pattern_to_ext`：DID 号码规则匹配到分机 `range_to_ext_dest`：DID 号码范围匹配到分机范围 `ext_vm`：分机语音信箱 `ivr`：IVR `call_flow`：通话流程 `ring_group`：响铃组 `queue`：队列 `group_vm`：群语音信箱 `conference`：会议室 `external_num`：外部号码 `outroute`：呼出路由 `play_greeting`：播放问候语后挂断 `fax_to_email`：发送传真到邮箱
current_desination_value	String	呼入路由当前目的地的具体值。
time_condition	String	时间类型。 `disabled`：所有来电被路由到默认目的地 `global`：基于全局办公时间路由来电 `route_scope`：基于自定义办公时间路由来电 `custom`：基于自定义时间段路由来电
business_hours_destination	String	办公时间内来电的目的地。 `disabled` `end_call`：挂断 `extension`：分机 `pattern_to_ext`：DID 号码规则匹配到分机 `range_to_ext`：DID 号码范围匹配到分机范围 `pattern_to_ext_list`：DID 号码匹配到指定分机。 `ext_vm`：分机语音信箱 `ivr`：IVR. `call_flow`：通话流程 `ring_group`：响铃组 `queue`：队列 `group_vm`：群语音信箱 `conference`：会议室 `external_num`：外部号码 `outroute`：呼出路由 `play_greeting`：播放问候语后挂断 `fax_to_email`：发送传真到邮箱
business_hours_destination_value	String	办公时间内来电的具体目的地。
outside_business_hours_destination	String	非办公时间内来电的目的地。 `disabled` `end_call`：挂断 `extension`：分机 `pattern_to_ext`：DID 号码规则匹配到分机 `range_to_ext`：DID 号码范围匹配到分机范围 `pattern_to_ext_list`：DID 号码匹配到指定分机。 `ext_vm`：分机语音信箱 `ivr`：IVR. `call_flow`：通话流程 `ring_group`：响铃组 `queue`：队列 `group_vm`：群语音信箱 `conference`：会议室 `external_num`：外部号码 `outroute`：呼出路由 `play_greeting`：播放问候语后挂断 `fax_to_email`：发送传真到邮箱
outside_business_hours_destination_value	String	非办公时间内来电的具体目的地。
holidays_hours_destination	String	假期时间内来电的目的地。 `disabled` `end_call`：挂断 `extension`：分机 `pattern_to_ext`：DID 号码规则匹配到分机 `range_to_ext`：DID 号码范围匹配到分机范围 `pattern_to_ext_list`：DID 号码匹配到指定分机。 `ext_vm`：分机语音信箱 `ivr`：IVR. `call_flow`：通话流程 `ring_group`：响铃组 `queue`：队列 `group_vm`：群语音信箱 `conference`：会议室 `external_num`：外部号码 `outroute`：呼出路由 `play_greeting`：播放问候语后挂断 `fax_to_email`：发送传真到邮箱
holidays_hours_destination_value	String	假期时间内来电的具体目的地。
time_condition_value	Array<Time_Condition_Info>	时间条件的信息。注：仅当 `time_condition` 设置为 `route_scope` or `custom` 时，才会显示此参数。

Time_Condition_Info


参数	类型	说明
days_of_week	String	星期几。 `mon` `tue` `wed` `thu` `fri` `sat` `sun`
times	String	时间段。

示例

请求示例

GET /openapi/v1.0/inbound_route/list?page=1&page_size=20&sort_by=pos&order_by=asc&access_token=VpTsz7k6XSOpfjDntqetBQ7nSE9QsbAN HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 5,
    "last_pos": 5,
    "data": [
        {
            "id": 52,
            "pos": 1,
            "name": "from-110",
            "default_destination": "extension",
            "current_destination": "extension",
            "time_condition": "disabled",
            "default_desination_value": "2005-Kristin Hale",
            "current_desination_value": "2005-Kristin Hale"
        },
        {
            "id": 48,
            "pos": 2,
            "name": "from41",
            "default_destination": "ring_group",
            "current_destination": "ring_group",
            "time_condition": "disabled",
            "default_desination_value": "Support",
            "current_desination_value": "6300-Support"
        },
        {
            "id": 49,
            "pos": 3,
            "name": "from-35",
            "default_destination": "disabled",
            "current_destination": "end_call",
            "time_condition": "custom",
            "time_condition_value": [
                {
                    "days_of_week": "mon tue",
                    "times": [
                        "09:15-12:00"
                    ]
                }
            ],
            "business_hours_destination": "end_call",
            "outside_business_hours_destination_value": "39",
            "holidays_hours_destination": "ivr",
            "holidays_hours_destination_value": "Holiday"
        },
        {
            "id": 50,
            "pos": 4,
            "name": "from-34",
            "default_destination": "disabled",
            "current_destination": "ring_group",
            "time_condition": "route_scope",
            "current_desination_value": "6300-Support",
            "time_condition_value": [
                {
                    "days_of_week": "mon tue wed thu fri",
                    "times": [
                        "09:00-11:30",
                        "13:30-17:40"
                    ]
                }
            ],
            "business_hours_destination": "ring_group",
            "business_hours_destination_value": "Support",
            "outside_business_hours_destination": "ivr",
            "outside_business_hours_destination_value": "Self-Service",
            "holidays_hours_destination": "ivr",
            "holidays_hours_destination_value": "Holiday"
        },
        {
            "id": 53,
            "pos": 5,
            "name": "local_support",
            "default_destination": "disabled",
            "current_destination": "ring_group",
            "time_condition": "global",
            "current_desination_value": "6300-Support",
            "business_hours_destination": "ring_group",
            "business_hours_destination_value": "Support",
            "outside_business_hours_destination": "ivr",
            "outside_business_hours_destination_value": "Self-Service",
            "holidays_hours_destination": "ivr",
            "holidays_hours_destination_value": "Holiday"
        }
    ]
}