编辑呼出路由

编辑呼出路由的配置。

请求 URL

POST {base_url}/{api_path}/outbound_route/update?access_token={access_token}

请求参数

参数 是否必填 类型 说明
id 是 Integer 呼出路由的唯一 ID。
注： 可通过 搜索特定呼出路由 接口获取 ID。
name 否 String 呼出路由名称。
outbound_cid 否 String 呼出路由去电显示号码。
dial_pattern_list 否 Object<Dial_Pattern_List> 呼出号码匹配规则。
注： 新的匹配规则会覆盖原有的设置。
trunk_list 否 Object<Trunk_List> 呼出路由中选择的中继。
ext_list 否 Object<Ext_List> 呼出路由中选择的分机。
pin_protect 否 String 呼出路由密码。
取值范围：
  • disable：禁用
  • single_pin：单个密码
  • pin_list：PIN 码列表
pin 否 String 单个呼出路由密码。
注： 此参数在 pin_protect 设置为 single_pin 时必填。
pin_list 否 Integer 所选 PIN 码列表的唯一 ID。
注：
  • 此参数在 pin_protect 为 pin_list 时必填。
  • 可使用 获取菜单选项 接口查询 PIN 码列表 ID。

available_time

否

String

呼出路由的可用时间。

取值范围：

  • always：总是可用。
  • global：使用各时区配置的办公时间。
  • route_scope：使用自定义办公时间。
  • custom：使用自定义时间段。

enb_holiday

 否

Integer

是否允许在假期期间使用呼出路由。

取值范围：

  • 0：禁用
  • 1：启用

enb_office_time

否

Integer

是否允许在办公时间内使用呼出路由。

取值范围：

  • 0：禁用
  • 1：启用

enb_out_of_office_time

否

Integer

是否允许在非办公时间内使用呼出路由。

取值范围：

  • 0：禁用
  • 1：启用

office_time_list

否

 Array<Time_Setting>

自定义办公时间。

timezone_id

否

Integer
时区 ID。
注： 可通过 查询时区列表 接口获取 ID。
Dial_Pattern_List
参数 是否必填 类型 说明
pattern 否 String 号码规则。
strip 否 Integer 删除的前缀位数。
prepend 否 String 增加的前缀号码。
Trunk_List
参数 是否必填 类型 说明
id 是 Integer 中继的唯一 ID。
name 否 String 中继名称。
type 否 String 中继类型。
Ext_List
参数 是否必填 类型 说明
id 是 Integer 分机/分机组/部门的唯一 ID。
注： 可使用 获取菜单选项 接口查询所需 ID。
ext_number 否 String 分机号码。
ext_name 否 String 分机/分机组/部门的名称。
type 是 String 所选项目的类型。

取值范围：

  • extension：分机
  • ext_group：分机组
  • organization：部门
Time_Setting
参数 是否必填 类型 说明
months 否 String 办公时间适用的月份。
注：
  • 仅在启用高级时间条件 (time_condition_switch 为 1) 时生效。
  • 多个值使用空格分隔。

取值范围：

  • all：每月
  • jan：一月
  • feb：二月
  • mar：三月
  • apr：四月
  • may：五月
  • jun：六月
  • jul：七月
  • aug：八月
  • sep：九月
  • oct：十月
  • nov：十一月
  • dec：十二月
days_of_week 否 String 办公时间适用的星期。
注：
  • time_condition_switch 为 0 时必填。
  • 多个值使用空格分隔。

取值范围：

  • all：每天
  • sun：周日
  • mon：周一
  • tue：周二
  • wed：周三
  • thu：周四
  • fri：周五
  • sat：周六
days 否 String 办公时间的适用的日期。
注： 仅在启用高级时间条件 (time_condition_switch 为 1) 时生效。

取值范围：

  • all：每月的每一天。
  • 1 - 31：每月指定的日期。

office_times

否

 Array<Time_Periods> 时间段。
time_condition_switch 否 Integer 是否启用高级时间条件。

取值范围：

  • 0：禁用。
  • 1：启用。
    注： 启用后，months 和 days 参数生效。
Time_Periods
参数 类型 说明
value String 时间段，格式为 HH:MM-HH:MM。
注： 结束时间必须晚于开始时间。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。

示例

请求示例

POST /openapi/v1.0/outbound_route/update?access_token=EepE7JpKkhEWCjiOVqi9u3TJnYF1vLg1 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
    "id": 19,
    "pin_protect":"single_pin",
    "pin":"1234"
}

响应示例

HTTP 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS"
}