添加呼出路由
添加并配置呼出路由。
请求 URL
POST {base_url}/{api_path}/outbound_route/create?access_token={access_token}
请求参数
参数 | 是否必填 | 类型 | 说明 |
---|---|---|---|
name | 是 | String | 呼出路由名称。 |
outbound_cid | 否 | String | 呼出路由去电显示号码。 |
dial_pattern_list | 否 | Array<Dial_Pattern_List> | 呼出号码匹配规则。 |
trunk_list | 否 | Array<Trunk_List> | 呼出路由中选择的中继。 |
ext_list | 否 | Array<Ext_List> | 呼出路由中选择的分机。 |
pin_protect | 是 | String | 呼出路由密码。 取值范围:
|
pin | 否 | String | 单个呼出路由密码。 注: 此参数在
pin_protect 设置为 single_pin
时必填。 |
pin_list | 否 | Integer | 所选 PIN 码列表的唯一 ID。 注:
|
- Dial_Pattern_List
-
表 2. 参数 是否必填 类型 说明 pattern 否 String 号码规则。 strip 否 Integer 删除的前缀位数。 prepend 否 String 增加的前缀号码。
- Trunk_List
-
表 3. 参数 是否必填 类型 说明 id 是 Integer 中继的唯一 ID。 name 否 String 中继名称。 type 否 String 中继类型。
- Ext_List
-
表 4. 参数 是否必填 类型 说明 id 是 Integer 分机/分机组/部门的唯一 ID。 注: 可使用 获取菜单选项 接口查询所需 ID。ext_number 否 String 分机号码。 ext_name 否 String 分机/分机组/部门的名称。 type 是 String 所选项目的类型。 取值范围:
extension
:分机ext_group
:分机组organization
:部门
响应参数
参数 | 类型 | 说明 |
---|---|---|
errcode | Integer | 返回错误码。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息。
|
errmsg | String | 返回信息。
|
id | Integer | 呼出路由的唯一 ID。 |
示例
请求示例
POST /openapi/v1.0/outbound_route/create?access_token=EKAuoD0jqEYnQoyOJBH0QmN7J9XRCTRq HTTP/1.1
Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
"name": "test8",
"trunk_list": [
{
"id": 30
},
{
"id": 15,
"name": "account_trunking",
"type": "account"
}
],
"ext_list": [
{
"id": 6,
"type": "organization"
},
{
"id": 67,
"type": "ext_group"
},
{
"id":39,
"type":"extension"
}
],
"dial_pattern_list": [
{
"pattern": "X.",
"strip": 0,
"prepend": ""
}
]
}
响应示例
HTTP 200 OK
{
"errcode": 0,
"errmsg": "SUCCESS",
"id": 15
}