Query Information of Multiple Inbound Routes

Query the detailed information of multiple inbound routes at the same time.

Request URL

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

Request parameters

Table 1.
Parameter	Required	Type	Description
ids	Yes	String	The unique ID(s) of the inbound route(s). Note: You can query the inbound route's ID using Search Specific Inbound Routes. Use a comma to separate multiple IDs.

Response parameters

Table 2.
Parameter	Type	Description
errcode	Integer	Returned error code. `0`: Succeed. Non-zero value: Failed. Note: You can check the error code and error message in Error Code and Error Message.
errmsg	String	Returned message. `SUCCESS`: Succeed. `FAILURE`: Failed.
data	Array<Inroute_Details>	The detailed information of the inbound route.

Inroute_Details

Table 3.
Parameter	Type	Description
id	Integer	The unique ID of the inbound route.
name	String	The name of the inbound route.
alert_info	String	Inbound alert info.
did_option	String	DID matching mode. `patterns`: Match DID patterns. `pattern_to_ext`: Match DID pattern to extensions. `range_to_ext`: Match DID Range to Extension range.
did_pattern_list	Array<DID_Pattern_List>	The DID matching pattern list when the `did_option` is `patterns`.
did_pattern_to_ext	String	The DID matching pattern to extensions when the `did_option` is `pattern_to_ext`.
did_to_ext_start	String	The start number of the DID matching pattern range when the `did_option` is `range_to_ext`.
did_to_ext_end	String	The end number of the DID matching pattern range when the `did_option` is `range_to_ext`.
did_pattern_to_ext_list	Array <DID_Ext_List>	The list of DID numbers and the corresponding extensions when the `did_option` is `pattern_to_ext_list`.
cid_option	String	Caller ID matching pattern. `patterns`: Match Caller ID patterns. `phonebook`: Match contacts' caller ID in specific phonebooks
cid_pattern_list	Array<CID_Pattern_List>	The Caller ID matching pattern list when the `cid_option` is `patterns`.
cid_to_phonebook	Array<Integer>	The ID of the selected phonebook when the `cid_option` is `phonebook`.
trunk_list	Array<Trunk_List>	The list of the selected trunk in the inbound route.
def_dest	String	Default destination. `disabled` `end_call`: Hang up `extension`: Extension `pattern_to_ext`: Match DID pattern to extensions `range_to_ext`: Match DID range to extension range `pattern_to_ext_list`: Match DID number(s) to extension(s) in one-to-one correspondence. `ext_vm`: Extension voicemail `ivr`: IVR `ring_group`: Ring group `queue`: Queue `group_vm`: Group voicemail `conference`: Conference `external_num`: External number `outroute`: Outbound route `play_greeting`: Play greeting then hang up `fax_to_email`: Fax to email
def_dest_prefix	String	This parameter returns different information depending on the `def_dest`. When `def_dest` is `external_num`, this parameter displays the prefix of the external number. When `def_dest` is `play_greeting`, this parameter displays the playback count of the greeting.
def_dest_value	String	This parameter returns different results depending on the `def_dest`. When `def_dest` is `external_num`, this parameter displays the external number. When `def_dest` is `play_greeting`, this parameter displays the prompt name. When `def_dest` is `range_to_ext`, this parameter displays the extension range. When `def_dest` is other destinations, this parameter displays the unique ID of the destination. For example, the destination is the extension 2002, then this field will return the ID of the extension 2002.
def_dest_ext_list	Array<Ext_List>	The selected extensions/extension groups when the `def_dest` is `pattern_to_ext`.

DID_Pattern_List

Table 4.
Parameter	Type	Description
id	Integer	The unique ID of the DID pattern.
did_pattern	String	The DID matching rules.

DID_Ext_List


Parameter	Type	Description
id	Integer	The unique ID of the DID number matching rule.
did_pattern	String	The DID number.
did_pattern_to_ext	String	The ID of the extension that corresponds to the DID number.

CID_Pattern_List

Table 5.
Parameter	Type	Description
id	Integer	The unique ID of the Caller ID pattern.
cid_pattern	String	The Caller ID matching rules.

Trunk_List

Table 6.
Parameter	Type	Description
id	Integer	The unique ID of the selected trunk.
name	String	Trunk name.
type	String	Trunk type.

Ext_List

Table 7.
Parameter	Type	Description
value	String	The unique ID of the extension/extension group.
name	String	The name of the extension/extension group.
number	String	Extension number.
type	String	The type of the selected item. `extension` `ext_group`

Examples

Request example

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

Response example

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