APP/WeChat Mini Program Permission Package

Last Updated on : 2024-10-17 10:00:29download

Applicable to authorization methods such as cloud project-related APP/WeChat mini program, which can retrieve/manipulate the authorized party's data by invoking the following interface

Authorization management

API NameURL
Get a TokenGET:/v1.0/token
Refresh TokenGET:/v1.0/token/{refreshToken}

Voice Message Service

API NameURL
Send Voice NotificationPOST:/v1.0/iot-03/messages/voices/actions/push
Add a voice templatePOST:/v1.0/iot-03/msg-templates/voices
Get the list of voice templatesGET:/v1.0/iot-03/msg-templates/voices
Query the details of the voice templateGET:/v1.0/iot-03/msg-templates/voices/{template_id}

Message Service

API NameURL
Add SMS TemplatePOST:/v1.0/iot-03/msg-templates/sms
Query the details of the SMS templateGET:/v1.0/iot-03/msg-templates/sms/{template_id}
Get the list of SMS templatesGET:/v1.0/iot-03/msg-templates/sms
Send SMS messagesPOST:/v1.0/iot-03/messages/sms/actions/push

App Push

API NameURL
Send Push Notifications to AppPOST:/v1.0/iot-03/messages/app-notifications/actions/push
Add a template of messages in notification centerPOST:/v1.0/iot-03/msg-templates/app-notifications
Query the template details of push notificationGET:/v1.0/iot-03/msg-templates/app-notifications/{template_id}
Get the list of templates for messages in the notification centerGET:/v1.0/iot-03/msg-templates/app-notifications

Email

API NameURL
Send EmailPOST:/v1.0/iot-03/messages/mails/actions/push
Add Email TemplatePOST:/v1.0/iot-03/msg-templates/mails
Query the details of the email templateGET:/v1.0/iot-03/msg-templates/mails/{template_id}
Get the list of email templatesGET:/v1.0/iot-03/msg-templates/mails

Industry Devices management

API NameURL
Check whether a device is frozenGET:/v1.0/iot-03/devices/{device_id}/freeze-state
Delete devices in batchesDELETE:/v1.0/iot-03/devices
Modify the device informationPUT:/v1.0/iot-03/devices/{device_id}
Delete a deviceDELETE:/v1.0/iot-03/devices/{device_id}
Restore defaultsPOST:/v1.0/iot-03/devices/{device_id}/actions/reset
Get the list of sub-devicesGET:/v1.0/iot-03/devices/{device_id}/sub-devices
Modify the frozen status of a devicePUT:/v1.0/iot-03/devices/{device_id}/freeze-state
Get Device InformationGET:/v1.1/iot-03/devices/{device_id}
Get Device SpecificationGET:/v1.2/iot-03/devices/{device_id}/specification
Get Extended Properties in BulkGET:/v1.0/iot-03/devices/properties
Get Extended PropertiesGET:/v1.0/iot-03/devices/{device_id}/properties
Query Protocols of Multiple DevicesGET:/v1.0/iot-03/devices/protocol
Get Device ListGET:/v1.3/iot-03/devices

Timing Management

API NameURL
Query Timer Tasks for a DeviceGET:/v1.0/devices/{devId}/timers
Delete All Timer Tasks of a DeviceDELETE:/v1.0/devices/{devId}/timers
Add Timer TaskPOST:/v1.0/devices/{devId}/timers
Delete Timer Task of a CategoryDELETE:/v1.0/devices/{devId}/timers/categories/{category}
Get Timer Tasks of a CategoryGET:/v1.0/devices/{devId}/timers/categories/{category}
Update Timer Task Group StatusPUT:/v1.0/devices/{devId}/timers/categories/{category}/groups/{group_id}/status
Delete Timer TaskDELETE:/v1.0/devices/{devId}/timers/categories/{category}/groups/{groupId}
Update Timer Task Group InformationPUT:/v1.0/devices/{devId}/timers/groups/{groupId}

Industry Asset Management

API NameURL
Query assets based on idGET:/v1.0/iot-02/assets
Delete AssetDELETE:/v1.0/iot-02/assets/{asset_id}
Modify AssetPUT:/v1.0/iot-02/assets/{asset_id}
Query Node Devices in PagesGET:/v1.0/iot-02/assets/{asset_id}/devices
Paging query of sub-nodes under the current nodeGET:/v1.0/iot-02/assets/{asset_id}/sub-assets
Query assets based on idGET:/v1.0/iot-02/assets/{asset_id}
Add new assetPOST:/v1.0/iot-02/assets
Authorize AssetsPOST:/v1.0/iot-03/assets/actions/user-authorized
Query the Authorized AssetsGET:/v1.0/iot-03/users/{uid}/assets
Authorize User with AssetsPOST:/v1.0/iot-03/users/{uid}/actions/batch-assets-authorized
Revoke a User's Asset PermissionsPOST:/v1.0/iot-03/users/{uid}/actions/assets-unauthorized
Revoke Asset Permissions from a UserPOST:/v1.0/iot-03/users/{uid}/actions/batch-assets-unauthorized
Query Cross-Level Sub-AssetsPOST:/v1.1/iot-02/cross-level-sub-assets
Query Authorized User ListGET:/v1.0/iot-03/{asset_id}/authorized_users
Transfer DevicePOST:/v1.0/iot-03/assets/devices/{device_id}/actions/transfer
Query and Sort Asset Sub-NodeGET:/v1.1/iot-02/assets/{asset_id}/sub-assets

Industry User Management

API NameURL
Query User Information by User IDGET:/v1.0/iot-02/users/{user_id}
Register UserPOST:/v1.0/iot-02/users
Delete UserDELETE:/v1.0/iot-02/users/{user_id}
Reset PasswordPUT:/v1.0/iot-02/users/reset-password
Query User Information on PagesGET:/v1.1/iot-02/users
Modify User InformationPUT:/v1.1/iot-02/users/{user_id}
Query User by UsernameGET:/v1.2/iot-02/users/{user_name}
Query User Information on PagesGET:/v1.1/iot-02/users/page

Industry Device Registration

API NameURL
Register a Bluetooth DevicePOST:/v1.0/iot-03/device-registration/single-bluetooth/actions/register
Search for sub-devicesPOST:/v1.0/iot-03/device-registration/devices/{device_id}/actions/discover
Generate an authKey for Bluetooth Device PairingPOST:/v1.0/iot-03/device-registration/single-bluetooth/auth-key
Activate a Bluetooth DevicePOST:/v1.0/iot-03/device-registration/single-bluetooth/actions/active
Generate Pairing TokenPOST:/v1.0/iot-03/device-registration/token
Stop Discovering Sub-devicesPOST:/v1.0/iot-03/device-registration/devices/{device_id}/actions/stop-discover
Get the list of newly connected sub-devicesGET:/v1.0/iot-03/device-registration/devices/{device_id}/sub-devices
Query device activation result based on network distribution tokenGET:/v1.1/iot-03/device-registration/tokens/{token}
Get Cloud System TimeGET:/v1.0/iot-03/cloud/system-time
Pair NB-IoT Device by Scanning QR CodePOST:/v1.0/iot-03/device-registration/qrcode-bind
Get the list of gateways under the assetGET:/v1.0/iot-03/device-registration/assets/{asset_id}/gateways
Generate RSA Public Key for Bluetooth PairingPOST:/v1.0/iot-03/device-registration/assets/{asset_id}/encryptions/rsa/public-key
Bind Device with AssetPOST:/v1.1/iot-02/device-bc-bind

Space Management

API NameURL
Delete SpaceDELETE:/v2.0/cloud/space/{space_id}
Query Resources in SpaceGET:/v2.0/cloud/space/{space_id}/resource
Create SpacePOST:/v2.0/cloud/space/creation
Query SpaceGET:/v2.0/cloud/space/{space_id}
Query Space ListGET:/v2.0/cloud/space/child
Modify Space InformationPUT:/v2.0/cloud/space/{space_id}
Query Parent-Child RelationshipGET:/v2.0/cloud/space/relation

Home Management

API NameURL
Add HomePOST:/v1.0/home/create-home
Query HomeGET:/v1.0/homes/{home_id}
Modify HomePUT:/v1.0/homes/{home_id}
Delete FamilyDELETE:/v1.0/homes/{home_id}
Query Devices in HomeGET:/v1.0/homes/{home_id}/devices
Query Home MembersGET:/v1.0/homes/{home_id}/members
Add Home MemberPOST:/v1.0/homes/{home_id}/members
Modify family member informationPUT:/v1.0/homes/{home_id}/members/{uid}
Delete Home MemberDELETE:/v1.0/homes/{home_id}/members/{uid}
Add RoomPOST:/v1.0/homes/{home_id}/room
Query Room ListGET:/v1.0/homes/{home_id}/rooms
Delete RoomDELETE:/v1.0/homes/{home_id}/rooms/{room_id}
Modify the room namePUT:/v1.0/homes/{home_id}/rooms/{room_id}
Query family room equipmentGET:/v1.0/homes/{home_id}/rooms/{room_id}/devices
Query Home ListGET:/v1.0/users/{uid}/homes
Add a device in the roomPOST:/v1.0/homes/{home_id}/rooms/{room_id}/devices
Modify Room DevicesPUT:/v1.0/homes/{home_id}/rooms/{room_id}/devices
Delete Devices from RoomDELETE:/v1.0/homes/{home_id}/rooms/{room_id}/devices
Get Device ListGET:/v1.0/devices

Smart Home User Management

API NameURL
Sync User AccountPOST:/v1.0/apps/{schema}/user
Get User InformationGET:/v1.0/users/{uid}/infos
Get User ListGET:/v2.0/apps/{schema}/users
UndeletePOST:/v1.0/users/{uid}/actions/cancel-delete
Pre-delete the user accountPOST:/v1.0/users/{uid}/actions/pre-delete
Get User's Device ListGET:/v1.0/users/{uid}/devices

Scene Management

API NameURL
Get the linkage conditions supported by the deviceGET:/v1.0/devices/{device_id}/enable-linkage/codes
Query Bound ScenesGET:/v1.0/devices/{device_id}/scenes
Unbind SceneDELETE:/v1.0/devices/{device_id}/scenes/{scene_id}
Bind ScenePOST:/v1.0/devices/{device_id}/scenes/{scene_id}
Query Devices Supporting SceneGET:/v1.0/homes/{home_id}/scene/devices
Query Scenes in HomeGET:/v1.0/homes/{home_id}/scenes
Add ScenesPOST:/v1.0/homes/{home_id}/scenes
Modify ScenePUT:/v1.0/homes/{home_id}/scenes/{scene_id}
Delete Home SceneDELETE:/v1.0/homes/{home_id}/scenes/{scene_id}
Trigger to execute the specified scenePOST:/v1.0/homes/{home_id}/scenes/{scene_id}/trigger
Query the list of default scene graphsGET:/v1.0/scenes/default-pictures
Enable scenePUT:/v1.0/homes/{home_id}/scenes/{scene_id}/actions/enable
Deactivate scenePUT:/v1.0/homes/{home_id}/scenes/{scene_id}/actions/disable
Enable AutomationPUT:/v1.0/homes/{home_id}/automations/{automation_id}/actions/enable
Disable automationPUT:/v1.0/homes/{home_id}/automations/{automation_id}/actions/disable
Query Scenes in HomeGET:/v1.1/homes/{home_id}/scenes

Smart Home Application Management

API NameURL
Get App DetailsGET:/v1.0/apps/{schema}
Get App InformationGET:/v1.1/apps/{schema}

Automation Management

API NameURL
Query Devices Supporting Automation SceneGET:/v1.0/homes/{home_id}/automation/devices
Add Automation ScenesPOST:/v1.0/homes/{home_id}/automations
Query Automation ListGET:/v1.0/homes/{home_id}/automations
Query Automation SceneGET:/v1.0/homes/{home_id}/automations/{automation_id}
Modify AutomationPUT:/v1.0/homes/{home_id}/automations/{automation_id}
Delete AutomationDELETE:/v1.0/homes/{home_id}/automations/{automation_id}
Trigger External ConditionsPOST:/v1.0/homes/{home_id}/automations/{automation_id}/conditions/trigger
Linkage conditions for obtaining family supportGET:/v1.0/homes/{home_id}/enable-linkage/codes
Query Weather ConditionsGET:/v1.0/homes/automation/weather/conditions
Get the linkage condition of family support, return to group actionGET:/v2.0/homes/{home_id}/enable-linkage/codes
Linked group action to get family supportGET:/v1.0/homes/{home_id}/linkage/device-group/functions

Smart Home Network Management

API NameURL
Get a list of sub-devicesGET:/v1.0/devices/{deviceId}/list-sub
Allow sub-devices to access the networkPUT:/v1.0/devices/{deviceId}/enabled-sub-discovery
Get the list of network equipmentGET:/v1.0/device/paring/tokens/{token}

Smart Home Device Management

API NameURL
Query Zigbee devices under the gatewayGET:/v1.0/devices/{deviceId}/sub-devices
Query Factory Information in BulkGET:/v1.0/devices/factory-infos
Modify device namePUT:/v1.0/devices/{device_id}
Query device logGET:/v1.0/devices/{device_id}/logs
Restore device factory settingsPUT:/v1.0/devices/{device_id}/reset-factory
Get Device DetailsGET:/v1.0/devices/{deviceId}
Delete DeviceDELETE:/v1.0/devices/{deviceId}
Get Device StatusGET:/v1.0/devices/{deviceId}/status
Get Device List v2GET:/v2.0/devices
Batch query for the list of associated App user dimension devicesGET:/v1.0/iot-01/associated-users/devices
Delete UserDELETE:/v1.0/devices/{device_id}/users/{user_id}
Modify Device MembersPUT:/v1.0/devices/{device_id}/users/{user_id}
Query Device MembersGET:/v1.0/devices/{device_id}/users/{user_id}
Add Device MemberPOST:/v1.0/devices/{device_id}/user
Query Member List by Device IDGET:/v1.0/devices/{device_id}/users

Device Management

API NameURL
Get Status Reporting LogGET:/v2.0/cloud/thing/{device_id}/report-logs
Get Update ProgressGET:/v2.0/cloud/thing/{device_id}/firmware/{channel}/progress
Query Device Details in BulkGET:/v2.0/cloud/thing/batch
Delete DeviceDELETE:/v2.0/cloud/thing/{device_id}
Get Update InformationGET:/v2.0/cloud/thing/{device_id}/firmware
Query Device DetailsGET:/v2.0/cloud/thing/{device_id}
Confirm Start of UpdatePOST:/v2.0/cloud/thing/{device_id}/firmware/{channel}
Get Device StateGET:/v2.0/cloud/thing/{device_id}/state
Get Operation LogGET:/v2.0/cloud/thing/{device_id}/logs
Modify Basic PropertiesPOST:/v2.0/cloud/thing/{device_id}/attribute
Freeze/Unfreeze DevicePOST:/v2.0/cloud/thing/{device_id}/freeze
Transfer DevicePOST:/v2.0/cloud/thing/{device_id}/transfer
Restore Factory DefaultsPOST:/v2.0/cloud/thing/{device_id}/reset
Query Devices in SpaceGET:/v2.0/cloud/thing/space/device
Query Devices in ProjectGET:/v2.0/cloud/thing/device
Pair Device by Scanning QR CodePOST:/v2.0/cloud/thing/active/qrcode
Query Pairing ResultGET:/v2.0/cloud/thing/active/token/{token}
Send Signal Detection InstructionPOST:/v2.0/cloud/thing/signal/detection/issue
Query Signal StrengthGET:/v2.0/cloud/thing/{device_id}/{device_type}/signal

Smart Home Device Control

API NameURL
Modify function point namePUT:/v1.0/devices/{device_id}/functions/{function_code}
Control DevicePOST:/v1.0/devices/{deviceId}/commands
Get Instruction Set Supported by DeviceGET:/v1.0/devices/{deviceId}/functions
Get Device Specification AttributeGET:/v1.0/devices/{deviceId}/specifications
Get the instructions set by categoryGET:/v1.0/functions/{category}
Get Instruction Sets in BulkGET:/v1.0/devices/functions
Get Device Specification AttributeGET:/v1.1/devices/{device_id}/specifications

Device Control

API NameURL
Send ActionsPOST:/v2.0/cloud/thing/{device_id}/shadow/actions
Query PropertiesGET:/v2.0/cloud/thing/{device_id}/shadow/properties
Modify PropertiesPOST:/v2.0/cloud/thing/{device_id}/shadow/properties
Query Desired PropertiesGET:/v2.0/cloud/thing/{device_id}/shadow/properties/desired
Send PropertyPOST:/v2.0/cloud/thing/{device_id}/shadow/properties/issue
Set Desired PropertyPOST:/v2.0/cloud/thing/{device_id}/shadow/properties/desired
Query Things Data ModelGET:/v2.0/cloud/thing/{device_id}/model

Basic Data

API NameURL
Get Overview of App Device DataGET:/v1.0/apps/{schema}/devices-survey
Get an Overview of Activated Device DataGET:/v1.0/devices/active-datas-survey
Get Data Overview of Active DevicesGET:/v1.0/devices/live-datas-survey
Get Product Data OverviewGET:/v1.0/statistics-datas-survey
Get Effective Interaction DataGET:/v1.0/iot-datacenter/app/device/effective/interaction/stat
Get Regional Distribution DetailsGET:/v1.1/devices/locations-active-datas
Get Total Activation Data TrendGET:/v1.0/iot-data/devices/activation-total
Get Daily Activated DevicesGET:/v1.0/cloud/analytics/devices/active-datas/date

Devices OTA

API NameURL
Confirm device upgradePOST:/v1.0/iot-03/devices/{device_id}/confirm-upgrade
Obtain whether the firmware on the device is available for upgradeGET:/v1.0/iot-03/devices/{device_id}/upgrade-infos

Scene Linkage Rules

API NameURL
Get Linkage Rule DetailsGET:/v2.0/cloud/scene/rule/{rule_id}
Query Linkage RulesGET:/v2.0/cloud/scene/rule
Delete Linkage RuleDELETE:/v2.0/cloud/scene/rule
Trigger Tap-to-RunPOST:/v2.0/cloud/scene/rule/{rule_id}/actions/trigger
Modify Linkage RulePUT:/v2.0/cloud/scene/rule/{rule_id}
Enable/Disable AutomationPUT:/v2.0/cloud/scene/rule/state
Add Linkage RulePOST:/v2.0/cloud/scene/rule

Smart Lock Setting

API NameURL
Assign Passwords to Device MembersPOST:/v1.0/devices/{device_id}/device-lock/users/{user_id}/allocate
Get Dynamic PasswordGET:/v1.0/devices/{device_id}/door-lock/dynamic-password
Synchronize PasswordPOST:/v1.0/devices/{device_id}/door-lock/issue-password
Remote Unlocking with PasswordPOST:/v1.0/devices/{device_id}/door-lock/open-door
Get Unlocking RecordsGET:/v1.0/devices/{device_id}/door-lock/open-logs
Create Temporary PasswordPOST:/v1.0/devices/{device_id}/door-lock/temp-password
Get Temporary PasswordGET:/v1.0/devices/{device_id}/door-lock/temp-password/{password_id}
Get Temporary PasswordsGET:/v1.0/devices/{device_id}/door-lock/temp-passwords
Delete Temporary PasswordDELETE:/v1.0/devices/{device_id}/door-lock/temp-passwords/{password_id}
Freeze Temporary PasswordPUT:/v1.0/devices/{device_id}/door-lock/temp-passwords/{password_id}/freeze-password
Modify Temporary PasswordPUT:/v1.0/devices/{device_id}/door-lock/temp-passwords/{password_id}/modify-password
Delete Temporary Password RecordDELETE:/v1.0/devices/{device_id}/door-lock/temp-passwords/{password_id}/record
Create Unnamed Temporary PasswordPOST:/v2.0/devices/{device_id}/door-lock/temp-password
Get Temporary KeyPOST:/v1.0/devices/{device_id}/door-lock/password-ticket
Get Bound Unlocking MethodsGET:/v1.0/devices/{device_id}/door-lock/user-types/{user_type}/users/{user_id}/assigned-keys
Get Unbound Unlocking MethodsGET:/v1.0/devices/{device_id}/door-lock/unassigned-keys
Enroll in Unlocking MethodPUT:/v1.0/devices/{device_id}/door-lock/actions/entry
Delete Unlocking MethodsDELETE:/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 MethodPUT:/v1.0/devices/{device_id}/door-lock/unlock-types/{unlock_type}/actions/cancel
Set Duress AlarmPUT:/v1.0/devices/{device_id}/door-lock/unlock-types/{unlock_type}/keys/{unlock_no}/hijack
Get Alert RecordsGET:/v1.0/devices/{device_id}/door-lock/alarm-logs
Set Advanced PasswordPOST:/v1.0/devices/{device_id}/door-lock/advanced-password
View Advanced PasswordGET:/v1.0/devices/{device_id}/door-lock/advanced-password
Clear Temporary PasswordsPOST:/v1.0/devices/{device_id}/door-lock/temp-passwords/rest-password
Get Temporary KeyPOST:/v1.0/smart-lock/devices/{device_id}/password-ticket

Device User Mangement

API NameURL
Add Device MemberPOST:/v1.0/devices/{device_id}/user
Query Member List by Device IDGET:/v1.0/devices/{device_id}/users
Modify Device MembersPUT:/v1.0/devices/{device_id}/users/{user_id}
Delete UserDELETE:/v1.0/devices/{device_id}/users/{user_id}
Query Device MembersGET:/v1.0/devices/{device_id}/users/{user_id}

Device Control(Standard Instruction Set)

API NameURL
Get the specifications and properties of the deviceGET:/v1.0/iot-03/devices/{device_id}/specification
Get the instruction set of the deviceGET:/v1.0/iot-03/devices/{device_id}/functions
Get the instruction set of the categoryGET:/v1.0/iot-03/categories/{category}/functions
Send commandsPOST:/v1.0/iot-03/devices/{device_id}/commands
Get Category ListGET:/v1.0/iot-03/device-categories
Get the status of a single deviceGET:/v1.0/iot-03/devices/{device_id}/status
Get the latest status of multiple devicesGET:/v1.0/iot-03/devices/status
Get Status SetGET:/v1.0/iot-03/categories/{category}/status

Public Area Device Information

API NameURL
Get Device DetailsGET:/v1.0/expand/devices/{device_id}
Get Device ListGET:/v1.0/expand/devices

Public Area Device Command

API NameURL
Query Command RecordGET:/v1.0/expand/cmds/{sn}

Public Area Device Permission

API NameURL
Delete Device PermissionsDELETE:/v1.0/expand/spaces/{device_id}/persons/{person_id}
Add Device PermissionPOST:/v1.0/expand/spaces/{device_id}/persons/{person_id}

Equipment monitoring

API NameURL
Query Monitoring InformationGET:/v1.1/iot-03/si/devices/core-monitoring

Device Capability Management

API NameURL
Query Device Capability ListGET:/v1.0/iot-03/devices/{device_id}/capabilities-definition

Public Area Device Function Point

API NameURL
Get Device Function PoolGET:/v1.0/expand/devices/{device_id}/function-pool
Modify Data PointPUT:/v1.0/expand/devices/{device_id}/functions
Get Data Point ListGET:/v1.0/expand/devices/{device_id}/functions

Equipment distribution

API NameURL
Get Number of DevicesGET:/v1.1/iot-03/si/devices/distribution/count
Query Industrial Device DistributionGET:/v1.1/iot-03/si/devices/distribution

Infrared Air Conditioner APIs

API NameURL
Control Air Conditioner with Multiple KeysPOST:/v2.0/infrareds/{infrared_id}/air-conditioners/{remote_id}/scenes/command
Send Single CommandPOST:/v2.0/infrareds/{infrared_id}/air-conditioners/testing/command
Send Key CombinationPOST:/v2.0/infrareds/{infrared_id}/air-conditioners/testing/scenes/command
Get Air Conditioner StatusGET:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/ac/status
Control Air Conditioner with Single CommandPOST:/v2.0/infrareds/{infrared_id}/air-conditioners/{remote_id}/command

Infrared Timer APIs

API NameURL
Add Infrared Scheduled TaskPOST:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/timers
Update Scheduled TaskPUT:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/timers
Update Scheduled Task StatusPUT:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/timers/status
Get Infrared Scheduled TaskGET:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/timers
Delete Scheduled TaskDELETE:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/timers

Power Management

API NameURL
Query Remaining Battery CapacityGET:/v1.0/iot-03/power-devices/{device_id}/balance-charge
Set Up Enabling Status of Prepayment FeaturePOST:/v1.0/iot-03/power-devices/{device_id}/prepayment
Set Up Balance Alert ThresholdPOST:/v1.0/iot-03/power-devices/{device_id}/balance-threshold
Query Enabling Status of Prepayment FeatureGET:/v1.0/iot-03/power-devices/{device_id}/prepayment
Query Balance Alert ThresholdGET:/v1.0/iot-03/power-devices/{device_id}/balance-threshold
Clear Remaining Battery CapacityPOST:/v1.0/iot-03/power-devices/{device_id}/clear-charge
Query Electricity Top-up HistoryGET:/v1.0/iot-03/power-devices/{device_id}/charge-records
Top Up Electrical DevicePOST:/v1.0/iot-03/power-devices/{device_id}/charge

Historical Track

API NameURL
Get Device Track PointGET:/v2.0/iot-01/tracks/detail
Get Device Track SegmentGET:/v2.0/iot-01/tracks/segments

Alert Management

API NameURL
Query Geofence AlertGET:/v2.0/iot-01/fences/warn/list

Text Recognition

API NameURL
Optical Character Recognition (OCR)POST:/v1.0/iot-03/ai-vision/text/actions/discern

Bind Device with Permission Rule

API NameURL
Unbind Access Control DevicesPOST:/v1.0/iot-02/access-controls/{access_control_id}/actions/device-unbind
Bind Access Control DevicePOST:/v1.0/iot-02/access-controls/{access_control_id}/actions/device-bind
Query Linked DeviceGET:/v1.0/iot-02/access-controls/{access_control_id}/devices

Category Management

API NameURL
Get Info about Multiple CategoriesGET:/v1.0/iot-03/app-contents/categories/batch
Release CategoryPOST:/v1.0/iot-03/app-contents/categories/{category_id}/actions/publish
Remove CategoryPOST:/v1.0/iot-03/app-contents/categories/{category_id}/actions/unshelve
Delete CategoryDELETE:/v1.0/iot-03/app-contents/categories/{category_id}
Edit CategoryPUT:/v1.0/iot-03/app-contents/categories/{category_id}
Category StatisticsGET:/v1.0/iot-03/app-contents/categories/statistic
Create CategoryPOST:/v1.0/iot-03/app-contents/categories
Query Category InformationGET:/v1.0/iot-03/app-contents/categories

Electricity Consumption Statistics

API NameURL
Query Time Trend of Energy DataGET:/v1.0/iot-03/energy/{energy_type}/statistics
Energy Consumption RankingGET:/v1.0/iot-03/energy/{energy_type}/monitors-top
Query Energy-Consuming Devices in SpaceGET:/v1.0/iot-03/energy/{energy_type}/space/devices
Query Energy Data TrendGET:/v1.0/iot-03/energy/{energy_type}/monitors-trend
Query Energy Consumption Ranking in SpaceGET:/v1.0/iot-03/energy/{energy_type}/space/statistics-top
Query Energy Consumption Trend in SpaceGET:/v1.0/iot-03/energy/{energy_type}/space/statistics-trend
Query Energy Consumption TrendGET:/v1.0/iot-03/energy/{energy_type}/devices/statistics-trend
Query Total Energy Consumption in SpaceGET:/v1.0/iot-03/energy/{energy_type}/space/statistics-sum
Project Space StatisticsGET:/v1.0/iot-03/energy/{energy_type}/space-count
Query Energy Consumption Ranking in SpaceGET:/v1.0/iot-03/energy/{energy_type}/space/statistics/devices-top
Remove Electrical DevicesPOST:/v1.0/iot-03/energy/{energy_type}/space/{space_id}/devices-remove
Add Energy-Consuming DevicesPOST:/v1.0/iot-03/energy/{energy_type}/space/{space_id}/devices
Query Total Energy Consumption of NodeGET:/v1.0/iot-03/energy/{energy_type}/space/nodes/statistics-sum
Summarize Energy Consumption Trend of DevicesGET:/v1.0/iot-03/energy/{energy_type}/devices/nodes/statistics-trend
Query Total Energy Consumption of DevicesGET:/v1.0/iot-03/energy/{energy_type}/device/nodes/statistics-sum

Electric energy data management

API NameURL
Get Real-Time DataGET:/v1.0/electric-energy/{device_id}/actions/realtime-data

User Profile

API NameURL
Verify User SegmentGET:/v1.0/user-profile/group/user/check
Get User Label DetailsGET:/v1.0/user-profile/user/tags
User InformationGET:/v1.0/user-profile/group/users

City Infos

API NameURL
Query City ListGET:/v1.0/iot-03/cities
Get City Information by City IDGET:/v1.0/iot-03/cities/{city_id}
Query City by Longitude and LatitudeGET:/v1.0/iot-03/cities/positions

Device Timer

API NameURL
Enable/Disable Scheduled TaskPUT:/v2.0/cloud/timer/device/{device_id}/state
Query Scheduled TaskGET:/v2.0/cloud/timer/device/{device_id}
Add Scheduled TaskPOST:/v2.0/cloud/timer/device/{device_id}
Modify Scheduled TaskPUT:/v2.0/cloud/timer/device/{device_id}
Bulk Delete Scheduled TasksDELETE:/v2.0/cloud/timer/device/{device_id}/batch
Clear Scheduled TasksDELETE:/v2.0/cloud/timer/device/{device_id}

File Management

API NameURL
Get File Upload URLGET:/v1.0/iot-03/app-contents/upload-file/infos
Get File Upload ResultsGET:/v1.0/iot-03/app-contents/upload-file/{upload_token}/infos
Get Status of Large File Upload ResultsGET:/v1.0/iot-03/app-contents/big-files/status
File downloadPOST:/v1.0/iot-03/app-contents/files/actions/download

Infrared x-box APIs

API NameURL
Switch Channel TablePUT:/v2.0/infrareds/{infrared_id}/remote/{remote_id}/channels
Switch ChannelsPOST:/v2.0/infrareds/{infrared_id}/channel/switch
Delete Custom Channel TableDELETE:/v2.0/infrareds/{infrared_id}/remote/custom/{submit_id}
Update Custom Channel TablePUT:/v2.0/infrareds/{infrared_id}/remote/{remote_id}/custom/{submit_id}
Get Carriers by Region IDGET:/v2.0/infrareds/{infrared_id}/areas/{area_id}/operators
Get Channel ListGET:/v2.0/infrareds/{infrared_id}/remote/channels
Get Channel ListGET:/v2.0/infrareds/{infrared_id}/remote/{remote_id}/channels
Get All Channel NamesGET:/v2.0/infrareds/{infrared_id}/remote/all-channels
Get Region ListGET:/v2.0/infrareds/{infrared_id}/provinces/{province_id}/cities/{city_id}/areas
Get Province ListGET:/v2.0/infrareds/{infrared_id}/provinces
Get Channels Bound with Set-Top BoxGET:/v2.0/infrareds/{infrared_id}/remote/{remote_id}/selected-channels
Get City ListGET:/v2.0/infrareds/{infrared_id}/provinces/{province_id}/cities

Device Capability Access

API NameURL
Execute Device CapabilityPOST:/v1.0/iot-03/devices/{device_id}/capabilities/{capability_code}
Query Device CapabilityGET:/v1.0/iot-03/devices/{device_id}/capabilities/{capability_code}
Execute Device Capabilities in BulkPOST:/v1.0/iot-03/devices/{device_id}/capabilities
Query Device Capability StatusGET:/v1.0/iot-03/devices/{device_id}/capabilities

Permission Management

API NameURL
Query Permission Data of ProjectGET:/v2.0/cloud/iam/permission/list
Unlink User from PermissionDELETE:/v2.0/cloud/iam/permission/{permission_id}/user/{user_id}
Query Permission DataGET:/v2.0/cloud/iam/permission/user/{user_id}
Query User ListGET:/v2.0/cloud/iam/user/permission/{permission_id}
Create PermissionPOST:/v2.0/cloud/iam/permission
Query Permission Data of ProjectGET:/v2.0/cloud/iam/permission/query
Query PermissionGET:/v2.0/cloud/iam/permission/{permission_id}
Delete PermissionDELETE:/v2.0/cloud/iam/permission/{permission_id}
Modify PermissionPUT:/v2.0/cloud/iam/permission/{permission_id}
Link Sub-PermissionsPOST:/v2.0/cloud/iam/permission/{permission_id}/item
Link User with PermissionPOST:/v2.0/cloud/iam/permission/{permission_id}/user/{user_id}
Query Sub-PermissionsGET:/v2.0/cloud/iam/permission/{permission_id}/item
Unlink Sub-PermissionDELETE:/v2.0/cloud/iam/permission/{permission_id}/item/{item_id}

Feedback Management

API NameURL
Get Message HistoryGET:/v1.0/iot-01/ticket/feedbacks/{feedback_id}/communications
Get Service TicketsGET:/v1.0/iot-01/ticket/feedbacks
Get Service Ticket TypeGET:/v1.0/iot-01/ticket/feedbacks/feedback-type
Finish Service TicketPUT:/v1.0/iot-01/ticket/feedbacks/{feedback_id}/operation-finish
Query Service Ticket StatusGET:/v1.0/iot-01/ticket/feedbacks/feedback-state
Reply to Service TicketPOST:/v1.0/iot-01/ticket/feedbacks/{feedback_id}/operation-reply
Get Service Ticket DetailsGET:/v1.0/iot-01/ticket/feedbacks/{feedback_id}
Get Total Unfinished Service TicketsGET:/v1.0/iot-01/ticket/feedbacks/feedback-statistics
Get User ReviewsGET:/v1.0/iot-01/ticket/feedbacks/{feedback_id}/evaluate

App Management

API NameURL
Get App InformationGET:/v1.0/app-contents/apps

Alarm statistics

API NameURL
Query Alert ChartGET:/v1.0/si/iot-03/alarm-statistics/chart
Query Alert StatisticsGET:/v1.0/si/iot-03/alarm-statistics

Weather

API NameURL
Get Current WeatherGET:/v2.0/iot-03/weather/current
Get 7-day Weather ForecastGET:/v2.0/iot-03/weather/forecast/daily
Get Weather History for the Past 24 HoursGET:/v2.0/iot-03/weather/history24

Device Cloud to Cloud Integration

API NameURL
Report Device PropertyPOST:/v1.0/iot-03/3rdcloud/devices/{device_id}/property/report
Report Device ResponsePOST:/v1.0/iot-03/3rdcloud/devices/{device_id}/action-resp/report
Report Device EventPOST:/v1.0/iot-03/3rdcloud/devices/{device_id}/event/report

Custom Statistics

API NameURL
Delete Custom Dimension NodeDELETE:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes/{node_id}
Remove Device from Custom Dimension NodeDELETE:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes/{node_id}/devices
Delete MonitorDELETE:/v1.0/iot-03/statistical-indicators/monitors/{monitor_id}
Query Device of Custom Dimension NodeGET:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes/{node_id}/devices
Query Custom Dimension NodeGET:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes
Query Devices Bound with MonitorGET:/v1.0/iot-03/statistical-indicators/monitors/{monitor_id}/devices
Query MonitorGET:/v1.0/iot-03/statistical-indicators/monitors
Count MonitorGET:/v1.0/iot-03/statistical-indicators/monitors/devices-count
Add Device to Custom Dimension NodePOST:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes/{node_id}/devices
Create Custom Dimension NodePOST:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes
Create Custom DimensionPOST:/v1.0/iot-03/statistical-dimensions/{dimension_code}
Modify Custom Dimension NodePUT:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes/{node_id}
Remove Devices Bound with MonitorPOST:/v1.0/iot-03/statistical-indicators/monitors/{monitor_id}/devices-remove
Bind Devices with MonitorPOST:/v1.0/iot-03/statistical-indicators/monitors/{monitor_id}/devices
Add MonitorPOST:/v1.0/iot-03/statistical-indicators/monitors
Modify Monitor NamePUT:/v1.0/iot-03/statistical-indicators/monitors/{monitor_id}

Intrusion Host Group Silence Management

API NameURL
Mute Host GroupPOST:/v1.0/intrusion/{device_id}/actions/group-silence

Infrared Common APIs

API NameURL
Get Remote Control BrandGET:/v2.0/infrareds/{infrared_id}/categories/{category_id}/remotes/{remote_index}/brands
Get Infrared Code Library InformationGET:/v2.0/infrareds/{infrared_id}/categories/{category_id}/brands/{brand_id}/remotes/{remote_index}/rules
Get Keys of Remote ControlGET:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/keys
Send Standard CommandPOST:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/command
Get Brand ListGET:/v2.0/infrareds/{infrared_id}/categories/{category_id}/brands
Send Standard Command (During Pairing)POST:/v2.0/infrareds/{infrared_id}/testing/command
Get Remote Control IndexesGET:/v2.0/infrareds/{infrared_id}/categories/{category_id}/brands/{brand_id}/remote-indexs
Send Key CommandPOST:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/raw/command
Get Remote Control ListGET:/v2.0/infrareds/{infrared_id}/remotes
Send Key Command (During Pairing)POST:/v2.0/infrareds/{infrared_id}/testing/raw/command
Delete Remote ControlDELETE:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}
Add Remote ControlPOST:/v2.0/infrareds/{infrared_id}/remotes
Modify Remote Control NamePUT:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}
Get Category ListGET:/v2.0/infrareds/{infrared_id}/categories

App Analysis Data

API NameURL
Get App Device DataGET:/v1.0/iot-datacenter/app/device/stat
Get Total Activated DevicesGET:/v1.0/iot-datacenter/app/device/activation/total
Get Devices Controlled on the AppGET:/v1.0/iot-datacenter/app/device/control
Get Registered UsersGET:/v1.0/iot-datacenter/app/user/register/stat

Device Group

API NameURL
Query Group PropertiesGET:/v2.1/cloud/thing/group/{group_id}/properties
Get Groups in SpaceGET:/v2.1/cloud/thing/group
Add DevicesPUT:/v2.1/cloud/thing/group/{group_id}/devices
Create GroupPOST:/v2.1/cloud/thing/group
Get Device GroupGET:/v2.1/cloud/thing/group/device/{device_id}
Query Group Task ProgressGET:/v2.1/cloud/thing/group/task/{group_id}/{task_id}
Query Group StatusGET:/v2.1/cloud/thing/group/{group_id}/status-set
Remove DevicesDELETE:/v2.1/cloud/thing/group/{group_id}/devices
Delete GroupDELETE:/v2.1/cloud/thing/group/{group_id}
Query Group DevicesGET:/v2.1/cloud/thing/group/{group_id}/devices
Modify Group InformationPUT:/v2.1/cloud/thing/group/{group_id}
Send Group PropertiesPOST:/v2.1/cloud/thing/group/{group_id}/properties
Query Group DetailsGET:/v2.1/cloud/thing/group/{group_id}

Text-to-Speech

API NameURL
Send TTS CommandPOST:/v1.0/aispeech/voice/push

Intrusion ByPass Management

API NameURL
Bypass/ResumePOST:/v1.0/intrusion/{device_id}/actions/by-pass

Electric energy alarm threshold management

API NameURL
Set Over-Voltage Protection ValuePOST:/v1.0/electric-energy/{device_id}/actions/voltage-over
Set Power LimitPOST:/v1.0/electric-energy/{device_id}/actions/power-limit
Set Current LimitPOST:/v1.0/electric-energy/{device_id}/actions/current-limit
Set Leakage Alert ValuePOST:/v1.0/electric-energy/{device_id}/actions/leak-warn-value
Set Leakage Action ValuePOST:/v1.0/electric-energy/{device_id}/actions/leak-action-value
Set Electricity Consumption Alert ValuePOST:/v1.0/electric-energy/{device_id}/actions/electric-warn
Set Under-Voltage Protection ValuePOST:/v1.0/electric-energy/{device_id}/actions/voltage-under
Set Over-Temperature Protection ValuePOST:/v1.0/electric-energy/{device_id}/actions/temp-over

Power Safety

API NameURL
Query Electricity Safety RuleGET:/v1.0/iot-03/power-devices/{device_id}/safety-rules
Set Up Electricity Safety RulePOST:/v1.0/iot-03/power-devices/{device_id}/safety-rules
Query Electricity Safety RulesGET:/v1.0/iot-03/power-devices/{device_id}/support-safety-rules

In-site Message Management

API NameURL
Query MessagesGET:/v1.0/sdf/notifications/messages
Delete MessagesDELETE:/v1.0/sdf/notifications/messages
Add MessagePOST:/v1.0/sdf/notifications/messages
Mark Messages as Read/UnreadPUT:/v1.0/sdf/notifications/messages/actions-read

Infrared Smart Match APIs

API NameURL
Get Token by Smart MatchingPOST:/v2.0/infrareds/{infrared_id}/matching-remotes/token
Get Matching Result by TokenGET:/v2.0/infrareds/{infrared_id}/matching-remotes

Location-based service

API NameURL
Reverse GeocodingGET:/v1.0/iot-03/geocode-cities/latitude-longitude
Forward GeocodingGET:/v1.0/iot-03/geocode-cities/address
Get Location by IP Address V1.1GET:/v1.1/iot-03/locations/ip

Multilingual Management

API NameURL
Get Multilingual ListGET:/v1.0/iot-03/app-contents/lang/infos

Get Device Log

API NameURL
Query device status report logGET:/v1.0/iot-03/devices/{device_id}/report-logs
Get Device Event LogGET:/v1.0/iot-03/devices/{device_id}/logs

Campus and Office Asset Management

API NameURL
Transfer DevicePOST:/v1.0/iot-03/assets/devices/{device_id}/actions/transfer

Policy Management

API NameURL
Create PolicyPOST:/v2.0/cloud/iam/policy
Delete PolicyDELETE:/v2.0/cloud/iam/policy/{policy_id}
Modify PolicyPUT:/v2.0/cloud/iam/policy/{policy_id}
Query Policy ListGET:/v2.0/cloud/iam/policy/list
Query Available ActionsGET:/v2.0/cloud/iam/policy/action

Infrared Learning APIs

API NameURL
Update Learning CodePUT:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/learning-codes
Save Learning CodePOST:/v2.0/infrareds/{infrared_id}/learning-codes
Send Learning CodePOST:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/learning-codes
Get Learning CodesGET:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/learning-codes
Modify Learning StatusPUT:/v2.0/infrareds/{infrared_id}/learning-state
Get Learned Remote Control CodeGET:/v2.0/infrareds/{infrared_id}/learning-codes
Delete Learning CodeDELETE:/v2.0/infrareds/{infrared_id}/learning-codes/{learn_id}
Get General Key InformationGET:/v2.0/infrareds/{category_id}/base-key

Banner Management

API NameURL
Delete BannerDELETE:/v1.0/iot-03/app-contents/banners/{banner_id}
Remove BannerPOST:/v1.0/iot-03/app-contents/banners/{banner_id}/actions/unshelve
Query Banner InformationGET:/v1.0/iot-03/app-contents/banners
Create BannerPOST:/v1.0/iot-03/app-contents/banners
Update BannerPUT:/v1.0/iot-03/app-contents/banners/{banner_id}
Release BannerPOST:/v1.0/iot-03/app-contents/banners/{banner_id}/actions/publish

Real Time Location

API NameURL
Query Real-time Locations of Multiple DevicesGET:/v2.0/iot-01/tracks/location

Manage Permission Rules

API NameURL
Modify Access Control RulePUT:/v1.0/iot-02/access-controls/{access_control_id}
Add Access Control RulePOST:/v1.0/iot-02/access-controls
Delete Access Control RuleDELETE:/v1.0/iot-02/access-controls/{access_control_id}

Country Code

API NameURL
Get a List of Country CodesGET:/v3.0/iot-03/all-countries

Geographical Fence

API NameURL
Add Devices in GeofencePOST:/v2.0/iot-01/fences/{fence_id}/entity
Create Polygonal GeofencePOST:/v2.0/iot-01/fences/polygon
Modify Polygonal GeofencePUT:/v2.0/iot-01/fences/polygon/{fence_id}
Query Objects in GeofenceGET:/v2.0/iot-01/fences/{fence_id}/entity
Query All GeofencesGET:/v2.0/iot-01/fences/list
Create Circular GeofencePOST:/v2.0/iot-01/fences/circle
Enable or Disable GeofencePUT:/v2.0/iot-01/fences/{fence_id}/open
Query Multiple Private GeofencesGET:/v2.0/iot-01/fences/private/batch
Save Circular Private GeofencesPOST:/v2.0/iot-01/fences/circle/private/batch
Modify Circular GeofencePUT:/v2.0/iot-01/fences/circle/{fence_id}
Query Geofence by Geofence IDGET:/v2.0/iot-01/fences/batch
Save Polygonal Private GeofencesPOST:/v2.0/iot-01/fences/polygon/private/batch

Environmental Data Query

API NameURL
Query Real-Time Environmental Indicators of DevicesGET:/v1.0/iot-03/assets/{asset_id}/devices/environment-status
Query Environmental Indicators of DevicesGET:/v1.0/iot-03/assets/{asset_id}/devices/environment-statistics
Query Real-Time Environmental Indicators of AssetsGET:/v1.0/iot-03/assets/{asset_id}/environment-status
Query Environmental Indicators of AssetsGET:/v1.0/iot-03/assets/{asset_id}/environment-statistics
Query Alerts of Environmental Indicators of DevicesGET:/v1.0/iot-03/assets/{asset_id}/devices/environment-alarms
Query Environmental IndicatorsGET:/v1.1/iot-03/environment-indicators/statistics

Intrusion Host Protection Management

API NameURL
Arm/Disarm HostPOST:/v1.0/intrusion/{device_id}/actions/chan-action

Electric energy switch management

API NameURL
Set Enabling SwitchPOST:/v1.0/electric-energy/{device_id}/actions/hand-enable
Set Circuit SwitchPOST:/v1.0/electric-energy/{device_id}/actions/switch

Devices Group Management

API NameURL
Get Details of Device Group TasksGET:/v1.0/iot-03/device-groups/{group_id}/tasks

Content management

API NameURL
Edit ContentPUT:/v1.0/iot-03/app-contents/{content_id}
Sticky on TopPOST:/v1.0/iot-03/app-contents/actions/top
Remove from TopPOST:/v1.0/iot-03/app-contents/actions/untop
Query Content on PagesGET:/v1.0/iot-03/app-contents
Query Content DetailsGET:/v1.0/iot-03/app-contents/{content_id}
Release ContentPOST:/v1.0/iot-03/app-contents/actions/publish
Create ContentPOST:/v1.0/iot-03/app-contents
Delete ContentDELETE:/v1.0/iot-03/app-contents
Remove ContentPOST:/v1.0/iot-03/app-contents/actions/unshelve