Add an Inbound Route

Request URL

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

Request parameters

DID_Pattern_List

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

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

Trunk_List

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

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

Custom_Time

Parameter	Required	Type	Description
days_of_week	No	Integer	The days of the week to which the time period applies. Valid value: sun: Sunday mon: Monday tue: Tuesday wed: Wednesday thu: Thursday fri: Friday sat: Saturday Note: For multiple values, use space to separate.
times	No	Array<String>	The time range of the time period.
months	No	String	The months to which the time period applies. Valid value: jan: January feb: February mar: March apr: April may: May jun: June jul: July aug: August sep: September oct: October nov: November dec: December Note: For multiple values, use space to separate.
days	No	String	The days of the month to which the time period applies. Valid value: 1 - 31 Note: For multiple values, use space to separate.
dest	No	String	The destination for inbound calls received during the time period. Valid value: end_call: Hang Up. extension: Extension. ext_vm: Extension Voicemail. group_vm: Group Voicemail. outroute: Outbound Route. ai_receptionist: AI Receptionist. ring_group: Ring Group. queue: Queue. conference: Conference. ivr: IVR. call_flow: Call Flow. external_num: External Number. play_greeting: Play Prompt and Exit.
dest_prefix	No	String	The destination prefix for inbound calls during the time period. Note: Configure this parameter only when time_condition is set to custom or route_scope and dest is set to external_num or play_greeting. If dest is set to external_num, this parameter defines the dial-out prefix of the external number. If dest is set to play_greeting, this parameter defines the play count of the prompt, and only integers from 1 to 5 is supported.
dest_value	No	String	The detailed destination for inbound calls received during the time period. If dest is play_greeting, this parameter defines the filename of custom prompt (e.g. demo.wav). You can query the filename of custom prompts using Get Menu Options ("menu":"custom_prompt"). If dest is extension, ext_vm, group_vm, ivr, call_flow, ring_group, conference, ai_receptionist, outroute, or queue, this parameter should be the unique ID of the destination. For example, the destination is the extension 2002, then this parameter should be set to the extension's ID 2. If dest is external_num, this parameter defines the external number.
time_condition_switch	No	Integer	Whether to enable advanced time settings for flexible scheduling based on a combination of week, month, and date. Valid value: 0: Disabled. 1: Enabled.

Response parameters

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": "demo",
    "trunk_list": [
        {
            "id": 14
        }
    ],
    "def_dest":"end_call",
    "enb_time_condition": 1,
    "time_condition": "route_scope",
    "timezone_id": 1,
    "business_hours_destination": "extension",
    "business_hours_destination_value": "1000-Leo Ball",
    "outside_business_hours_destination": "group_vm",
    "outside_business_hours_destination_value": "6100-6100",
    "holidays_hours_destination": "ivr",
    "holidays_hours_destination_value": "6200-测试",
    "time_condition_value": [
        {
        "days_of_week": "mon tue wed thu fri",
        "times": [
            "08:45-11:45",
            "13:15-18:00"
                 ],
        "months": "jan feb mar",
        "days": "1 2 3",
        "dest": "end_call",
        "dest_prefix": "",
        "dest_value": "",
        "time_condition_switch": 1
        },
                {
                    "days_of_week": "mon tue wed thu fri",
                    "times": [
                        "11:45-13:15"
                    ],
                    "months": "",
                    "days": "",
                    "dest": "",
                    "dest_prefix": "",
                    "dest_value": "",
                    "time_condition_switch": 0
                }
            ]
}

Response example

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