Get started
  • English
  • 简体中文
Official Site
Get started
  • English
  • 简体中文
Official Site
  • Get started
  • Concepts
  • Guides
  • Device capabilities & events
    • Browse by device type
    • Device capabilities
      • Common methods
      • Detection and alarms
      • Image
      • PTZ
      • Light
      • Recording
      • Audio
      • Media
      • Network
      • Power
      • Privacy
      • Call
      • Storage
      • System
      • Algorithm
      • Maintenance
        • device.reboot.execute (Reboot device)
        • device.restore.execute (Factory reset)
        • device.time.sync (Platform time sync)
        • device.time.get (Read UTC clock)
        • device.timezone.set (Set time zone)
        • device.timezone.get (Read time zone)
        • device.timezonerule.get (Query daylight saving rules)
        • device.wifi.current (Current Wi-Fi)
        • device.wifi.scan (Scan Wi-Fi hotspots)
        • device.wifi.control (Connect or disconnect Wi-Fi)
        • device.upgrade.process (Upgrade progress)
        • device.upgrade.execute (Trigger upgrade)
        • device.name.set (Rename device)
        • device.cover.refresh (Refresh cover image)
        • device.password.verify (Verify password)
        • device.password.set (Change password)
      • Control
    • Events overview
    • Permission codes
    • Capability error codes
    • Alarm and capability messages
    • Capability FAQ
    • Legacy ability and push types
  • API reference
  • SDK and tools
  • Solutions
  • Platform and support
On this page
What it does
Request URL
Minimum permission
Request parameters
Request example
Response data fields
Response example
Error codes

device.time.get (Read UTC clock)

device.time.get: Read UTC clock

What it does

Read-only device UTC clock. Time zone uses device.timezone.*; do not read time zone through this API. Legacy getDeviceUtcTimeZone single query is split into this method and Read time zone; see Migration guide. This method does not appear in device.capability.list.

Returned utcTime is UTC, for example 2026-09-11T03:24:00Z. Do not confuse it with device local time in message queries or Unix seconds in request system.time.

Request URL

POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.time.get

Minimum permission

The administrator does not need an extra permission on a device they bound. A shared device needs the basic configuration permission. A bound sub-user does not. A sub-account needs Config.

Request parameters

NameTypeRequiredDefaultLegal valuesDescription
tokenStringyesAccess token for an administrator, sub-user, or sub-account
deviceIdStringyesDevice serial number
productIdStringnoOptional. If sent and it does not match the device model → DV2009

For common request fields and signing, see Signing conventions and Common request payload.

Request example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "system": {
 "ver": "1.0",
 "appId": "lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time": 1706511734,
 "nonce": "f5a1ae2d-c09c-4d39-a744-83a5c2c653c2"
 },
 "params": {
 "token": "<yourAccessToken>",
 "deviceId": "TESTIPC000012345"
 }
}

Response data fields

NameTypeDescription
utcTimeStringUTC time, e.g. 2026-09-11T03:24:00Z

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "utcTime": "2026-09-11T03:24:00Z"
 }
 }
}

Error codes

This API may return the codes below.

CodeMeaningNext step
SN1001Signature errorCheck sign per Development specification
TK1002Token invalid or expiredRefresh accessToken
OP1002Missing required parameterAdd required fields
OP1003Invalid parameterMatch this page’s parameter table
OP1009Permission deniedCheck token and device bind/share grants
OP1013Total call limit exceededReduce call rate
OP1014Daily per-interface limit exceededSee Interface call limits
DV1007Device offlineWait until the device is online

See Return codes · OP/SN/TK for the full catalog.

CodeMeaningNext step
DV2003Property not on deviceUse device.capability.list
DV2004Value out of rangeCheck properties values
DV2007channelId vs scope mismatchRequired for channel scope; omit for device scope
DV2008Mixed device and channel propertiesSplit the request
DV2009productId mismatchOmit or set actual model id

See Capability errors.

device.time.sync (Platform time sync)
device.timezone.set (Set time zone)