API List (for China Unicom Users Only)
Secure Application Access
| API | Description |
|---|---|
| Gets authenticated and obtains an accessToken. | |
| Obtains a new token before the token expires. | |
| Periodically refreshes the token. | |
| Stops periodically refreshing the token. |
Device Management
| API | Description |
|---|---|
| Registers a device with the platform. This API applies only to devices that use LWM2M over CoAP or devices integrated with the AgentLite SDK. | |
| Changes the unique ID of a device on the platform, for example, by replacing a device. | |
| Modifies device information on the platform. | |
| Deletes a device from the platform. | |
| Queries the activation status of a device to check whether the device has connected to the platform. | |
| Queries the configuration and the latest data reported in a device shadow. | |
| Modifies the configuration in a device shadow. |
Data Collection
| API | Description |
|---|---|
| Queries details of a device on the platform, including the manufacturer, model, version, status, and service properties. | |
| Queries details of multiple devices on the platform, including the manufacturer, model, version, status, and service properties, based on specified conditions. | |
| Queries historical data reported by a device to the platform. | |
| Queries historical configuration in a device shadow. | |
| Queries service capabilities of a device defined in the product model. |
Subscription Management
| API | Description |
|---|---|
| Subscribes to service data related to a device from the platform, such as device registration, data reporting, and device status change. | |
| Subscribes to management data related to a device from the platform, such as software and firmware upgrades. | |
| Queries a subscription on the platform. | |
| Queries multiple subscriptions on the platform based on specified conditions. | |
| Deletes a subscription from the platform. | |
| Deletes multiple subscriptions from the platform based on specified conditions. |
Command Delivery
| API | Description |
|---|---|
| Delivers a command to a device. This API applies only to devices that use LWM2M over CoAP. | |
| Queries the status and content of a command based on specified conditions. | |
| Changes the status of a command from PENDING to CANCELED. | |
| Cancels all undelivered commands for a device. | |
| Queries the details and execution status of a command revocation task. | |
| Delivers a command to a device. This API applies only to devices that use MQTT. |
Batch Processing
| API | Description |
|---|---|
| Creates a batch task for devices. This API can be used only to deliver commands to a batch of devices. | |
| Queries details of a batch task, including the status and subtasks. | |
| Queries details of each subtask in a batch task, such as the task execution status and content. |
Group Management
| API | Description |
|---|---|
| Creates a group on the platform. | |
| Deletes a group from the platform. | |
| Modifies information about a group, such as the group name and the maximum number of devices in the group. | |
| Queries a group list on the platform based on specified conditions. | |
| Queries details of a group. | |
| Queries devices in a group. | |
| Adds a device to a group. | |
| Deletes a device from a group. |
Device Upgrades
| API | Description |
|---|---|
| Queries a version package list on the platform. | |
| Queries details of a version package on the platform. | |
| Deletes a version package from the platform. | |
| Creates a software upgrade task for a device. Currently, only the software of NB-IoT devices can be upgraded. | |
| Creates a firmware upgrade task for a device. Currently, only the firmware of NB-IoT devices can be upgraded. | |
| Queries details of an upgrade task. | |
| Queries details of each subtask in an upgrade task. | |
| Queries an upgrade task list on the platform based on specified conditions. |
Last Article: SDK Usage Guide (for China Unicom Users Only)
Next Article: Secure Application Access
Did this article solve your problem?
Thank you for your score!Your feedback would help us improve the website.