添加呼入路由

请求 URL

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

请求参数

DID_Pattern_List

参数	是否必填	类型	说明
did_pattern	是	String	DID 匹配规则。

DID_Pattern_Ext_List

参数	是否必填	类型	说明
did_pattern	是	String	DID 号码。
did_pattern_to_ext	是	String	DID 号码对应分机的 ID。 注： 可使用 搜索特定分机 接口查询需要的分机 ID。

CID_Pattern_List

参数	是否必填	类型	说明
cid_pattern	是	String	主叫号码匹配规则。

Trunk_List

参数	是否必填	类型	说明
id	是	Integer	中继的唯一 ID。 注： 可使用 搜索特定中继 接口查询中继 ID。
name	否	String	中继名称。
type	否	String	中继类型。

Ext_List

参数	是否必填	类型	说明
value	是	String	分机/分机组的唯一 ID。 注： 可使用 搜索特定分机 接口查询需要的分机 ID。 可使用 获取菜单选项 接口查询需要的分机组 ID。
name	否	String	分机/分机组名称。
number	否	String	分机号码。
type	否	String	所选项目的类型。 取值范围： extension：分机 ext_group：分机组

Custom_Time

参数	是否必填	类型	说明
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	时间段适用的日期。 取值范围：1 - 31 注： 多个值用空格分隔。
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 i设置为 custom 或 route_scope，且 dest 设置为 external_num 或 play_greeting 时，配置此参数。 如果 dest 为 external_num，此参数定义外部号码的呼出前缀。 如果 dest 为 play_greeting，此参数定义提示音的播放次数，支持 1 - 5 范围内的整数。
dest_value	否	String	时间段内收到的外线来电的详细目的地。 如果 dest 为 play_greeting，此参数定义自定义提示音的文件名 (如 demo.wav)。 可使用 获取菜单选项 接口查询自定义提示音的文件名 ("menu":"custom_prompt")。 如果 dest 为 extension、ext_vm、 group_vm、ivr、call_flow、 ring_group、conference、ai_receptionist、outroute 或 queue，此参数定义目的地的 ID。 例如，目的地是分机 2002，则此参数应设置为分机的 ID 2。 如果 dest 为 external_num，此参数定义外部号码。
time_condition_switch	否	Integer	是否启用高级时间设置，以支持按星期、月份和日期的组合方式配置时间条件。 取值范围： 0：禁用。 1：启用。

响应参数

示例

请求示例

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

响应示例

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