编辑自定义时区

更新自定义时区的配置。

请求 URL

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

请求参数

参数 是否必填 类型 说明
id 是 Integer 时区的唯一 ID。
注: 可通过 查询时区列表 接口查询时区 ID。
name 否 String 时区名称。
timezone 否 String 时区信息,包含 UTC 偏移量和时区标识符。
注: 可通过 获取菜单选项 接口查询可选时区(menu 设置为 timezone)。
enable_dst 否 Integer 是否启用夏令时。

取值范围:

  • 0:禁用。
  • 1:启用。
assign_extension 否 Array<Assign_Ext> 使用该时区的对象列表。
Assign_Ext
参数 是否必填 类型 说明
type 是 String 关联对象的类型。

取值范围:

  • extension:分机。
  • ext_group:分机组。
  • organization:部门。
id 是 Integer 分机、分机组或部门的 ID。
注: 可通过以下接口查询对应对象的 ID:

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0:请求成功。
  • 非零值:请求失败。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS:请求成功。
  • FAILURE:请求失败。
reboot Integer 是否需要重启系统。
注: 自定义时区需重启系统后才能生效。创建成功时,此参数固定返回 1。
  • 0:无需重启。
  • 1:需要重启。

示例

请求示例

POST /openapi/v1.0/timezone/update?access_token=gwakjgu9ZBUfz36wql4ndsVKkryI0kdj HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
  "id": 3,
  "name": "Shanghai"
}

响应示例

HTTP/1.1 200 OK
{
  "errcode": 0,
  "errmsg": "SUCCESS",
  "submsg": "",
  "reboot": 0
}