Last Updated on : 2024-06-14 20:03:16download
For authorization methods related to PID, you can retrieve/manipulate the data of the authorizer by invoking the following interface.
| API Name | URL |
|---|---|
| Get a Token | GET:/v1.0/token |
| Refresh Token | GET:/v1.0/token/{refreshToken} |
| API Name | URL |
|---|---|
| Send Voice Notification | POST:/v1.0/iot-03/messages/voices/actions/push |
| Add a voice template | POST:/v1.0/iot-03/msg-templates/voices |
| Get the list of voice templates | GET:/v1.0/iot-03/msg-templates/voices |
| Query the details of the voice template | GET:/v1.0/iot-03/msg-templates/voices/{template_id} |
| API Name | URL |
|---|---|
| Add SMS Template | POST:/v1.0/iot-03/msg-templates/sms |
| Query the details of the SMS template | GET:/v1.0/iot-03/msg-templates/sms/{template_id} |
| Get the list of SMS templates | GET:/v1.0/iot-03/msg-templates/sms |
| Send SMS messages | POST:/v1.0/iot-03/messages/sms/actions/push |
| API Name | URL |
|---|---|
| Send Email | POST:/v1.0/iot-03/messages/mails/actions/push |
| Add Email Template | POST:/v1.0/iot-03/msg-templates/mails |
| Query the details of the email template | GET:/v1.0/iot-03/msg-templates/mails/{template_id} |
| Get the list of email templates | GET:/v1.0/iot-03/msg-templates/mails |
| API Name | URL |
|---|---|
| Check whether a device is frozen | GET:/v1.0/iot-03/devices/{device_id}/freeze-state |
| Delete devices in batches | DELETE:/v1.0/iot-03/devices |
| Modify the device information | PUT:/v1.0/iot-03/devices/{device_id} |
| Delete a device | DELETE:/v1.0/iot-03/devices/{device_id} |
| Restore defaults | POST:/v1.0/iot-03/devices/{device_id}/actions/reset |
| Get the list of sub-devices | GET:/v1.0/iot-03/devices/{device_id}/sub-devices |
| Modify the frozen status of a device | PUT:/v1.0/iot-03/devices/{device_id}/freeze-state |
| Get Device Information | GET:/v1.1/iot-03/devices/{device_id} |
| Get Device Specification | GET:/v1.2/iot-03/devices/{device_id}/specification |
| Get Extended Properties in Bulk | GET:/v1.0/iot-03/devices/properties |
| Get Extended Properties | GET:/v1.0/iot-03/devices/{device_id}/properties |
| Query Protocols of Multiple Devices | GET:/v1.0/iot-03/devices/protocol |
| Get Device List | GET:/v1.3/iot-03/devices |
| API Name | URL |
|---|---|
| Query assets based on id | GET:/v1.0/iot-02/assets |
| Delete Asset | DELETE:/v1.0/iot-02/assets/{asset_id} |
| Modify Asset | PUT:/v1.0/iot-02/assets/{asset_id} |
| Query Node Devices in Pages | GET:/v1.0/iot-02/assets/{asset_id}/devices |
| Paging query of sub-nodes under the current node | GET:/v1.0/iot-02/assets/{asset_id}/sub-assets |
| Query assets based on id | GET:/v1.0/iot-02/assets/{asset_id} |
| Add new asset | POST:/v1.0/iot-02/assets |
| Authorize Assets | POST:/v1.0/iot-03/assets/actions/user-authorized |
| Query the Authorized Assets | GET:/v1.0/iot-03/users/{uid}/assets |
| Authorize User with Assets | POST:/v1.0/iot-03/users/{uid}/actions/batch-assets-authorized |
| Revoke a User's Asset Permissions | POST:/v1.0/iot-03/users/{uid}/actions/assets-unauthorized |
| Revoke Asset Permissions from a User | POST:/v1.0/iot-03/users/{uid}/actions/batch-assets-unauthorized |
| Query Cross-Level Sub-Assets | POST:/v1.1/iot-02/cross-level-sub-assets |
| Query Authorized User List | GET:/v1.0/iot-03/{asset_id}/authorized_users |
| Transfer Device | POST:/v1.0/iot-03/assets/devices/{device_id}/actions/transfer |
| Query and Sort Asset Sub-Node | GET:/v1.1/iot-02/assets/{asset_id}/sub-assets |
| API Name | URL |
|---|---|
| Query User Information by User ID | GET:/v1.0/iot-02/users/{user_id} |
| Register User | POST:/v1.0/iot-02/users |
| Delete User | DELETE:/v1.0/iot-02/users/{user_id} |
| Reset Password | PUT:/v1.0/iot-02/users/reset-password |
| Query User Information on Pages | GET:/v1.1/iot-02/users |
| Modify User Information | PUT:/v1.1/iot-02/users/{user_id} |
| Query User by Username | GET:/v1.2/iot-02/users/{user_name} |
| Query User Information on Pages | GET:/v1.1/iot-02/users/page |
| API Name | URL |
|---|---|
| Register a Bluetooth Device | POST:/v1.0/iot-03/device-registration/single-bluetooth/actions/register |
| Search for sub-devices | POST:/v1.0/iot-03/device-registration/devices/{device_id}/actions/discover |
Generate an authKey for Bluetooth Device Pairing | POST:/v1.0/iot-03/device-registration/single-bluetooth/auth-key |
| Activate a Bluetooth Device | POST:/v1.0/iot-03/device-registration/single-bluetooth/actions/active |
| Generate Pairing Token | POST:/v1.0/iot-03/device-registration/token |
| Stop Discovering Sub-devices | POST:/v1.0/iot-03/device-registration/devices/{device_id}/actions/stop-discover |
| Get the list of newly connected sub-devices | GET:/v1.0/iot-03/device-registration/devices/{device_id}/sub-devices |
| Query device activation result based on network distribution token | GET:/v1.1/iot-03/device-registration/tokens/{token} |
| Get Cloud System Time | GET:/v1.0/iot-03/cloud/system-time |
| Pair NB-IoT Device by Scanning QR Code | POST:/v1.0/iot-03/device-registration/qrcode-bind |
| Get the list of gateways under the asset | GET:/v1.0/iot-03/device-registration/assets/{asset_id}/gateways |
| Generate RSA Public Key for Bluetooth Pairing | POST:/v1.0/iot-03/device-registration/assets/{asset_id}/encryptions/rsa/public-key |
| Bind Device with Asset | POST:/v1.1/iot-02/device-bc-bind |
| API Name | URL |
|---|---|
| Delete Space | DELETE:/v2.0/cloud/space/{space_id} |
| Query Resources in Space | GET:/v2.0/cloud/space/{space_id}/resource |
| Create Space | POST:/v2.0/cloud/space/creation |
| Query Space | GET:/v2.0/cloud/space/{space_id} |
| Query Space List | GET:/v2.0/cloud/space/child |
| Modify Space Information | PUT:/v2.0/cloud/space/{space_id} |
| Query Parent-Child Relationship | GET:/v2.0/cloud/space/relation |
| API Name | URL |
|---|---|
| Add Home | POST:/v1.0/home/create-home |
| Query Home | GET:/v1.0/homes/{home_id} |
| Modify Home | PUT:/v1.0/homes/{home_id} |
| Delete Family | DELETE:/v1.0/homes/{home_id} |
| Query Devices in Home | GET:/v1.0/homes/{home_id}/devices |
| Query Home Members | GET:/v1.0/homes/{home_id}/members |
| Add Home Member | POST:/v1.0/homes/{home_id}/members |
| Modify family member information | PUT:/v1.0/homes/{home_id}/members/{uid} |
| Delete Home Member | DELETE:/v1.0/homes/{home_id}/members/{uid} |
| Add Room | POST:/v1.0/homes/{home_id}/room |
| Query Room List | GET:/v1.0/homes/{home_id}/rooms |
| Delete Room | DELETE:/v1.0/homes/{home_id}/rooms/{room_id} |
| Modify the room name | PUT:/v1.0/homes/{home_id}/rooms/{room_id} |
| Query family room equipment | GET:/v1.0/homes/{home_id}/rooms/{room_id}/devices |
| Query Home List | GET:/v1.0/users/{uid}/homes |
| Add a device in the room | POST:/v1.0/homes/{home_id}/rooms/{room_id}/devices |
| Modify Room Devices | PUT:/v1.0/homes/{home_id}/rooms/{room_id}/devices |
| Delete Devices from Room | DELETE:/v1.0/homes/{home_id}/rooms/{room_id}/devices |
| Get Device List | GET:/v1.0/devices |
| API Name | URL |
|---|---|
| Sync User Account | POST:/v1.0/apps/{schema}/user |
| Get User Information | GET:/v1.0/users/{uid}/infos |
| Get User List | GET:/v2.0/apps/{schema}/users |
| Undelete | POST:/v1.0/users/{uid}/actions/cancel-delete |
| Pre-delete the user account | POST:/v1.0/users/{uid}/actions/pre-delete |
| Get User's Device List | GET:/v1.0/users/{uid}/devices |
| API Name | URL |
|---|---|
| Get App Details | GET:/v1.0/apps/{schema} |
| Get App Information | GET:/v1.1/apps/{schema} |
| API Name | URL |
|---|---|
| Get a list of sub-devices | GET:/v1.0/devices/{deviceId}/list-sub |
| Allow sub-devices to access the network | PUT:/v1.0/devices/{deviceId}/enabled-sub-discovery |
| Get the list of network equipment | GET:/v1.0/device/paring/tokens/{token} |
| API Name | URL |
|---|---|
| Query Zigbee devices under the gateway | GET:/v1.0/devices/{deviceId}/sub-devices |
| Query Factory Information in Bulk | GET:/v1.0/devices/factory-infos |
| Modify device name | PUT:/v1.0/devices/{device_id} |
| Query device log | GET:/v1.0/devices/{device_id}/logs |
| Restore device factory settings | PUT:/v1.0/devices/{device_id}/reset-factory |
| Get Device Details | GET:/v1.0/devices/{deviceId} |
| Delete Device | DELETE:/v1.0/devices/{deviceId} |
| Get Device Status | GET:/v1.0/devices/{deviceId}/status |
| Get Device List v2 | GET:/v2.0/devices |
| Batch query for the list of associated App user dimension devices | GET:/v1.0/iot-01/associated-users/devices |
| Delete User | DELETE:/v1.0/devices/{device_id}/users/{user_id} |
| Modify Device Members | PUT:/v1.0/devices/{device_id}/users/{user_id} |
| Query Device Members | GET:/v1.0/devices/{device_id}/users/{user_id} |
| Add Device Member | POST:/v1.0/devices/{device_id}/user |
| Query Member List by Device ID | GET:/v1.0/devices/{device_id}/users |
| API Name | URL |
|---|---|
| Get Status Reporting Log | GET:/v2.0/cloud/thing/{device_id}/report-logs |
| Get Update Progress | GET:/v2.0/cloud/thing/{device_id}/firmware/{channel}/progress |
| Query Device Details in Bulk | GET:/v2.0/cloud/thing/batch |
| Delete Device | DELETE:/v2.0/cloud/thing/{device_id} |
| Get Update Information | GET:/v2.0/cloud/thing/{device_id}/firmware |
| Query Device Details | GET:/v2.0/cloud/thing/{device_id} |
| Confirm Start of Update | POST:/v2.0/cloud/thing/{device_id}/firmware/{channel} |
| Get Device State | GET:/v2.0/cloud/thing/{device_id}/state |
| Get Operation Log | GET:/v2.0/cloud/thing/{device_id}/logs |
| Modify Basic Properties | POST:/v2.0/cloud/thing/{device_id}/attribute |
| Freeze/Unfreeze Device | POST:/v2.0/cloud/thing/{device_id}/freeze |
| Transfer Device | POST:/v2.0/cloud/thing/{device_id}/transfer |
| Restore Factory Defaults | POST:/v2.0/cloud/thing/{device_id}/reset |
| Query Devices in Space | GET:/v2.0/cloud/thing/space/device |
| Query Devices in Project | GET:/v2.0/cloud/thing/device |
| Pair Device by Scanning QR Code | POST:/v2.0/cloud/thing/active/qrcode |
| Query Pairing Result | GET:/v2.0/cloud/thing/active/token/{token} |
| API Name | URL |
|---|---|
| Modify function point name | PUT:/v1.0/devices/{device_id}/functions/{function_code} |
| Control Device | POST:/v1.0/devices/{deviceId}/commands |
| Get Instruction Set Supported by Device | GET:/v1.0/devices/{deviceId}/functions |
| Get Device Specification Attribute | GET:/v1.0/devices/{deviceId}/specifications |
| Get the instructions set by category | GET:/v1.0/functions/{category} |
| Get Instruction Sets in Bulk | GET:/v1.0/devices/functions |
| Get Device Specification Attribute | GET:/v1.1/devices/{device_id}/specifications |
| API Name | URL |
|---|---|
| Send Actions | POST:/v2.0/cloud/thing/{device_id}/shadow/actions |
| Query Properties | GET:/v2.0/cloud/thing/{device_id}/shadow/properties |
| Modify Properties | POST:/v2.0/cloud/thing/{device_id}/shadow/properties |
| Query Desired Properties | GET:/v2.0/cloud/thing/{device_id}/shadow/properties/desired |
| Send Property | POST:/v2.0/cloud/thing/{device_id}/shadow/properties/issue |
| Set Desired Property | POST:/v2.0/cloud/thing/{device_id}/shadow/properties/desired |
| Query Things Data Model | GET:/v2.0/cloud/thing/{device_id}/model |
| API Name | URL |
|---|---|
| Query Group | GET:/v2.0/cloud/thing/group/{group_id} |
| Add Device | PUT:/v2.0/cloud/thing/group/{group_id}/devices |
| Delete Devices | DELETE:/v2.0/cloud/thing/group/{group_id}/devices |
| Get Device Group | GET:/v2.0/cloud/thing/group/device/{device_id} |
| Query Group Properties | GET:/v2.0/cloud/thing/group/{group_id}/properties |
| Delete Group | DELETE:/v2.0/cloud/thing/group/{group_id} |
| Create Group | POST:/v2.0/cloud/thing/group |
| Send Group Properties | POST:/v2.0/cloud/thing/group/properties |
| Query Group Devices | GET:/v2.0/cloud/thing/group/{group_id}/devices |
| Rename Group | PUT:/v2.0/cloud/thing/group/{group_id}/{name} |
| Get Groups in Space | GET:/v2.0/cloud/thing/group |
| API Name | URL |
|---|---|
| Confirm device upgrade | POST:/v1.0/iot-03/devices/{device_id}/confirm-upgrade |
| Obtain whether the firmware on the device is available for upgrade | GET:/v1.0/iot-03/devices/{device_id}/upgrade-infos |
| API Name | URL |
|---|---|
| Get Linkage Rule Details | GET:/v2.0/cloud/scene/rule/{rule_id} |
| Query Linkage Rules | GET:/v2.0/cloud/scene/rule |
| Delete Linkage Rule | DELETE:/v2.0/cloud/scene/rule |
| Trigger Tap-to-Run | POST:/v2.0/cloud/scene/rule/{rule_id}/actions/trigger |
| Modify Linkage Rule | PUT:/v2.0/cloud/scene/rule/{rule_id} |
| Enable/Disable Automation | PUT:/v2.0/cloud/scene/rule/state |
| Add Linkage Rule | POST:/v2.0/cloud/scene/rule |
| API Name | URL |
|---|---|
| Assign Passwords to Device Members | POST:/v1.0/devices/{device_id}/device-lock/users/{user_id}/allocate |
| Get Dynamic Password | GET:/v1.0/devices/{device_id}/door-lock/dynamic-password |
| Synchronize Password | POST:/v1.0/devices/{device_id}/door-lock/issue-password |
| Remote Unlocking with Password | POST:/v1.0/devices/{device_id}/door-lock/open-door |
| Get Unlocking Records | GET:/v1.0/devices/{device_id}/door-lock/open-logs |
| Create Temporary Password | POST:/v1.0/devices/{device_id}/door-lock/temp-password |
| Get Temporary Password | GET:/v1.0/devices/{device_id}/door-lock/temp-password/{password_id} |
| Get Temporary Passwords | GET:/v1.0/devices/{device_id}/door-lock/temp-passwords |
| Delete Temporary Password | DELETE:/v1.0/devices/{device_id}/door-lock/temp-passwords/{password_id} |
| Freeze Temporary Password | PUT:/v1.0/devices/{device_id}/door-lock/temp-passwords/{password_id}/freeze-password |
| Modify Temporary Password | PUT:/v1.0/devices/{device_id}/door-lock/temp-passwords/{password_id}/modify-password |
| Delete Temporary Password Record | DELETE:/v1.0/devices/{device_id}/door-lock/temp-passwords/{password_id}/record |
| Create Unnamed Temporary Password | POST:/v2.0/devices/{device_id}/door-lock/temp-password |
| Get Temporary Key | POST:/v1.0/devices/{device_id}/door-lock/password-ticket |
| Get Bound Unlocking Methods | GET:/v1.0/devices/{device_id}/door-lock/user-types/{user_type}/users/{user_id}/assigned-keys |
| Get Unbound Unlocking Methods | GET:/v1.0/devices/{device_id}/door-lock/unassigned-keys |
| Enroll in Unlocking Method | PUT:/v1.0/devices/{device_id}/door-lock/actions/entry |
| Delete Unlocking Methods | DELETE:/v1.0/devices/{device_id}/door-lock/user-types/{user_type}/users/{user_id}/unlock-types/{unlock_type}/keys/{unlock_no} |
| Cancel Enrolling in Unlocking Method | PUT:/v1.0/devices/{device_id}/door-lock/unlock-types/{unlock_type}/actions/cancel |
| Set Duress Alarm | PUT:/v1.0/devices/{device_id}/door-lock/unlock-types/{unlock_type}/keys/{unlock_no}/hijack |
| Get Alert Records | GET:/v1.0/devices/{device_id}/door-lock/alarm-logs |
| Set Advanced Password | POST:/v1.0/devices/{device_id}/door-lock/advanced-password |
| View Advanced Password | GET:/v1.0/devices/{device_id}/door-lock/advanced-password |
| Clear Temporary Passwords | POST:/v1.0/devices/{device_id}/door-lock/temp-passwords/rest-password |
| Get the latest remote door opening or alarm cover image | GET:/v1.0/devices/{device_id}/door-lock/latest/media/url |
| Generate Offline Temporary Password | POST:/v1.1/devices/{device_id}/door-lock/offline-temp-password |
| Synchronize Unlocking Methods | POST:/v1.0/smart-lock/devices/{device_id}/opmodes/actions/sync |
| Get Periodic Temporary Passwords of Keepalive Locks | GET:/v1.0/smart-lock/devices/{device_id}/stand-by-lock-temp-passwords |
| Cancel Duress Alert | DELETE:/v1.0/smart-lock/devices/{device_id}/unlock-types/{unlock_type}/keys/{unlock_sn}/hijack |
| Remote Locking and Unlocking Without Password | POST:/v1.0/smart-lock/devices/{device_id}/password-free/door-operate |
| Get Device Albums | GET:/v1.0/smart-lock/devices/{device_id}/albums-media |
| Get Temporary Key | POST:/v1.0/smart-lock/devices/{device_id}/password-ticket |
| Assign Unlocking Method | POST:/v1.0/devices/{device_id}/door-lock/opmodes/actions/allocate |
| Associate History with User | POST:/v1.0/devices/{device_id}/door-lock/records/{record_id}/actions/allocate |
| Update Unlocking Methods | PUT:/v1.0/devices/{device_id}/door-lock/opmodes/{unlock_sn} |
| Update Offline Password Name | PUT:/v1.0/devices/{device_id}/door-lock/offline-temp-password/{password_id} |
| Get Unlocking History/Alert History | GET:/v1.0/devices/{device_id}/door-lock/records |
| Query Video View | GET:/v1.0/smart-lock/devices/{device_id}/media-view-times |
| Add One Video View | POST:/v1.0/smart-lock/devices/{device_id}/media-view-times |
| Set Special Attributes of Unlocking Method | POST:/v1.0/smart-lock/devices/{device_id}/opmodes/{opmode_id}/attribute/{attribute}/opmode-attr |
| Get the temporary password list of the door lock | GET:/v1.0/devices/{device_id}/door-lock/template/temp-password |
| Create temporary password | POST:/v1.0/smart-lock/device/{device_id}/template/temp-password |
| Delete temporary password | DELETE:/v1.0/devices/{device_id}/door-lock/template/temp-password/{password_id} |
| Temporary Password Details Interface | GET:/v1.0/devices/{device_id}/door-lock/template/temp-password/{password_id} |
| API Name | URL |
|---|---|
| Add Device Member | POST:/v1.0/devices/{device_id}/user |
| Query Member List by Device ID | GET:/v1.0/devices/{device_id}/users |
| Modify Device Members | PUT:/v1.0/devices/{device_id}/users/{user_id} |
| Delete User | DELETE:/v1.0/devices/{device_id}/users/{user_id} |
| Query Device Members | GET:/v1.0/devices/{device_id}/users/{user_id} |
| Get User Information | GET:/v1.0/smart-lock/devices/{device_id}/users |
| Update User Validity | PUT:/v1.0/smart-lock/devices/{device_id}/users/{user_id}/schedule |
| Delete User | POST:/v1.0/smart-lock/devices/{device_id}/users/{user_ids}/actions/delete-users-issue |
| Get List of Unlocking Methods | GET:/v1.0/smart-lock/devices/{device_id}/opmodes/{user_id} |
| Unbind Assigned Unlocking Method | POST:/v1.0/smart-lock/devices/{device_id}/opmodes/actions/cancel-allocate |
| API Name | URL |
|---|---|
| Get the specifications and properties of the device | GET:/v1.0/iot-03/devices/{device_id}/specification |
| Get the instruction set of the device | GET:/v1.0/iot-03/devices/{device_id}/functions |
| Get the instruction set of the category | GET:/v1.0/iot-03/categories/{category}/functions |
| Send commands | POST:/v1.0/iot-03/devices/{device_id}/commands |
| Get Category List | GET:/v1.0/iot-03/device-categories |
| Get the status of a single device | GET:/v1.0/iot-03/devices/{device_id}/status |
| Get the latest status of multiple devices | GET:/v1.0/iot-03/devices/status |
| Get Status Set | GET:/v1.0/iot-03/categories/{category}/status |
| API Name | URL |
|---|---|
| Delete User | DELETE:/v1.0/access-control/{device_id}/persons/{person_id} |
| Add Person | POST:/v1.0/access-control/{device_id}/persons/{person_id} |
| Update Person | PUT:/v1.0/access-control/{device_id}/persons/{person_id} |
| API Name | URL |
|---|---|
| Add Face Data | POST:/v1.0/access-control/{device_id}/persons/{person_id}/faces/{face_id} |
| Delete Face | DELETE:/v1.0/access-control/{device_id}/persons/{person_id}/faces/{face_id} |
| Update Face Information | PUT:/v1.0/access-control/{device_id}/persons/{person_id}/faces/{face_id} |
| API Name | URL |
|---|---|
| Delete QR Code | DELETE:/v1.0/access-control/{device_id}/persons/{person_id}/qrcodes/{qr_code} |
| Add QR Code | POST:/v1.0/access-control/{device_id}/persons/{person_id}/qrcodes/{qr_code} |
| Update QR Code | PUT:/v1.0/access-control/{device_id}/persons/{person_id}/qrcodes/{qr_code} |
| API Name | URL |
|---|---|
| Freeze Card | PUT:/v1.0/access-control/{device_id}/persons/{person_id}/card/{card_no}/freeze |
| Delete Card | DELETE:/v1.0/access-control/{device_id}/persons/{person_id}/card/{card_no} |
| Unfreeze Card | PUT:/v1.0/access-control/{device_id}/persons/{person_id}/card/{card_no}/unfreeze |
| Add Card | POST:/v1.0/access-control/{device_id}/persons/{person_id}/card/{card_no} |
| Update Card | PUT:/v1.0/access-control/{device_id}/persons/{person_id}/card/{card_no} |
| API Name | URL |
|---|---|
| Delete Password | DELETE:/v1.0/access-control/{device_id}/persons/{person_id}/passpwd/{pass_pwd} |
| Update Password | PUT:/v1.0/access-control/{device_id}/persons/{person_id}/passpwd/{pass_pwd} |
| Add Password | POST:/v1.0/access-control/{device_id}/persons/{person_id}/passpwd/{pass_pwd} |
| API Name | URL |
|---|---|
| Send Unlocking Command | POST:/v1.0/access-control/{device_id}/persons/{person_id}/actions/open |
| API Name | URL |
|---|---|
| Get Device Details | GET:/v1.0/expand/devices/{device_id} |
| Get Device List | GET:/v1.0/expand/devices |
| API Name | URL |
|---|---|
| Query Command Record | GET:/v1.0/expand/cmds/{sn} |
| API Name | URL |
|---|---|
| Call Users | POST:/v1.0/access-control/{device_id}/persons/actions/call |
| API Name | URL |
|---|---|
| Delete Device Permissions | DELETE:/v1.0/expand/spaces/{device_id}/persons/{person_id} |
| Add Device Permission | POST:/v1.0/expand/spaces/{device_id}/persons/{person_id} |
| API Name | URL |
|---|---|
| Bulk Add Users | POST:/v1.0/access-control/{device_id}/persons |
| Bulk Add QR Codes | POST:/v1.0/access-control/{device_id}/persons/qrcodes |
| Bulk Delete Users | DELETE:/v1.0/access-control/{device_id}/persons |
| Bulk Delete Faces | DELETE:/v1.0/access-control/{device_id}/persons/faces |
| Bulk Add Faces | POST:/v1.0/access-control/{device_id}/persons/faces |
| Bulk Delete QR Codes | DELETE:/v1.0/access-control/{device_id}/persons/qrcodes |
| API Name | URL |
|---|---|
| Query Device Capability List | GET:/v1.0/iot-03/devices/{device_id}/capabilities-definition |
| API Name | URL |
|---|---|
| Get Device Function Pool | GET:/v1.0/expand/devices/{device_id}/function-pool |
| Modify Data Point | PUT:/v1.0/expand/devices/{device_id}/functions |
| Get Data Point List | GET:/v1.0/expand/devices/{device_id}/functions |
| API Name | URL |
|---|---|
| Write Data to Card | POST:/v1.0/devices/{device_id}/door-lock/card-issuers/cards/{card_id}/sectors |
| Modify Card Name | PUT:/v1.0/devices/{device_id}/door-lock/card-issuers/cards/{card_id}/sectors |
| Get a List of Locks with Offline Password Feature | GET:/v1.0/devices/{device_id}/offline-pwd-locks |
| Delete Data from Card | DELETE:/v1.0/devices/{device_id}/door-lock/card-issuers/cards/{card_id}/sectors |
| Read Card Data from the Cloud | GET:/v1.0/devices/{device_id}/door-lock/card-issuers/cards/{card_id}/sectors |
| Get History of Writing to Card | GET:/v1.0/devices/{device_id}/door-lock/card-issuers/cards |
| API Name | URL |
|---|---|
| Set Valve Openness | POST:/v1.0/water-meter/{device_id}/actions/valve-open-degree |
| API Name | URL |
|---|---|
| Query Remaining Battery Capacity | GET:/v1.0/iot-03/power-devices/{device_id}/balance-charge |
| Set Up Enabling Status of Prepayment Feature | POST:/v1.0/iot-03/power-devices/{device_id}/prepayment |
| Set Up Balance Alert Threshold | POST:/v1.0/iot-03/power-devices/{device_id}/balance-threshold |
| Query Enabling Status of Prepayment Feature | GET:/v1.0/iot-03/power-devices/{device_id}/prepayment |
| Query Balance Alert Threshold | GET:/v1.0/iot-03/power-devices/{device_id}/balance-threshold |
| Clear Remaining Battery Capacity | POST:/v1.0/iot-03/power-devices/{device_id}/clear-charge |
| Query Electricity Top-up History | GET:/v1.0/iot-03/power-devices/{device_id}/charge-records |
| Top Up Electrical Device | POST:/v1.0/iot-03/power-devices/{device_id}/charge |
| API Name | URL |
|---|---|
| Get Device Track Point | GET:/v2.0/iot-01/tracks/detail |
| Get Device Track Segment | GET:/v2.0/iot-01/tracks/segments |
| API Name | URL |
|---|---|
| Query Geofence Alert | GET:/v2.0/iot-01/fences/warn/list |
| API Name | URL |
|---|---|
| Query Time Trend of Energy Data | GET:/v1.0/iot-03/energy/{energy_type}/statistics |
| Energy Consumption Ranking | GET:/v1.0/iot-03/energy/{energy_type}/monitors-top |
| Query Energy-Consuming Devices in Space | GET:/v1.0/iot-03/energy/{energy_type}/space/devices |
| Query Energy Data Trend | GET:/v1.0/iot-03/energy/{energy_type}/monitors-trend |
| Query Energy Consumption Ranking in Space | GET:/v1.0/iot-03/energy/{energy_type}/space/statistics-top |
| Query Energy Consumption Trend in Space | GET:/v1.0/iot-03/energy/{energy_type}/space/statistics-trend |
| Query Energy Consumption Trend | GET:/v1.0/iot-03/energy/{energy_type}/devices/statistics-trend |
| Query Total Energy Consumption in Space | GET:/v1.0/iot-03/energy/{energy_type}/space/statistics-sum |
| Project Space Statistics | GET:/v1.0/iot-03/energy/{energy_type}/space-count |
| Query Energy Consumption Ranking in Space | GET:/v1.0/iot-03/energy/{energy_type}/space/statistics/devices-top |
| Remove Electrical Devices | POST:/v1.0/iot-03/energy/{energy_type}/space/{space_id}/devices-remove |
| Add Energy-Consuming Devices | POST:/v1.0/iot-03/energy/{energy_type}/space/{space_id}/devices |
| Query Total Energy Consumption of Node | GET:/v1.0/iot-03/energy/{energy_type}/space/nodes/statistics-sum |
| Summarize Energy Consumption Trend of Devices | GET:/v1.0/iot-03/energy/{energy_type}/devices/nodes/statistics-trend |
| Query Total Energy Consumption of Devices | GET:/v1.0/iot-03/energy/{energy_type}/device/nodes/statistics-sum |
| API Name | URL |
|---|---|
| Device Control | POST:/v1.0/iot-01/voice/users/devices/{device_id}/commands |
| Discover Devices | GET:/v1.0/iot-01/voice/users/devices |
| Discover Scenes | GET:/v1.0/iot-01/voice/users/scenes |
| Query Device Status | GET:/v1.0/iot-01/voice/users/devices/{device_id}/status |
| Control Scenes | POST:/v1.0/iot-01/voice/users/scenes/{scene_id}/commands |
| API Name | URL |
|---|---|
| Get Real-Time Data | GET:/v1.0/electric-energy/{device_id}/actions/realtime-data |
| API Name | URL |
|---|---|
| Query City List | GET:/v1.0/iot-03/cities |
| Get City Information by City ID | GET:/v1.0/iot-03/cities/{city_id} |
| Query City by Longitude and Latitude | GET:/v1.0/iot-03/cities/positions |
| API Name | URL |
|---|---|
| Enable/Disable Scheduled Task | PUT:/v2.0/cloud/timer/device/{device_id}/state |
| Query Scheduled Task | GET:/v2.0/cloud/timer/device/{device_id} |
| Add Scheduled Task | POST:/v2.0/cloud/timer/device/{device_id} |
| Modify Scheduled Task | PUT:/v2.0/cloud/timer/device/{device_id} |
| Bulk Delete Scheduled Tasks | DELETE:/v2.0/cloud/timer/device/{device_id}/batch |
| Clear Scheduled Tasks | DELETE:/v2.0/cloud/timer/device/{device_id} |
| API Name | URL |
|---|---|
| Execute Device Capability | POST:/v1.0/iot-03/devices/{device_id}/capabilities/{capability_code} |
| Query Device Capability | GET:/v1.0/iot-03/devices/{device_id}/capabilities/{capability_code} |
| Execute Device Capabilities in Bulk | POST:/v1.0/iot-03/devices/{device_id}/capabilities |
| Query Device Capability Status | GET:/v1.0/iot-03/devices/{device_id}/capabilities |
| API Name | URL |
|---|---|
| Check Failover Support | GET:/v1.0/alps/transfer/is/support |
| Trigger Gateway Failover | POST:/v1.0/alps/transfer/trigger |
| Get Failover Status | GET:/v1.0/alps/{gw_id}/transfer/status |
| API Name | URL |
|---|---|
| Query Alert Chart | GET:/v1.0/si/iot-03/alarm-statistics/chart |
| Query Alert Statistics | GET:/v1.0/si/iot-03/alarm-statistics |
| API Name | URL |
|---|---|
| Get Current Weather | GET:/v2.0/iot-03/weather/current |
| Get 7-day Weather Forecast | GET:/v2.0/iot-03/weather/forecast/daily |
| Get Weather History for the Past 24 Hours | GET:/v2.0/iot-03/weather/history24 |
| API Name | URL |
|---|---|
| Register Device | POST:/v1.0/iot-03/3rdcloud/devices/{third_cloud_device_id}/register |
| Report Device Property | POST:/v1.0/iot-03/3rdcloud/devices/{device_id}/property/report |
| Report Device Response | POST:/v1.0/iot-03/3rdcloud/devices/{device_id}/action-resp/report |
| Get Device Information | GET:/v1.0/iot-03/3rdcloud/devices/{third_cloud_device_id} |
| Update Device Information | PUT:/v1.0/iot-03/3rdcloud/devices/{device_id} |
| Device Goes Online | PUT:/v1.0/iot-03/3rdcloud/devices/{device_id}/online |
| Remove Device | DELETE:/v1.0/iot-03/3rdcloud/devices/{device_id}/remove |
| Go Offline | PUT:/v1.0/iot-03/3rdcloud/devices/{device_id}/offline |
| Report Device Event | POST:/v1.0/iot-03/3rdcloud/devices/{device_id}/event/report |
| Unbind Device | POST:/v1.0/cloud/thing/devices/{device_id}/unbind |
| Report Device DPs | POST:/v1.0/cloud/thing/devices/{device_id}/datapoint/report |
| Register Sub-device | POST:/v1.0/iot-03/3rdcloud/devices/{third_cloud_device_id}/sub/register |
| API Name | URL |
|---|---|
| Delete Custom Dimension Node | DELETE:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes/{node_id} |
| Remove Device from Custom Dimension Node | DELETE:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes/{node_id}/devices |
| Delete Monitor | DELETE:/v1.0/iot-03/statistical-indicators/monitors/{monitor_id} |
| Query Device of Custom Dimension Node | GET:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes/{node_id}/devices |
| Query Custom Dimension Node | GET:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes |
| Query Devices Bound with Monitor | GET:/v1.0/iot-03/statistical-indicators/monitors/{monitor_id}/devices |
| Query Monitor | GET:/v1.0/iot-03/statistical-indicators/monitors |
| Count Monitor | GET:/v1.0/iot-03/statistical-indicators/monitors/devices-count |
| Add Device to Custom Dimension Node | POST:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes/{node_id}/devices |
| Create Custom Dimension Node | POST:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes |
| Create Custom Dimension | POST:/v1.0/iot-03/statistical-dimensions/{dimension_code} |
| Modify Custom Dimension Node | PUT:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes/{node_id} |
| Remove Devices Bound with Monitor | POST:/v1.0/iot-03/statistical-indicators/monitors/{monitor_id}/devices-remove |
| Bind Devices with Monitor | POST:/v1.0/iot-03/statistical-indicators/monitors/{monitor_id}/devices |
| Add Monitor | POST:/v1.0/iot-03/statistical-indicators/monitors |
| Modify Monitor Name | PUT:/v1.0/iot-03/statistical-indicators/monitors/{monitor_id} |
| API Name | URL |
|---|---|
| Discover Scenes | GET:/v1.0/iot-01/voice/users/{uid}/scenes |
| Query Device Status | GET:/v1.0/iot-01/voice/users/{uid}/devices/{device_id}/status |
| Scene Control | POST:/v1.0/iot-01/voice/users/{uid}/scenes/{scene_id}/commands |
| Discover Devices | GET:/v1.0/iot-01/voice/users/{uid}/devices |
| Device Control | POST:/v1.0/iot-01/voice/users/{uid}/devices/{device_id}/commands |
| API Name | URL |
|---|---|
| Query Firmware Version by Firmware Key | GET:/v1.0/iot-03/product/firmware/versions |
| Bulk Query Firmware Details by Firmware Key | GET:/v1.0/iot-03/product/firmwares |
| Query Hardware Information by Product ID | GET:/v1.0/iot-03/product/hardwares |
| API Name | URL |
|---|---|
| Clear Device Data | POST:/v1.0/access-control/{device_id}/actions/cleardata |
| Sync Device Time | POST:/v1.0/access-control/{device_id}/actions/synctime |
| API Name | URL |
|---|---|
| Send TTS Command | POST:/v1.0/aispeech/voice/push |
| API Name | URL |
|---|---|
| Modify Cleaning Map Name | POST:/v1.0/users/sweepers/file/{device_id}/file-name |
| Get Link of Real-Time Map | GET:/v1.0/users/sweepers/file/{device_id}/realtime-map |
| Delete Cleaning Map | DELETE:/v1.0/users/sweepers/file/{device_id}/clean-history |
| Get Map File List | GET:/v1.0/users/sweepers/file/{device_id}/list |
| Get Download Link of Map | GET:/v1.0/users/sweepers/file/{device_id}/download |
| API Name | URL |
|---|---|
| Set Over-Voltage Protection Value | POST:/v1.0/electric-energy/{device_id}/actions/voltage-over |
| Set Power Limit | POST:/v1.0/electric-energy/{device_id}/actions/power-limit |
| Set Current Limit | POST:/v1.0/electric-energy/{device_id}/actions/current-limit |
| Set Leakage Alert Value | POST:/v1.0/electric-energy/{device_id}/actions/leak-warn-value |
| Set Leakage Action Value | POST:/v1.0/electric-energy/{device_id}/actions/leak-action-value |
| Set Electricity Consumption Alert Value | POST:/v1.0/electric-energy/{device_id}/actions/electric-warn |
| Set Under-Voltage Protection Value | POST:/v1.0/electric-energy/{device_id}/actions/voltage-under |
| Set Over-Temperature Protection Value | POST:/v1.0/electric-energy/{device_id}/actions/temp-over |
| API Name | URL |
|---|---|
| Query Electricity Safety Rule | GET:/v1.0/iot-03/power-devices/{device_id}/safety-rules |
| Set Up Electricity Safety Rule | POST:/v1.0/iot-03/power-devices/{device_id}/safety-rules |
| Query Electricity Safety Rules | GET:/v1.0/iot-03/power-devices/{device_id}/support-safety-rules |
| API Name | URL |
|---|---|
| Get Home List | GET:/v1.0/iot-01/voice/home/list |
| Smart Home Control | POST:/v1.0/iot-01/voice/homes/{home_id}/dm |
| API Name | URL |
|---|---|
| Reverse Geocoding | GET:/v1.0/iot-03/geocode-cities/latitude-longitude |
| Forward Geocoding | GET:/v1.0/iot-03/geocode-cities/address |
| Get Location by IP Address V1.1 | GET:/v1.1/iot-03/locations/ip |
| API Name | URL |
|---|---|
| Transfer Device | POST:/v1.0/iot-03/assets/devices/{device_id}/actions/transfer |
| API Name | URL |
|---|---|
| Query Real-time Locations of Multiple Devices | GET:/v2.0/iot-01/tracks/location |
| API Name | URL |
|---|---|
| Get a List of Country Codes | GET:/v3.0/iot-03/all-countries |
| API Name | URL |
|---|---|
| Add Devices in Geofence | POST:/v2.0/iot-01/fences/{fence_id}/entity |
| Create Polygonal Geofence | POST:/v2.0/iot-01/fences/polygon |
| Modify Polygonal Geofence | PUT:/v2.0/iot-01/fences/polygon/{fence_id} |
| Query Objects in Geofence | GET:/v2.0/iot-01/fences/{fence_id}/entity |
| Query All Geofences | GET:/v2.0/iot-01/fences/list |
| Create Circular Geofence | POST:/v2.0/iot-01/fences/circle |
| Enable or Disable Geofence | PUT:/v2.0/iot-01/fences/{fence_id}/open |
| Query Multiple Private Geofences | GET:/v2.0/iot-01/fences/private/batch |
| Save Circular Private Geofences | POST:/v2.0/iot-01/fences/circle/private/batch |
| Modify Circular Geofence | PUT:/v2.0/iot-01/fences/circle/{fence_id} |
| Query Geofence by Geofence ID | GET:/v2.0/iot-01/fences/batch |
| Save Polygonal Private Geofences | POST:/v2.0/iot-01/fences/polygon/private/batch |
| API Name | URL |
|---|---|
| Set Enabling Switch | POST:/v1.0/electric-energy/{device_id}/actions/hand-enable |
| Set Circuit Switch | POST:/v1.0/electric-energy/{device_id}/actions/switch |
| API Name | URL |
|---|---|
| Search for My Product List | GET:/v1.0/products/own/list |
| API Name | URL |
|---|---|
| Get Details of Device Group Tasks | GET:/v1.0/iot-03/device-groups/{group_id}/tasks |
| API Name | URL |
|---|---|
| Save Operation Log | POST:/v1.0/iot-03/audit/operate-logs |
| List of Log Operations | GET:/v1.0/iot-03/audit/operate-logs |
Is this page helpful?
YesFeedbackIs this page helpful?
YesFeedback