Add an Inbound Route

Add and configure an inbound route.

Request URL

POST {base_url}/{api_path}/inbound_route/create?access_token={access_token}

Request parameters

Table 1.
Parameter	Required	Type	Description
name	Yes	String	The name of the inbound route.
alert_info	No	String	Inbound alert info.
did_option	No	String	DID matching mode. Valid value: `patterns`: Match DID patterns. (Default) `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.
did_pattern_list	No	Array<DID_Pattern_List>	The DID matching pattern list. Note: This parameter is required when the `did_option` is `patterns`.
did_pattern_to_ext	No	String	The DID pattern matching to extensions. Note: This parameter is required when the `did_option` is `pattern_to_ext`.
did_to_ext_start	No	String	The start number of the DID matching pattern range. Note: This parameter is required when the `did_option` is `range_to_ext`.
did_to_ext_end	No	String	The end number of the DID matching pattern range. Note: This parameter is required when the `did_option` is `range_to_ext`.
did_pattern_to_ext_list	No	Array<DID_Pattern_Ext_List>	The list of DID numbers and the corresponding extensions. Note: This parameter is required when the `did_option` is `pattern_to_ext_list`.
cid_option	No	String	The Caller ID matching pattern. Valid value: `patterns`: Match Caller ID patterns. `phonebook`: Match contacts' caller ID in specific phonebooks.
cid_pattern_list	No	Array<CID_Pattern_List>	The Caller ID matching pattern list. Note: This parameter is required when the `cid_option` is `patterns`.
cid_to_phonebook	No	Array<Integer>	The ID(s) of the selected phonebook(s). Note: This parameter is required when the `cid_option` is `phonebook`. You can query the phonebook's ID using Search Specific Phonebooks. Use a comma to separate multiple IDs.
trunk_list	Yes	Array<Trunk_List>	The list of the selected trunk in the inbound route.
def_dest	Yes	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 `call_flow`: Call Flow `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	No	String	This parameter defines different settings depending on the value of `def_dest`. When `def_dest` is `external_num`, this parameter defines the prefix of the external number. When `def_dest` is `play_greeting`, this parameter defines the play count of the greeting.
def_dest_value	No	String	This parameter defines different settings depending on the value of `def_dest`. When `def_dest` is `external_num`, this parameter defines the external number. When `def_dest` is `play_greeting`, this parameter defines the custom prompt file name. E.g. `Test.wav`. When `def_dest` is `range_to_ext`, this parameter defines the extension range. E.g. `2001-2010`. When `def_dest` is other destinations, this parameter should be the unique ID of the destination. For example, if the destination is the extension 2002 or the extension voicemail of 2002, then you need to enter the ID of the extension 2002. Note: You can query the ID of desired options using Get Menu Options.
def_dest_ext_list	No	Array<Ext_List>	The list of selected extensions/extension groups. Note: This parameter is required when the `def_dest` is set to `pattern_to_ext`.

DID_Pattern_List

Table 2.
Parameter	Required	Type	Description
did_pattern	Yes	String	DID matching patten rule.

DID_Pattern_Ext_List


Parameter	Required	Type	Description
did_pattern	Yes	String	The specific DID number.
did_pattern_to_ext	Yes	String	The unique ID of the extension that corresponds to the DID number. Note: You can query the extension's ID using Search Specific Extensions.

CID_Pattern_List

Table 3.
Parameter	Required	Type	Description
cid_pattern	Yes	String	Caller ID matching pattern rule.

Trunk_List

Table 4.
Parameter	Required	Type	Description
id	Yes	Integer	The unique ID of the selected trunk. Note: You can query the trunk's ID using Search Specific Trunks.
name	No	String	Trunk name.
type	No	String	Trunk type.

Ext_List

Table 5.
Parameter	Required	Type	Description
value	Yes	String	The unique ID of the extension/extension group. Note: You can query the extension's ID using Search Specific Extensions. You can query the extension group's ID using Get Menu Options.
name	No	String	The name of the extension/extension group.
number	No	String	Extension number.
type	No	String	The type of the selected item. Valid value: `extension` `ext_group`

Response parameters

Table 6.
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.
id	Integer	The unique ID of the inbound route.

Examples

Request example

POST /openapi/v1.0/inbound_route/create?access_token=Rka0iV0BJUVTXj1EYpwbg2YUkODdw22N HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
    "name": "test",
    "did_option":"pattern_to_ext",
    "did_pattern_to_ext": "550330{{.Ext}}",
    "cid_option":"phonebook",
    "cid_to_phonebook":[8,10],  
    "trunk_list":[{"id":28}],
    "def_dest":"pattern_to_ext",
    "def_dest_ext_list":[{"value":"39"},{"value":"67","type":"ext_group"}]
}

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "id": 15
}