查询单个时区的信息

查询单个时区的详细信息。

请求 URL

GET {base_url}/{api_path}/timezone/get?access_token={access_token}

请求参数

参数 是否必填 类型 说明
id 是 Integer 时区的唯一 ID。
注： 可通过 查询时区列表 接口查询时区 ID。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
data Object<Time_Zone> 时区的详细信息。
Time_Zone
参数 类型 说明
id Integer 时区 ID。
name String PBX 中配置的时区名称。
timezone String 时区信息，包含 UTC 偏移量和时区标识符。
timezone_name String 时区显示名称。
enable_dst Integer 是否启用夏令时。
  • 0：禁用。
  • 1：启用。
timezone_type String 时区类型。
  • global
  • custom
feature_code String 用于切换或订阅该时区对应上下班状态的特征码。
feature_code_seq Integer 特征码序号。

示例

请求示例

GET /openapi/v1.0/timezone/get?id=3&access_token=gwakjgu9ZBUfz36wql4ndsVKkryI0kdj HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
  "errcode": 0,
  "errmsg": "SUCCESS",
  "submsg": "",
  "data": {
    "id": 3,
    "name": "Shanghai",
    "timezone": "UTC+8 Asia/Shanghai",
    "timezone_name": "8 China (Beijing)",
    "enable_dst": 0,
    "timezone_type": "custom",
    "feature_code": "*9999",
    "feature_code_seq": 99
  }
}