搜索特定呼入路由

在呼入路由列表中搜索特定呼入路由。

请求 URL

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

请求参数

参数 是否必填 类型 说明
page 否 Integer 定义显示第几个页面。
page_size 否 Integer 定义每页显示几项查询结果。
sort_by 否 String 定义排序字段。

取值范围：

  • id
  • pos
  • name
order_by 否 String 定义显示顺序。

取值范围：

  • asc：升序
  • desc：降序
search_value 否 String 搜索关键字。

响应参数

参数 类型 说明
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：响铃组
  • ai_receptionist：AI 接待员
  • 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：响铃组
  • ai_receptionist：AI 接待员
  • queue：队列
  • group_vm：群语音信箱
  • conference：会议室
  • external_num：外部号码
  • outroute：呼出路由
  • play_greeting：播放问候语后挂断
  • fax_to_email：发送传真到邮箱
current_desination_value String 呼入路由当前目的地的具体值。
time_condition String 时间类型。
  • disabled：禁用。所有来电被路由到默认目的地
  • global：基于全局办公时间路由来电
  • route_scope：基于自定义办公时间路由来电
  • custom：基于自定义时间段路由来电
timezone_id Integer 时区 ID。
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：响铃组
  • ai_receptionist：AI 接待员
  • 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：响铃组
  • ai_receptionist：AI 接待员
  • 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：响铃组
  • ai_receptionist：AI 接待员
  • queue：队列
  • group_vm：群语音信箱
  • conference：会议室
  • external_num：外部号码
  • outroute：呼出路由
  • play_greeting：播放问候语后挂断
  • fax_to_email：发送传真到邮箱
holidays_hours_destination_value String 假期时间内来电的具体目的地。
enb_holiday_dest_ignore Integer 是否将假期期间收到的外线来电按照办公时间目的地进行路由。
  • 0：禁用。
  • 1：启用。
enb_play_holiday_prompt_global Integer 是否在将假期期间收到的外线来电路由至假期目的地之前播放假期提示音。
  • 0：禁用。
  • 1：启用。
prefix_code String 用于切换呼入路由时间条件的特征码前缀。
reset_code String 将该呼入路由切换到当前时间对应目的地的特征码。
注： 仅当 time_condition 设置为 custom 时，该参数返回具体值。
holiday_code String 将该呼入路由切换到假期目的地的特征码。
注： 仅当 time_condition 设置为 custom 时，该参数返回具体值。
office_code String 将该呼入路由切换到默认目的地的特征码。
注： 仅当 time_condition 设置为 custom 时，该参数返回具体值。
time_condition_value Array<Time_Condition_Info> 时间条件的信息。
注： 仅当 time_condition 设置为 route_scope 或 custom 时，才会显示此参数。
Time_Condition_Info
参数 类型 说明
id Integer 时间段唯一 ID。
pos Integer 时间段显示顺序。
days_of_week Integer 时间段适用的星期。
  • sun：星期日
  • mon：星期一
  • tue：星期二
  • wed：星期三
  • thu：星期四
  • fri：星期五
  • sat：星期六
times Array<String> 时间段的时间范围。
months String 时间段适用的月份。
  • jan：一月
  • feb：二月
  • mar：三月
  • apr：四月
  • may：五月
  • jun：六月
  • jul：七月
  • aug：八月
  • sep：九月
  • oct：十月
  • nov：十一月
  • dec：十二月
days String 时间段适用的日期。
dest String

时间段内收到的外线来电的目的地前缀。

  • end_call：挂断
  • extension：分机
  • ext_vm：分机语音信箱
  • group_vm：群语音信箱
  • outroute：呼出路由
  • ai_receptionist：AI 接待员
  • ring_group：响铃组
  • queue：队列
  • conference：会议室
  • ivr：IVR
  • call_flow：通话流程
  • external_num：外部号码
  • play_greeting：播放问候语后挂断
dest_prefix String 时间段内收到的外线来电的目的地前缀。
注： 仅当 time_condition 设置为 custom 或 route_scope 且 dest 设置为 external_num 或 play_greeting 时，该参数才返回值。
  • 如果 dest 为 external_num，该参数表示外部号码的呼出前缀。
  • 如果 dest 为 play_greeting，该参数表示提示音的播放次数。
dest_value String 时间段内收到的外线来电的详细目的地。
注： 该参数的定义取决于 dest 的取值。
  • 如果 dest 为 play_greeting，该参数表示自定义提示音的文件名。
  • 如果 dest 为 extension、ext_vm、 group_vm、ivr、call_flow、 ring_group、conference、ai_receptionist、outroute 或 queue，该参数表示目的地的 ID。
  • 如果 dest 为 external_num，该参数表示外部号码。
time_condition_switch Integer 是否启用高级时间设置，以支持按星期、月份和日期的组合方式配置时间条件。
  • 0：禁用。
  • 1：启用。
Timezone_List
参数 类型 说明
name String PBX 中配置的时区名称。
utc_offset String 时区信息，包括 UTC 偏移和时区标识符。
timezone_info String 时区显示名称。
value String 时区 ID。
type String 时区类型。
  • global：默认时区。
  • custom：自定义时区。

示例

请求示例

GET /openapi/v1.0/inbound_route/search?page=1&page_size=20&sort_by=pos&order_by=asc&search_value=test-inbound&access_token=wgUqVP0SrMGxssA3wlUAmwqWuZjPdNWs HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 1,
    "last_pos": 7,
    "data": [
        {
            "id": 6,
            "pos": 6,
            "name": "aatest",
            "default_destination": "disabled",
            "current_destination": "ring_group",
            "time_condition": "custom",
            "current_desination_value": "6300-6300",
            "time_condition_value": [
                {
                    "id": 8,
                    "pos": 1,
                    "days_of_week": "mon tue wed thu fri",
                    "times": [
                        "08:45-11:45",
                        "13:15-18:00"
                    ],
                    "months": "",
                    "days": "",
                    "dest": "ring_group",
                    "dest_prefix": "",
                    "dest_value": "1",
                    "time_condition_switch": 0
                },
                {
                    "id": 9,
                    "pos": 2,
                    "days_of_week": "mon tue wed thu fri",
                    "times": [
                        "11:45-13:15"
                    ],
                    "months": "",
                    "days": "",
                    "dest": "ivr",
                    "dest_prefix": "",
                    "dest_value": "1",
                    "time_condition_switch": 0
                }
            ],
            "business_hours_destination": "end_call",
            "outside_business_hours_destination": "end_call",
            "holidays_hours_destination": "end_call",
            "timezone_id": 1,
            "enb_holiday_dest_ignore": 0,
            "enb_play_holiday_prompt_global": 0,
            "prefix_code": "*81",
            "reset_code": "*8100",
            "holiday_code": "*8101",
            "office_code": "*8102",
            "timezone_options": {
                "name": "Global Time Zone",
                "utc_offset": "UTC+8 Asia/Shanghai",
                "timezone_info": "8 China (Beijing)",
                "value": "1",
                "type": "global"
            }
        }
    ]
}