添加呼入路由
添加并配置呼入路由。
请求 URL
POST {base_url}/{api_path}/inbound_route/create?access_token={access_token}
请求参数
参数 | 是否必填 | 类型 | 说明 |
---|---|---|---|
name | 是 | String | 呼入路由名称。 |
alert_info | 否 | String | 呼入路由特色响铃。 |
did_option | 否 | String | DID 号码匹配模式。 取值范围:
|
did_pattern_list | 否 | Array<DID_Pattern_List> | DID 号码匹配规则列表。 注: 此参数在
did_option 为 patterns
时必填。 |
did_pattern_to_ext | 否 | String | 匹配到分机的 DID 号码匹配规则。 注: 此参数在
did_option 为
pattern_to_ext 时必填。 |
did_to_ext_start | 否 | String | 匹配到分机范围的 DID 号码匹配规则起始号码。 注: 此参数在
did_option 为 range_to_ext
时必填。 |
did_to_ext_end | 否 | String | 匹配到分机范围的 DID 号码匹配规则结束号码。 注: 此参数在
did_option 为 range_to_ext
时必填。 |
did_pattern_to_ext_list | 否 | Array<DID_Pattern_Ext_List> | DID 号码和对应分机列表。 注: 此参数在
did_option 为
pattern_to_ext_list 时必填。 |
cid_option | 否 | String | 主叫号码匹配规则。 取值范围:
|
cid_pattern_list | 否 | Array<CID_Pattern_List> | 主叫号码匹配规则列表。 注: 此参数在
cid_option 为 patterns
时必填。 |
cid_to_phonebook | 否 | Array<Integer> | 来电匹配的企业联系人群组的唯一 ID。 注:
|
trunk_list | 是 | Array<Trunk_List> | 呼入路由中选择的中继列表。 |
def_dest | 是 | String | 呼入路由的默认目的地。
|
def_dest_prefix | 否 | String |
此参数的设置取决于
|
def_dest_value | 否 | String | 此参数的设置取决于 def_dest 的设置值。
|
def_dest_ext_list | 否 | Array<Ext_List> | 选择的分机或分机组列表。 注: 此参数在
def_dest 为
pattern_to_ext 时必填。 |
- DID_Pattern_List
-
表 2. 参数 是否必填 类型 说明 did_pattern 是 String DID 匹配规则。
- DID_Pattern_Ext_List
-
参数 是否必填 类型 说明 did_pattern 是 String DID 号码。 did_pattern_to_ext 是 String DID 号码对应分机的 ID。 注: 可使用 搜索特定分机 接口查询需要的分机 ID。
- CID_Pattern_List
-
表 3. 参数 是否必填 类型 说明 cid_pattern 是 String 主叫号码匹配规则。 - Trunk_List
-
表 4. 参数 是否必填 类型 说明 id 是 Integer 中继的唯一 ID。 注: 可使用 搜索特定中继 接口查询中继 ID。name 否 String 中继名称。 type 否 String 中继类型。 - Ext_List
-
表 5. 参数 是否必填 类型 说明 value 是 String 分机/分机组的唯一 ID。 name 否 String 分机/分机组名称。 number 否 String 分机号码。 type 否 String 所选项目的类型。 取值范围:
extension
:分机ext_group
:分机组
响应参数
参数 | 类型 | 说明 |
---|---|---|
errcode | Integer | 返回错误码。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息。
|
errmsg | String | 返回信息。
|
id | Integer | 呼入路由的唯一 ID。 |
示例
请求示例
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"}]
}
响应示例
HTTP/1.1 200 OK
{
"errcode": 0,
"errmsg": "SUCCESS",
"id": 15
}