API List (for China Unicom Users Only)

Secure Application Access

API

Description

Authentication

Gets authenticated and obtains an accessToken.

Refreshing a Token

Obtains a new token before the token expires.

Periodically Refreshing a Token

Periodically refreshes the token.

Stopping Periodically Refreshing a Token

Stops periodically refreshing the token.

Device Management

API

Description

Registering a Device (Verification Code Mode)

Registers a device with the platform. This API applies only to devices that use LWM2M over CoAP or devices integrated with the AgentLite SDK.

Refreshing a Device Secret

Changes the unique ID of a device on the platform, for example, by replacing a device.

Modifying Device Information

Modifies device information on the platform.

Deleting a Device

Deletes a device from the platform.

Querying Device Activation Status

Queries the activation status of a device to check whether the device has connected to the platform.

Querying Information in a Device Shadow

Queries the configuration and the latest data reported in a device shadow.

Modifying Information in a Device Shadow

Modifies the configuration in a device shadow.

Data Collection

API

Description

Querying Information About a Device

Queries details of a device on the platform, including the manufacturer, model, version, status, and service properties.

Querying a Device Information List

Queries details of multiple devices on the platform, including the manufacturer, model, version, status, and service properties, based on specified conditions.

Querying Historical Device Data

Queries historical data reported by a device to the platform.

Querying Historical Device Shadow Data

Queries historical configuration in a device shadow.

Querying Service Capabilities of a Device

Queries service capabilities of a device defined in the product model.

Subscription Management

API

Description

Subscribing to Service Data

Subscribes to service data related to a device from the platform, such as device registration, data reporting, and device status change.

Subscribing to Device Management Data

Subscribes to management data related to a device from the platform, such as software and firmware upgrades.

Querying a Subscription

Queries a subscription on the platform.

Querying Subscriptions in Batches

Queries multiple subscriptions on the platform based on specified conditions.

Deleting a Subscription

Deletes a subscription from the platform.

Deleting Subscriptions in Batches

Deletes multiple subscriptions from the platform based on specified conditions.

Command Delivery

API

Description

Creating a Device Command

Delivers a command to a device. This API applies only to devices that use LWM2M over CoAP.

Querying Device Commands

Queries the status and content of a command based on specified conditions.

Modifying a Device Command

Changes the status of a command from PENDING to CANCELED.

Creating a Device Command Revocation Task

Cancels all undelivered commands for a device.

Querying a Command Revocation Task

Queries the details and execution status of a command revocation task.

Calling a Device Service

Delivers a command to a device. This API applies only to devices that use MQTT.

Batch Processing

API

Description

Creating a Batch Task

Creates a batch task for devices. This API can be used only to deliver commands to a batch of devices.

Querying Details of a Batch Task

Queries details of a batch task, including the status and subtasks.

Querying Details of a Subtask of a Batch Task

Queries details of each subtask in a batch task, such as the task execution status and content.

Group Management

API

Description

Creating a Device Group

Creates a group on the platform.

Deleting a Device Group

Deletes a group from the platform.

Modifying a Device Group

Modifies information about a group, such as the group name and the maximum number of devices in the group.

Querying Device Groups

Queries a group list on the platform based on specified conditions.

Querying Details of a Device Group

Queries details of a group.

Querying Members in a Device Group

Queries devices in a group.

Adding Members to a Device Group

Adds a device to a group.

Deleting Members from a Device Group

Deletes a device from a group.

Device Upgrades

API

Description

Querying the Version Package List

Queries a version package list on the platform.

Querying a Version Package

Queries details of a version package on the platform.

Deleting a Version Package

Deletes a version package from the platform.

Creating a Software Upgrade Task

Creates a software upgrade task for a device. Currently, only the software of NB-IoT devices can be upgraded.

Creating a Firmware Upgrade Task

Creates a firmware upgrade task for a device. Currently, only the firmware of NB-IoT devices can be upgraded.

Querying the Result of an Upgrade Task

Queries details of an upgrade task.

Querying Details of Subtasks of an Upgrade Task

Queries details of each subtask in an upgrade task.

Querying the Upgrade Task List

Queries an upgrade task list on the platform based on specified conditions.