Time Zone API

Use the Time Zone API to list all available time zones and to get time zone information for a specified zone. Time zone information is stored in the registry of the Windows operating system.

Important

Microsoft periodically releases cumulative time zone updates. These updates include worldwide changes to time zone names, bias (the amount of time in minutes that a time zone is offset from Coordinated Universal Time (UTC)), and observance of daylight saving time. These patches update the information in the Windows registry. When these updates are available, apply them to all virtual machines in the deployment that are running a Microsoft Windows operating system.

Use this API with the Outbound Campaign API to set the default time zone for an Outbound Option campaign. An Outbound Option campaign uses the time zone when the location of the customer number being dialed is unknown.

This API is read-only.

URL

https://<server>/unifiedconfig/config/timezone

Operations

  • list: Retrieves a list of available time zones. The list is sorted by UTC offset from the International Date Line from west to east.

  • get: Returns information for a specific time zone using the URL https://<server>/unifiedconfig/config/timezone/<id>, where <id> is the URL-encoded version of the name parameter.

Response Parameters

  • name: The name of the time zone.

  • displayName: Specific bias and location information about the time zone, such as the offset from UTC and one or more places located within the time zone.

    Example: "(UTC+5:30) Chennai, Kolkata, Mumbai, New Delhi"

  • stdName: The time zone name during standard time.

    Example: Malay Peninsula Standard Time

  • dstName: The time zone name during daylight saving time.

    Example: Malay Peninsula Daylight Time

  • dstObserved: Indicates whether daylight saving time is observed for the time zone. True or false.

  • bias: The current bias for local time translation on the server (in minutes). That is, the number of minutes to add to the local time to yield UTC.

Example Get Response

Code Snippet
Copy
<timeZone>
   <refURL>       
     /unifiedconfig/config/timezone/Pacific%20Standard%20Time%20%28Mexico%29
   </refURL>
   <name>Pacific Standard Time (Mexico)</name> 
   <displayName>(UTC-08:00) Baja California</displayName>
   <stdName>Pacific Standard Time (Mexico)</stdName>
   <dstName>Pacific Daylight Time (Mexico)</dstName>
   <dstObserved>true</dstObserved>
   <bias>480</bias>
</timeZone>