Query Information of a Time Zone

Query detailed information about a time zone.

Request URL

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

Request parameters

Parameter Required Type Description
id Yes Integer The unique ID of a time zone.
Note: You can query time zone ID using the Query Time Zone List interface.

Response parameters

Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
data Object<Time_Zone> The detailed information about the time zone.
Time_Zone
Parameter Type Description
id Integer Time zone ID.
name String Time zone name configured on PBX.
timezone String Time zone information, including the UTC offset and identifier.
timezone_name String Time zone display name.
enable_dst Integer Whether daylight saving time is enabled.
  • 0: Disabled.
  • 1: Enabled.
timezone_type String Time zone type.
  • global
  • custom
feature_code String The feature code used to switch or subscribe to the Business Hours and Holidays status associated with the time zone.
feature_code_seq Integer The sequence number of the feature code.

Example

Request example

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

Host: yeastardocs.example.yeastarcloud.com

Response example

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
  }
}