查询多个呼入路由信息

同时查询多个呼入路由的详细信息。

请求 URL

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

请求参数


参数	是否必填	类型	说明
ids	是	String	呼入路由的唯一 ID。注：可使用搜索特定呼入路由接口查询呼入路由 ID。使用半角逗号 `,` 分隔多个 ID。

响应参数


参数	类型	说明
errcode	Integer	返回错误码。 `0`：请求成功。非零值：请求失败。注：更多错误码和错误信息说明，请参见错误码 & 错误信息。
errmsg	String	返回信息。 `SUCCESS`：请求成功。 `FAILURE`：请求失败。
data	Array<Inroute_Details>	呼入路由详细信息。

Inroute_Details


参数	类型	说明
id	Integer	呼入路由的唯一 ID。
name	String	呼入路由名称。
alert_info	String	呼入路由特色响铃。
did_option	String	DID 号码匹配模式。 `patterns`：匹配 DID 号码规则 `pattern_to_ext`：DID 号码规则匹配到分机 `range_to_ext`：DID 号码范围匹配到分机范围
did_pattern_list	Array<DID_Pattern_List>	当 `did_option` 为 `patterns` 时的 DID 号码匹配规则列表。
did_pattern_to_ext	String	当 `did_option` 为 `pattern_to_ext` 时，匹配到分机的 DID 号码规则。
did_to_ext_start	String	当 `did_option` 为 `range_to_ext` 时，DID 匹配规则范围的起始号码。
did_to_ext_end	String	当 `did_option` 为 `range_to_ext` 时，DID 匹配规则范围的结束号码。
did_pattern_to_ext_list	Array <DID_Ext_List>	当 `did_option` 为 `pattern_to_ext_list` 时的 DID 号码和对应分机列表。
cid_option	String	主叫号码规则匹配。 `patterns`：来电匹配主叫号码规则 `phonebook`：来电匹配特定企业联系人群组
cid_pattern_list	Array<CID_Pattern_List>	当 `cid_option` 为 `patterns` 时，来电的主叫号码匹配规则列表。
cid_to_phonebook	Array<Integer>	当 `cid_option` 为 `phonebook` 时，来电匹配的企业联系人群组的唯一 ID。
trunk_list	Array<Trunk_List>	呼入路由中选择的中继列表。
def_dest	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`：发送传真到邮箱
def_dest_prefix	String	根据 `def_dest` 的目的地设置，此参数返回的信息不同：当 `def_dest` 为 `external_num` 时，此参数显示外部号码的前缀。当 `def_dest` 为 `play_greeting` 时，此参数显示问候语的播放次数。
def_dest_value	String	根据 `def_dest` 的目的地设置，此参数返回的信息不同：当 `def_dest` 为 `external_num` 时，此参数显示外部号码。当 `def_dest` 为 `play_greeting` 时，此参数显示问候语的文件名称。当 `def_dest` 为 `range_to_ext` 时，此参数显示分机范围。当 `def_dest` 为其他目的地时，此参数显示目的地的唯一 ID。例如，目的地为分机 2002，则此参数返回分机 2002 的唯一 ID。
def_dest_ext_list	Array<Ext_List>	当 `def_dest` 为 `pattern_to_ext` 时，此参数返回要匹配的分机/分机组信息。
ringback_tone	String	自定义提示音的文件名。当 `def_dest` 为 `extension`时，系统会在分机用户接听来电之前向呼叫者播放该提示音。
enb_time_condition	Integer	是否启用时间条件。 `0`：禁用。 `1`：启用。
timezone_id	Integer	时区 ID。
time_condition	String	时间类型。 `global`：基于全局办公时间路由来电 `route_scope`：基于自定义办公时间路由来电 `custom`：基于自定义时间段路由来电
time_condition_value	Array<Custom_Time>	自定义办公时间或自定义时间段。
business_hours_destination	String	办公时间内收到的外线来电的目的地。 `end_call`：挂断 `extension`：分机 `ext_vm`：分机语音信箱 `group_vm`：群语音信箱 `outroute`：呼出路由 `ai_receptionist`：AI 接待员 `ring_group`：响铃组 `queue`：队列 `conference`：会议室 `ivr`：IVR `call_flow`：通话流程 `external_num`：外部号码 `play_greeting`：播放问候语后挂断
business_hours_destination_value	String	办公时间内收到的外线来电的详细目的地。注：该参数的定义取决于 `business_hours_destination` 的取值。如果 `business_hours_destination` 为 `play_greeting`，该参数表示自定义提示音的文件名。如果 `business_hours_destination` 为 `extension`、 `ext_vm`、`group_vm`、`ivr`、`call_flow`、`ring_group`、`conference`、`ai_receptionist`、 `outroute` 或 `queue`，该参数表示目的地的 ID。如果 `business_hours_destination` 为 `external_num`，该参数表示外部号码。
outside_business_hours_destination	String	非办公时间收到的外线来电的目的地。 `end_call`：挂断 `extension`：分机 `ext_vm`：分机语音信箱 `group_vm`：群语音信箱 `outroute`：呼出路由 `ai_receptionist`：AI 接待员 `ring_group`：响铃组 `queue`：队列 `conference`：会议室 `ivr`：IVR `call_flow`：通话流程 `external_num`：外部号码 `play_greeting`：播放问候语后挂断
outside_business_hours_destination_value	String	非办公时间收到的外线来电的详细目的地。注：该参数的定义取决于 `outside_business_hours_destination` 的取值。如果 `outside_business_hours_destination` 为 `play_greeting`，该参数表示自定义提示音的文件名。如果 `outside_business_hours_destination` 为 `extension`、 `ext_vm`、`group_vm`、`ivr`、`call_flow`、`ring_group`、`conference`、`ai_receptionist`、 `outroute` 或 `queue`，该参数表示目的地的 ID。如果 `outside_business_hours_destination` 为 `external_num`，该参数表示外部号码。
holidays_hours_destination	String	假期期间收到的外线来电的目的地。 `end_call`：挂断 `extension`：分机 `ext_vm`：分机语音信箱 `group_vm`：群语音信箱 `outroute`：呼出路由 `ai_receptionist`：AI 接待员 `ring_group`：响铃组 `queue`：队列 `conference`：会议室 `ivr`：IVR `call_flow`：通话流程 `external_num`：外部号码 `play_greeting`：播放问候语后挂断
holidays_hours_destination_value	String	假期期间收到的外线来电的详细目的地。注：该参数的定义取决于 `holidays_hours_destination` 的取值。如果 `holidays_hours_destination` 为 `play_greeting`，该参数表示自定义提示音的文件名。如果 `holidays_hours_destination` 为 `extension`、 `ext_vm`、`group_vm`、`ivr`、`call_flow`、`ring_group`、`conference`、`ai_receptionist`、 `outroute` 或 `queue`，该参数表示目的地的 ID。如果 `holidays_hours_destination` 为 `external_num`，该参数表示外部号码。
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` 时，该参数返回具体值。
timezone_options	Object<Timezone_List>	时区的基本信息。

DID_Pattern_List


参数	类型	说明
id	Integer	DID 匹配规则的唯一 ID。
did_pattern	String	DID 匹配规则。

DID_Ext_List


参数	类型	说明
id	Integer	DID 号码匹配规则的唯一 ID。
did_pattern	String	DID 号码。
did_pattern_to_ext	String	DID 号码对应分机的唯一 ID。

CID_Pattern_List


参数	类型	说明
id	Integer	主叫号码匹配规则的唯一 ID。
cid_pattern	String	主叫号码匹配规则。

Trunk_List


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

Ext_List


参数	类型	说明
value	String	分机/分机组的唯一 ID。
name	String	分机/分机组名称。
number	String	分机号码。
type	String	所选项目的类型。 `extension`：分机 `ext_group`：分机组

Custom_Time


参数	类型	说明
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/query?ids=29,30&access_token=gYFPycZxVlJSmvMqylho3qBNz6QNWqHE HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": [
        {
            "id": 29,
            "name": "test4",
            "did_option": "patterns",
            "did_pattern_list": [
                {
                    "id": 45,
                    "did_pattern": "5503301"
                }
            ],
            "cid_option": "patterns",
            "trunk_list": [
                {
                    "id": 27,
                    "name": "test-peer-trunking",
                    "type": "peer"
                }
            ],
            "def_dest": "play_greeting",
            "def_dest_prefix": "2",
            "def_dest_value": "bruno-mars.wav",
            "ringback_tone": "",
            "enb_time_condition": 1,
            "timezone_id": 1,
            "time_condition": "route_scope",
            "time_condition_value": [
            {
                "id": 6,
                "pos": 1,
                "days_of_week": "mon tue wed thu fri",
                "times": [
                    "08:45-11:45",
                    "13:15-18:00"
                ],
                "months": "jan feb mar apr may jun jul aug sep oct nov dec",
                "days": "1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31",
                "dest": "",
                "dest_prefix": "",
                "dest_value": "",
                "time_condition_switch": 1
        },
        {
            "id": 30,
            "name": "test5",
            "did_option": "range_to_ext",
            "did_to_ext_start": "5503301",
            "did_to_ext_end": "5503310",
            "cid_option": "phonebook",
            "cid_to_phonebook": "[10]",
            "trunk_list": [
                {
                    "id": 28,
                    "name": "6700-account-trunking",
                    "type": "account"
                }
            ],
            "def_dest": "range_to_ext",
            "def_dest_value": "2001-2010",
            "ringback_tone": "",
            "enb_time_condition": 1,
            "timezone_id": 1,
            "time_condition": "global",
            "time_condition_value": null,
            "business_hours_destination": "extension",
            "business_hours_destination_value": "159",
            "outside_business_hours_destination": "group_vm",
            "outside_business_hours_destination_value": "1",
            "holidays_hours_destination": "ivr",
            "holidays_hours_destination_value": "1",
            "enb_holiday_dest_ignore": 0,
            "enb_play_holiday_prompt_global": 0,
            "prefix_code": "",
            "reset_code": "",
            "holiday_code": "",
            "office_code": "",
            "timezone_options": {
            "name": "Global Time Zone",
            "utc_offset": "UTC+8 Asia/Shanghai",
            "timezone_info": "8 China (Beijing)",
            "value": "1",
            "type": "global"
        }
    ]
}