查询多个呼入路由信息

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

请求 URL

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

请求参数

表 1.
参数 是否必填 类型 说明
ids 是 String 呼入路由的唯一 ID。
注：

响应参数

表 2.
参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
data Array<Inroute_Details> 呼入路由详细信息。
Inroute_Details
表 3.
参数 类型 说明
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
  • ring_group：响铃组
  • 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 时，此参数返回要匹配的分机/分机组信息。
DID_Pattern_List
表 4.
参数 类型 说明
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
表 5.
参数 类型 说明
id Integer 主叫号码匹配规则的唯一 ID。
cid_pattern String 主叫号码匹配规则。
Trunk_List
表 6.
参数 类型 说明
id Integer 中继的唯一 ID。
name String 中继名称。
type String 中继类型。
Ext_List
表 7.
参数 类型 说明
value String 分机/分机组的唯一 ID。
name String 分机/分机组名称。
number String 分机号码。
type String 所选项目的类型。
  • extension：分机
  • ext_group：分机组

示例

请求示例

GET /openapi/v1.0/inbound_route/query?ids=29,30&access_token=gYFPycZxVlJSmvMqylho3qBNz6QNWqHE HTTP/1.1
Host: 192.168.5.150:8088

响应示例

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"
        },
        {
            "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"
        }
    ]
}