适用于云项目关联 APP/微信小程序等授权方式,可以通过调用以下接口获取/操作授权方的数据
授权管理
API名称 | 接口地址 |
获取令牌 | GET:/v1.0/token |
刷新令牌 | GET:/v1.0/token/{refreshToken} |
语音消息服务
API名称 | 接口地址 |
发送语音通知 | POST:/v1.0/iot-03/messages/voices/actions/push |
添加语音模板 | POST:/v1.0/iot-03/msg-templates/voices |
获取语音模板清单 | GET:/v1.0/iot-03/msg-templates/voices |
语音模板详情查询 | GET:/v1.0/iot-03/msg-templates/voices/{template_id} |
短信服务
API名称 | 接口地址 |
添加短信模板 | POST:/v1.0/iot-03/msg-templates/sms |
短信模板详情查询 | GET:/v1.0/iot-03/msg-templates/sms/{template_id} |
获取短信模板清单 | GET:/v1.0/iot-03/msg-templates/sms |
发送短信 | POST:/v1.0/iot-03/messages/sms/actions/push |
消息推送服务
API名称 | 接口地址 |
推送 App 通知 | POST:/v1.0/iot-03/messages/app-notifications/actions/push |
添加 App 通知栏模板 | POST:/v1.0/iot-03/msg-templates/app-notifications |
App推送模板详情查询 | GET:/v1.0/iot-03/msg-templates/app-notifications/{template_id} |
获取 App 通知栏模板清单 | GET:/v1.0/iot-03/msg-templates/app-notifications |
邮件服务
API名称 | 接口地址 |
发送邮件 | POST:/v1.0/iot-03/messages/mails/actions/push |
添加邮件模板 | POST:/v1.0/iot-03/msg-templates/mails |
邮件模板详情查询 | GET:/v1.0/iot-03/msg-templates/mails/{template_id} |
获取邮件模板清单 | GET:/v1.0/iot-03/msg-templates/mails |
定时管理
API名称 | 接口地址 |
查询设备下的定时任务列表 | GET:/v1.0/devices/{devId}/timers |
删除设备下的所有定时任务 | DELETE:/v1.0/devices/{devId}/timers |
设备添加定时任务 | POST:/v1.0/devices/{devId}/timers |
删除某个分类的定时任务 | DELETE:/v1.0/devices/{devId}/timers/categories/{category} |
获取分类下的定时任务信息 | GET:/v1.0/devices/{devId}/timers/categories/{category} |
更新定时任务组状态 | PUT:/v1.0/devices/{devId}/timers/categories/{category}/groups/{group_id}/status |
删除定时任务 | DELETE:/v1.0/devices/{devId}/timers/categories/{category}/groups/{groupId} |
更新定时任务组信息 | PUT:/v1.0/devices/{devId}/timers/groups/{groupId} |
行业设备注册
API名称 | 接口地址 |
资产绑定设备 | POST:/v1.1/iot-02/device-bc-bind |
空间管理
API名称 | 接口地址 |
删除空间 | DELETE:/v2.0/cloud/space/{space_id} |
查询空间下资源列表 | GET:/v2.0/cloud/space/{space_id}/resource |
创建空间 | POST:/v2.0/cloud/space/creation |
查询空间 | GET:/v2.0/cloud/space/{space_id} |
查询空间节点列表 | GET:/v2.0/cloud/space/child |
修改空间信息 | PUT:/v2.0/cloud/space/{space_id} |
判断父子关系 | GET:/v2.0/cloud/space/relation |
全屋管理
API名称 | 接口地址 |
添加家庭 | POST:/v1.0/home/create-home |
查询家庭 | GET:/v1.0/homes/{home_id} |
修改家庭 | PUT:/v1.0/homes/{home_id} |
删除家庭 | DELETE:/v1.0/homes/{home_id} |
查询家庭下的设备列表 | GET:/v1.0/homes/{home_id}/devices |
查询家庭成员列表信息 | GET:/v1.0/homes/{home_id}/members |
添加家庭成员 | POST:/v1.0/homes/{home_id}/members |
修改家庭成员信息 | PUT:/v1.0/homes/{home_id}/members/{uid} |
删除家庭成员 | DELETE:/v1.0/homes/{home_id}/members/{uid} |
添加房间 | POST:/v1.0/homes/{home_id}/room |
查询家庭下的房间列表 | GET:/v1.0/homes/{home_id}/rooms |
删除房间 | DELETE:/v1.0/homes/{home_id}/rooms/{room_id} |
修改房间名称 | PUT:/v1.0/homes/{home_id}/rooms/{room_id} |
查询家庭房间设备 | GET:/v1.0/homes/{home_id}/rooms/{room_id}/devices |
查询⽤户家庭列表 | GET:/v1.0/users/{uid}/homes |
新增房间内的设备 | POST:/v1.0/homes/{home_id}/rooms/{room_id}/devices |
修改家庭下房间内的设备 | PUT:/v1.0/homes/{home_id}/rooms/{room_id}/devices |
删除家庭下房间内的设备 | DELETE:/v1.0/homes/{home_id}/rooms/{room_id}/devices |
获取设备列表 | GET:/v1.0/devices |
全屋用户管理
API名称 | 接口地址 |
同步用户 | POST:/v1.0/apps/{schema}/user |
获取用户信息 | GET:/v1.0/users/{uid}/infos |
获取用户列表 | GET:/v2.0/apps/{schema}/users |
取消删除 | POST:/v1.0/users/{uid}/actions/cancel-delete |
用户预删除 | POST:/v1.0/users/{uid}/actions/pre-delete |
获取用户的设备列表 | GET:/v1.0/users/{uid}/devices |
场景管理
API名称 | 接口地址 |
获取设备支持的联动条件 | GET:/v1.0/devices/{device_id}/enable-linkage/codes |
查询设备已绑定场景 | GET:/v1.0/devices/{device_id}/scenes |
场景解绑 | DELETE:/v1.0/devices/{device_id}/scenes/{scene_id} |
场景绑定 | POST:/v1.0/devices/{device_id}/scenes/{scene_id} |
查询支持场景的设备列表 | GET:/v1.0/homes/{home_id}/scene/devices |
查询家庭下的场景列表 | GET:/v1.0/homes/{home_id}/scenes |
添加场景 | POST:/v1.0/homes/{home_id}/scenes |
修改场景 | PUT:/v1.0/homes/{home_id}/scenes/{scene_id} |
删除家庭下的单个场景 | DELETE:/v1.0/homes/{home_id}/scenes/{scene_id} |
触发执行指定场景 | POST:/v1.0/homes/{home_id}/scenes/{scene_id}/trigger |
查询默认场景图⽚列表 | GET:/v1.0/scenes/default-pictures |
启用场景 | PUT:/v1.0/homes/{home_id}/scenes/{scene_id}/actions/enable |
停用场景 | PUT:/v1.0/homes/{home_id}/scenes/{scene_id}/actions/disable |
启用自动化 | PUT:/v1.0/homes/{home_id}/automations/{automation_id}/actions/enable |
停用自动化 | PUT:/v1.0/homes/{home_id}/automations/{automation_id}/actions/disable |
查询家庭下场景列表 | GET:/v1.1/homes/{home_id}/scenes |
全屋应用管理
自动化管理
API名称 | 接口地址 |
查询支持自动化场景的设备列表 | GET:/v1.0/homes/{home_id}/automation/devices |
添加自动化 | POST:/v1.0/homes/{home_id}/automations |
查询自动化列表 | GET:/v1.0/homes/{home_id}/automations |
查询自动化场景 | GET:/v1.0/homes/{home_id}/automations/{automation_id} |
修改自动化 | PUT:/v1.0/homes/{home_id}/automations/{automation_id} |
删除自动化 | DELETE:/v1.0/homes/{home_id}/automations/{automation_id} |
触发自动化外部条件 | POST:/v1.0/homes/{home_id}/automations/{automation_id}/conditions/trigger |
获取家庭支持的联动条件 | GET:/v1.0/homes/{home_id}/enable-linkage/codes |
查询天气条件 | GET:/v1.0/homes/automation/weather/conditions |
获取家庭支持的联动条件,返回群组动作 | GET:/v2.0/homes/{home_id}/enable-linkage/codes |
获取家庭支持的联动群组动作 | GET:/v1.0/homes/{home_id}/linkage/device-group/functions |
全屋配网管理
API名称 | 接口地址 |
获取子设备列表 | GET:/v1.0/devices/{deviceId}/list-sub |
允许子设备入网 | PUT:/v1.0/devices/{deviceId}/enabled-sub-discovery |
获取配网设备列表 | GET:/v1.0/device/paring/tokens/{token} |
全屋设备管理
API名称 | 接口地址 |
查询网关下 Zigbee 设备 | GET:/v1.0/devices/{deviceId}/sub-devices |
批量查询设备出厂信息 | GET:/v1.0/devices/factory-infos |
修改设备名称 | PUT:/v1.0/devices/{device_id} |
查询设备日志 | GET:/v1.0/devices/{device_id}/logs |
恢复设备出厂设置 | PUT:/v1.0/devices/{device_id}/reset-factory |
获取设备详情 | GET:/v1.0/devices/{deviceId} |
移除设备 | DELETE:/v1.0/devices/{deviceId} |
获取设备状态 | GET:/v1.0/devices/{deviceId}/status |
获取设备列表 v2 | GET:/v2.0/devices |
批量查询关联 App 用户维度设备列表 | GET:/v1.0/iot-01/associated-users/devices |
删除用户 | DELETE:/v1.0/devices/{device_id}/users/{user_id} |
修改设备成员 | PUT:/v1.0/devices/{device_id}/users/{user_id} |
查询设备成员信息 | GET:/v1.0/devices/{device_id}/users/{user_id} |
新增设备成员 | POST:/v1.0/devices/{device_id}/user |
根据设备 ID查询成员信息列表 | GET:/v1.0/devices/{device_id}/users |
设备管理
API名称 | 接口地址 |
获取设备状态上报日志 | GET:/v2.0/cloud/thing/{device_id}/report-logs |
获取设备升级进度 | GET:/v2.0/cloud/thing/{device_id}/firmware/{channel}/progress |
批量查询设备详情 | GET:/v2.0/cloud/thing/batch |
移除设备 | DELETE:/v2.0/cloud/thing/{device_id} |
获取设备升级信息 | GET:/v2.0/cloud/thing/{device_id}/firmware |
查询单个设备详情 | GET:/v2.0/cloud/thing/{device_id} |
确认开始设备升级 | POST:/v2.0/cloud/thing/{device_id}/firmware/{channel} |
获取设备状态 | GET:/v2.0/cloud/thing/{device_id}/state |
获取设备操作日志 | GET:/v2.0/cloud/thing/{device_id}/logs |
修改设备基础属性 | POST:/v2.0/cloud/thing/{device_id}/attribute |
冻结/解冻设备 | POST:/v2.0/cloud/thing/{device_id}/freeze |
转移设备 | POST:/v2.0/cloud/thing/{device_id}/transfer |
恢复出厂设置 | POST:/v2.0/cloud/thing/{device_id}/reset |
查询空间下设备列表 | GET:/v2.0/cloud/thing/space/device |
查询项目下设备列表 | GET:/v2.0/cloud/thing/device |
自联网设备扫码配网 | POST:/v2.0/cloud/thing/active/qrcode |
查询配网结果 | GET:/v2.0/cloud/thing/active/token/{token} |
下发信号检测指令 | POST:/v2.0/cloud/thing/signal/detection/issue |
查询信号强度 | GET:/v2.0/cloud/thing/{device_id}/{device_type}/signal |
全屋设备控制
API名称 | 接口地址 |
修改功能点名称 | PUT:/v1.0/devices/{device_id}/functions/{function_code} |
控制设备 | POST:/v1.0/devices/{deviceId}/commands |
获取设备支持的指令集 | GET:/v1.0/devices/{deviceId}/functions |
获取设备规格属性 | GET:/v1.0/devices/{deviceId}/specifications |
按品类获取指令集 | GET:/v1.0/functions/{category} |
批量获取指令集 | GET:/v1.0/devices/functions |
获取设备规格属性 | GET:/v1.1/devices/{device_id}/specifications |
设备控制
API名称 | 接口地址 |
下发动作 | POST:/v2.0/cloud/thing/{device_id}/shadow/actions |
查询属性 | GET:/v2.0/cloud/thing/{device_id}/shadow/properties |
修改属性 | POST:/v2.0/cloud/thing/{device_id}/shadow/properties |
查询期望属性 | GET:/v2.0/cloud/thing/{device_id}/shadow/properties/desired |
下发属性 | POST:/v2.0/cloud/thing/{device_id}/shadow/properties/issue |
设置期望属性 | POST:/v2.0/cloud/thing/{device_id}/shadow/properties/desired |
查询物模型 | GET:/v2.0/cloud/thing/{device_id}/model |
基础数据
设备OTA固件升级
API名称 | 接口地址 |
确认设备升级 | POST:/v1.0/iot-03/devices/{device_id}/confirm-upgrade |
获取设备上的固件是否有可用升级 | GET:/v1.0/iot-03/devices/{device_id}/upgrade-infos |
场景联动规则
API名称 | 接口地址 |
获取联动规则详情 | GET:/v2.0/cloud/scene/rule/{rule_id} |
查询联动规则列表 | GET:/v2.0/cloud/scene/rule |
删除联动规则 | DELETE:/v2.0/cloud/scene/rule |
触发一键执行 | POST:/v2.0/cloud/scene/rule/{rule_id}/actions/trigger |
修改联动规则 | PUT:/v2.0/cloud/scene/rule/{rule_id} |
启用/禁用自动化 | PUT:/v2.0/cloud/scene/rule/state |
新增联动规则 | POST:/v2.0/cloud/scene/rule |
智能门锁功能设置
API名称 | 接口地址 |
分配门锁密码给设备成员 | POST:/v1.0/devices/{device_id}/device-lock/users/{user_id}/allocate |
获取动态密码 | GET:/v1.0/devices/{device_id}/door-lock/dynamic-password |
同步密码 | POST:/v1.0/devices/{device_id}/door-lock/issue-password |
远程含密开门 | POST:/v1.0/devices/{device_id}/door-lock/open-door |
获取开门记录 | GET:/v1.0/devices/{device_id}/door-lock/open-logs |
创建临时密码 | POST:/v1.0/devices/{device_id}/door-lock/temp-password |
获取临时密码信息 | GET:/v1.0/devices/{device_id}/door-lock/temp-password/{password_id} |
获取临时密码列表 | GET:/v1.0/devices/{device_id}/door-lock/temp-passwords |
删除临时密码 | DELETE:/v1.0/devices/{device_id}/door-lock/temp-passwords/{password_id} |
冻结临时密码 | PUT:/v1.0/devices/{device_id}/door-lock/temp-passwords/{password_id}/freeze-password |
修改临时密码 | PUT:/v1.0/devices/{device_id}/door-lock/temp-passwords/{password_id}/modify-password |
删除临时密码记录 | DELETE:/v1.0/devices/{device_id}/door-lock/temp-passwords/{password_id}/record |
创建无名称的临时密码 | POST:/v2.0/devices/{device_id}/door-lock/temp-password |
获取临时密钥 | POST:/v1.0/devices/{device_id}/door-lock/password-ticket |
获取成员已绑定的解锁方式 | GET:/v1.0/devices/{device_id}/door-lock/user-types/{user_type}/users/{user_id}/assigned-keys |
获取成员未绑定的解锁方式 | GET:/v1.0/devices/{device_id}/door-lock/unassigned-keys |
录入门锁解锁方式 | PUT:/v1.0/devices/{device_id}/door-lock/actions/entry |
删除指定解锁方式 | DELETE:/v1.0/devices/{device_id}/door-lock/user-types/{user_type}/users/{user_id}/unlock-types/{unlock_type}/keys/{unlock_no} |
取消指定解锁方式的录入 | PUT:/v1.0/devices/{device_id}/door-lock/unlock-types/{unlock_type}/actions/cancel |
设置解锁方式为劫持 | PUT:/v1.0/devices/{device_id}/door-lock/unlock-types/{unlock_type}/keys/{unlock_no}/hijack |
获取门锁告警记录 | GET:/v1.0/devices/{device_id}/door-lock/alarm-logs |
设置高级密码 | POST:/v1.0/devices/{device_id}/door-lock/advanced-password |
查看高级密码 | GET:/v1.0/devices/{device_id}/door-lock/advanced-password |
清空临时密码 | POST:/v1.0/devices/{device_id}/door-lock/temp-passwords/rest-password |
获取临时秘钥 | POST:/v1.0/smart-lock/devices/{device_id}/password-ticket |
专有设备成员管理
API名称 | 接口地址 |
新增设备成员 | POST:/v1.0/devices/{device_id}/user |
根据设备 ID查询成员信息列表 | GET:/v1.0/devices/{device_id}/users |
修改设备成员 | PUT:/v1.0/devices/{device_id}/users/{user_id} |
删除用户 | DELETE:/v1.0/devices/{device_id}/users/{user_id} |
查询设备成员信息 | GET:/v1.0/devices/{device_id}/users/{user_id} |
设备控制(标准指令集)
API名称 | 接口地址 |
获取设备规格属性 | GET:/v1.0/iot-03/devices/{device_id}/specification |
获取设备支持的指令集 | GET:/v1.0/iot-03/devices/{device_id}/functions |
获取品类支持的指令集 | GET:/v1.0/iot-03/categories/{category}/functions |
下发指令 | POST:/v1.0/iot-03/devices/{device_id}/commands |
获取产品品类列表 | GET:/v1.0/iot-03/device-categories |
获取单个设备的状态 | GET:/v1.0/iot-03/devices/{device_id}/status |
批量获取设备最新状态 | GET:/v1.0/iot-03/devices/status |
获取状态集 | GET:/v1.0/iot-03/categories/{category}/status |
公区设备信息
API名称 | 接口地址 |
获取设备详情 | GET:/v1.0/expand/devices/{device_id} |
获取设备列表 | GET:/v1.0/expand/devices |
公区设备指令
API名称 | 接口地址 |
指令记录查询 | GET:/v1.0/expand/cmds/{sn} |
公区设备权限
API名称 | 接口地址 |
删除用户的设备权限 | DELETE:/v1.0/expand/spaces/{device_id}/persons/{person_id} |
新增用户设备权限 | POST:/v1.0/expand/spaces/{device_id}/persons/{person_id} |
设备监控
API名称 | 接口地址 |
查询工业设备监控信息 | GET:/v1.1/iot-03/si/devices/core-monitoring |
设备能力管理
API名称 | 接口地址 |
查询设备能力列表 | GET:/v1.0/iot-03/devices/{device_id}/capabilities-definition |
公区设备功能点
API名称 | 接口地址 |
获取设备功能池 | GET:/v1.0/expand/devices/{device_id}/function-pool |
修改设备功能点 | PUT:/v1.0/expand/devices/{device_id}/functions |
获取设备功能点列表 | GET:/v1.0/expand/devices/{device_id}/functions |
设备分布
API名称 | 接口地址 |
获取地理位置下的设备数 | GET:/v1.1/iot-03/si/devices/distribution/count |
查询工业设备分布 | GET:/v1.1/iot-03/si/devices/distribution |
红外空调
API名称 | 接口地址 |
空调组合按键下发 | POST:/v2.0/infrareds/{infrared_id}/air-conditioners/{remote_id}/scenes/command |
空调遥控器单个指令下发(配对阶段) | POST:/v2.0/infrareds/{infrared_id}/air-conditioners/testing/command |
下发空调组合按键(配对阶段) | POST:/v2.0/infrareds/{infrared_id}/air-conditioners/testing/scenes/command |
获取空调的当前状态 | GET:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/ac/status |
空调遥控器单个指令控制 | POST:/v2.0/infrareds/{infrared_id}/air-conditioners/{remote_id}/command |
红外定时任务
API名称 | 接口地址 |
添加红外定时任务 | POST:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/timers |
更新定时任务 | PUT:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/timers |
更新定时任务状态 | PUT:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/timers/status |
获取设备的红外定时任务 | GET:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/timers |
删除定时任务 | DELETE:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/timers |
用电管理
API名称 | 接口地址 |
查询用电设备的剩余电量 | GET:/v1.0/iot-03/power-devices/{device_id}/balance-charge |
设置用电设备的预付费功能启用状态 | POST:/v1.0/iot-03/power-devices/{device_id}/prepayment |
设置用电设备的余额告警阈值 | POST:/v1.0/iot-03/power-devices/{device_id}/balance-threshold |
查询用电设备预付费功能启用状态 | GET:/v1.0/iot-03/power-devices/{device_id}/prepayment |
查询用电设备的余额告警阈值 | GET:/v1.0/iot-03/power-devices/{device_id}/balance-threshold |
清零用电设备的剩余电量 | POST:/v1.0/iot-03/power-devices/{device_id}/clear-charge |
查询用电设备的电量充值记录 | GET:/v1.0/iot-03/power-devices/{device_id}/charge-records |
用电设备电量充值 | POST:/v1.0/iot-03/power-devices/{device_id}/charge |
历史轨迹
API名称 | 接口地址 |
获取设备轨迹点 | GET:/v2.0/iot-01/tracks/detail |
获取设备轨迹分段 | GET:/v2.0/iot-01/tracks/segments |
告警管理
API名称 | 接口地址 |
查询围栏告警 | GET:/v2.0/iot-01/fences/warn/list |
文字识别
API名称 | 接口地址 |
文字识别 | POST:/v1.0/iot-03/ai-vision/text/actions/discern |
权限规则绑定设备
API名称 | 接口地址 |
移除门禁设备 | POST:/v1.0/iot-02/access-controls/{access_control_id}/actions/device-unbind |
新增门禁设备 | POST:/v1.0/iot-02/access-controls/{access_control_id}/actions/device-bind |
查询门禁关联设备 | GET:/v1.0/iot-02/access-controls/{access_control_id}/devices |
栏目管理
API名称 | 接口地址 |
批量获取栏目信息 | GET:/v1.0/iot-03/app-contents/categories/batch |
发布栏目 | POST:/v1.0/iot-03/app-contents/categories/{category_id}/actions/publish |
下线栏目 | POST:/v1.0/iot-03/app-contents/categories/{category_id}/actions/unshelve |
删除栏目 | DELETE:/v1.0/iot-03/app-contents/categories/{category_id} |
编辑栏目 | PUT:/v1.0/iot-03/app-contents/categories/{category_id} |
栏目统计 | GET:/v1.0/iot-03/app-contents/categories/statistic |
创建栏目 | POST:/v1.0/iot-03/app-contents/categories |
查询栏目信息 | GET:/v1.0/iot-03/app-contents/categories |
用电统计
API名称 | 接口地址 |
查询指定维度节点能源数据时间趋势 | GET:/v1.0/iot-03/energy/{energy_type}/statistics |
监测点能耗排行 | GET:/v1.0/iot-03/energy/{energy_type}/monitors-top |
查询空间能源设备列表 | GET:/v1.0/iot-03/energy/{energy_type}/space/devices |
查询监测点能源数据趋势 | GET:/v1.0/iot-03/energy/{energy_type}/monitors-trend |
查询空间下能耗排行 | GET:/v1.0/iot-03/energy/{energy_type}/space/statistics-top |
查询空间能耗趋势 | GET:/v1.0/iot-03/energy/{energy_type}/space/statistics-trend |
查询空间下的设备用电趋势 | GET:/v1.0/iot-03/energy/{energy_type}/devices/statistics-trend |
查询空间下的能耗总量 | GET:/v1.0/iot-03/energy/{energy_type}/space/statistics-sum |
项目空间统计 | GET:/v1.0/iot-03/energy/{energy_type}/space-count |
查询空间下的设备用电排行 | GET:/v1.0/iot-03/energy/{energy_type}/space/statistics/devices-top |
批量移除用电设备 | POST:/v1.0/iot-03/energy/{energy_type}/space/{space_id}/devices-remove |
批量添加能源设备 | POST:/v1.0/iot-03/energy/{energy_type}/space/{space_id}/devices |
查询节点总用电量 | GET:/v1.0/iot-03/energy/{energy_type}/space/nodes/statistics-sum |
多设备用电趋势汇总统计 | GET:/v1.0/iot-03/energy/{energy_type}/devices/nodes/statistics-trend |
查询设备的总用电量 | GET:/v1.0/iot-03/energy/{energy_type}/device/nodes/statistics-sum |
断路器数据管理
API名称 | 接口地址 |
获取实时数据 | GET:/v1.0/electric-energy/{device_id}/actions/realtime-data |
用户画像
城市查询
设备定时
API名称 | 接口地址 |
启用/禁用设备定时 | PUT:/v2.0/cloud/timer/device/{device_id}/state |
查询设备定时 | GET:/v2.0/cloud/timer/device/{device_id} |
新增设备定时 | POST:/v2.0/cloud/timer/device/{device_id} |
修改设备定时 | PUT:/v2.0/cloud/timer/device/{device_id} |
批量删除设备定时 | DELETE:/v2.0/cloud/timer/device/{device_id}/batch |
清空设备定时 | DELETE:/v2.0/cloud/timer/device/{device_id} |
文件管理
API名称 | 接口地址 |
获取文件上传地址信息 | GET:/v1.0/iot-03/app-contents/upload-file/infos |
获取文件上传结果信息 | GET:/v1.0/iot-03/app-contents/upload-file/{upload_token}/infos |
轮询获取大文件上传结果状态 | GET:/v1.0/iot-03/app-contents/big-files/status |
文件下载 | POST:/v1.0/iot-03/app-contents/files/actions/download |
红外机顶盒
API名称 | 接口地址 |
切换遥控器的频道表 | PUT:/v2.0/infrareds/{infrared_id}/remote/{remote_id}/channels |
根据频道号切换频道 | POST:/v2.0/infrareds/{infrared_id}/channel/switch |
删除自定义的频道表 | DELETE:/v2.0/infrareds/{infrared_id}/remote/custom/{submit_id} |
更新自定义的频道表 | PUT:/v2.0/infrareds/{infrared_id}/remote/{remote_id}/custom/{submit_id} |
根据地区 ID 获取运营商列表 | GET:/v2.0/infrareds/{infrared_id}/areas/{area_id}/operators |
获取频道表列表 | GET:/v2.0/infrareds/{infrared_id}/remote/channels |
根据遥控器 ID 获取频道表列表 | GET:/v2.0/infrareds/{infrared_id}/remote/{remote_id}/channels |
获取所有的频道名 | GET:/v2.0/infrareds/{infrared_id}/remote/all-channels |
获取地区列表 | GET:/v2.0/infrareds/{infrared_id}/provinces/{province_id}/cities/{city_id}/areas |
获取省份列表 | GET:/v2.0/infrareds/{infrared_id}/provinces |
获取机顶盒绑定的频道表 | GET:/v2.0/infrareds/{infrared_id}/remote/{remote_id}/selected-channels |
根据省份 ID 获取城市列表 | GET:/v2.0/infrareds/{infrared_id}/provinces/{province_id}/cities |
设备能力访问
API名称 | 接口地址 |
执行设备指定能力 | POST:/v1.0/iot-03/devices/{device_id}/capabilities/{capability_code} |
查询设备指定能力 | GET:/v1.0/iot-03/devices/{device_id}/capabilities/{capability_code} |
批量执行设备能力 | POST:/v1.0/iot-03/devices/{device_id}/capabilities |
查询设备能力状态 | GET:/v1.0/iot-03/devices/{device_id}/capabilities |
权限管理
API名称 | 接口地址 |
查询项目权限数据 | GET:/v2.0/cloud/iam/permission/list |
解除用户关联权限 | DELETE:/v2.0/cloud/iam/permission/{permission_id}/user/{user_id} |
查询权限数据 | GET:/v2.0/cloud/iam/permission/user/{user_id} |
查询用户列表 | GET:/v2.0/cloud/iam/user/permission/{permission_id} |
创建权限 | POST:/v2.0/cloud/iam/permission |
查询项目下的权限数据 | GET:/v2.0/cloud/iam/permission/query |
查询权限 | GET:/v2.0/cloud/iam/permission/{permission_id} |
删除权限 | DELETE:/v2.0/cloud/iam/permission/{permission_id} |
修改权限信息 | PUT:/v2.0/cloud/iam/permission/{permission_id} |
关联子权限 | POST:/v2.0/cloud/iam/permission/{permission_id}/item |
关联用户和权限 | POST:/v2.0/cloud/iam/permission/{permission_id}/user/{user_id} |
查询子权限列表 | GET:/v2.0/cloud/iam/permission/{permission_id}/item |
解除子权限 | DELETE:/v2.0/cloud/iam/permission/{permission_id}/item/{item_id} |
用户反馈管理
API名称 | 接口地址 |
获取沟通记录 | GET:/v1.0/iot-01/ticket/feedbacks/{feedback_id}/communications |
获取工单列表 | GET:/v1.0/iot-01/ticket/feedbacks |
获取用户反馈工单类型 | GET:/v1.0/iot-01/ticket/feedbacks/feedback-type |
完结工单 | PUT:/v1.0/iot-01/ticket/feedbacks/{feedback_id}/operation-finish |
获取用户反馈工单状态 | GET:/v1.0/iot-01/ticket/feedbacks/feedback-state |
回复工单 | POST:/v1.0/iot-01/ticket/feedbacks/{feedback_id}/operation-reply |
获取工单详情 | GET:/v1.0/iot-01/ticket/feedbacks/{feedback_id} |
获取未完结用户反馈工单总数 | GET:/v1.0/iot-01/ticket/feedbacks/feedback-statistics |
获取用户的评价信息 | GET:/v1.0/iot-01/ticket/feedbacks/{feedback_id}/evaluate |
App管理
告警统计
API名称 | 接口地址 |
查询告警统计图表 | GET:/v1.0/si/iot-03/alarm-statistics/chart |
查询告警统计 | GET:/v1.0/si/iot-03/alarm-statistics |
天气
API名称 | 接口地址 |
获取当前天气 | GET:/v2.0/iot-03/weather/current |
获取 7 日天气预报 | GET:/v2.0/iot-03/weather/forecast/daily |
获取历史 24 小时天气 | GET:/v2.0/iot-03/weather/history24 |
设备云云接入
API名称 | 接口地址 |
设备属性上报 | POST:/v1.0/iot-03/3rdcloud/devices/{device_id}/property/report |
设备动作响应上报 | POST:/v1.0/iot-03/3rdcloud/devices/{device_id}/action-resp/report |
设备事件上报 | POST:/v1.0/iot-03/3rdcloud/devices/{device_id}/event/report |
自定义纬度统计
API名称 | 接口地址 |
删除自定义维度节点 | DELETE:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes/{node_id} |
从自定义维度节点移除设备 | DELETE:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes/{node_id}/devices |
删除监测点 | DELETE:/v1.0/iot-03/statistical-indicators/monitors/{monitor_id} |
查询自定义维度节点设备 | GET:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes/{node_id}/devices |
查询自定义维度节点 | GET:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes |
查询监测点绑定设备 | GET:/v1.0/iot-03/statistical-indicators/monitors/{monitor_id}/devices |
查询监测点 | GET:/v1.0/iot-03/statistical-indicators/monitors |
统计监测点 | GET:/v1.0/iot-03/statistical-indicators/monitors/devices-count |
添加设备到自定义维度节点 | POST:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes/{node_id}/devices |
创建自定义维度节点 | POST:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes |
创建自定义维度 | POST:/v1.0/iot-03/statistical-dimensions/{dimension_code} |
修改自定义维度节点 | PUT:/v1.0/iot-03/statistical-dimensions/{dimension_code}/nodes/{node_id} |
移除监测点的设备 | POST:/v1.0/iot-03/statistical-indicators/monitors/{monitor_id}/devices-remove |
监测点绑定设备 | POST:/v1.0/iot-03/statistical-indicators/monitors/{monitor_id}/devices |
新增监测点 | POST:/v1.0/iot-03/statistical-indicators/monitors |
修改监测点名称 | PUT:/v1.0/iot-03/statistical-indicators/monitors/{monitor_id} |
周届主机群组消音管理
API名称 | 接口地址 |
主机群组消音 | POST:/v1.0/intrusion/{device_id}/actions/group-silence |
红外通用接口
API名称 | 接口地址 |
获取遥控器索引 ID 对应的品牌 | GET:/v2.0/infrareds/{infrared_id}/categories/{category_id}/remotes/{remote_index}/brands |
获取红外码库信息 | GET:/v2.0/infrareds/{infrared_id}/categories/{category_id}/brands/{brand_id}/remotes/{remote_index}/rules |
遥控器支持的按键信息 | GET:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/keys |
标准命令下发 | POST:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/command |
获取品类支持的品牌列表 | GET:/v2.0/infrareds/{infrared_id}/categories/{category_id}/brands |
标准命令下发(配对阶段) | POST:/v2.0/infrareds/{infrared_id}/testing/command |
获取品牌下的遥控器索引列表 | GET:/v2.0/infrareds/{infrared_id}/categories/{category_id}/brands/{brand_id}/remote-indexs |
按键命令下发 | POST:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/raw/command |
获取遥控器列表 | GET:/v2.0/infrareds/{infrared_id}/remotes |
按键命令下发(配对阶段) | POST:/v2.0/infrareds/{infrared_id}/testing/raw/command |
删除遥控器 | DELETE:/v2.0/infrareds/{infrared_id}/remotes/{remote_id} |
添加遥控器 | POST:/v2.0/infrareds/{infrared_id}/remotes |
修改遥控器名称 | PUT:/v2.0/infrareds/{infrared_id}/remotes/{remote_id} |
获取设备支持的品类列表 | GET:/v2.0/infrareds/{infrared_id}/categories |
App分析数据
API名称 | 接口地址 |
获取app设备数据 | GET:/v1.0/iot-datacenter/app/device/stat |
获取累计激活设备数 | GET:/v1.0/iot-datacenter/app/device/activation/total |
获取 App 控制设备数据 | GET:/v1.0/iot-datacenter/app/device/control |
获取 App 注册用户数据 | GET:/v1.0/iot-datacenter/app/user/register/stat |
设备群组
API名称 | 接口地址 |
查询群组属性 | GET:/v2.1/cloud/thing/group/{group_id}/properties |
获取空间下群组 | GET:/v2.1/cloud/thing/group |
添加设备 | PUT:/v2.1/cloud/thing/group/{group_id}/devices |
创建群组 | POST:/v2.1/cloud/thing/group |
获取设备所在群组 | GET:/v2.1/cloud/thing/group/device/{device_id} |
查询群组任务进度 | GET:/v2.1/cloud/thing/group/task/{group_id}/{task_id} |
查询群组状态 | GET:/v2.1/cloud/thing/group/{group_id}/status-set |
删除设备 | DELETE:/v2.1/cloud/thing/group/{group_id}/devices |
删除群组 | DELETE:/v2.1/cloud/thing/group/{group_id} |
查询群组设备 | GET:/v2.1/cloud/thing/group/{group_id}/devices |
修改群组信息 | PUT:/v2.1/cloud/thing/group/{group_id} |
下发群组属性 | POST:/v2.1/cloud/thing/group/{group_id}/properties |
查询群组详情 | GET:/v2.1/cloud/thing/group/{group_id} |
文本转语音设备播报
API名称 | 接口地址 |
设备 TTS 下发 | POST:/v1.0/aispeech/voice/push |
周届旁路或恢复管理
API名称 | 接口地址 |
旁路/恢复 | POST:/v1.0/intrusion/{device_id}/actions/by-pass |
断路器告警阈值管理
API名称 | 接口地址 |
设置过压保护值 | POST:/v1.0/electric-energy/{device_id}/actions/voltage-over |
设置限定功率 | POST:/v1.0/electric-energy/{device_id}/actions/power-limit |
设置限定电流 | POST:/v1.0/electric-energy/{device_id}/actions/current-limit |
设置漏电预警值 | POST:/v1.0/electric-energy/{device_id}/actions/leak-warn-value |
设置漏电动作值 | POST:/v1.0/electric-energy/{device_id}/actions/leak-action-value |
设置电量预警值 | POST:/v1.0/electric-energy/{device_id}/actions/electric-warn |
设置欠压保护值 | POST:/v1.0/electric-energy/{device_id}/actions/voltage-under |
设置过温保护值 | POST:/v1.0/electric-energy/{device_id}/actions/temp-over |
用电安全
API名称 | 接口地址 |
查询用电设备用电安全规则 | GET:/v1.0/iot-03/power-devices/{device_id}/safety-rules |
设置用电设备的用电安全规则 | POST:/v1.0/iot-03/power-devices/{device_id}/safety-rules |
查询用电设备支持的用电安全规则 | GET:/v1.0/iot-03/power-devices/{device_id}/support-safety-rules |
站内消息管理管理
API名称 | 接口地址 |
查询消息 | GET:/v1.0/sdf/notifications/messages |
删除消息 | DELETE:/v1.0/sdf/notifications/messages |
新增通知消息 | POST:/v1.0/sdf/notifications/messages |
标记消息为已读或未读 | PUT:/v1.0/sdf/notifications/messages/actions-read |
红外智能匹配
API名称 | 接口地址 |
智能匹配获取 token | POST:/v2.0/infrareds/{infrared_id}/matching-remotes/token |
根据 token 获取匹配结果 | GET:/v2.0/infrareds/{infrared_id}/matching-remotes |
地理位置服务
API名称 | 接口地址 |
逆向地址解析 | GET:/v1.0/iot-03/geocode-cities/latitude-longitude |
正向地址解析 | GET:/v1.0/iot-03/geocode-cities/address |
获取 IP 定位 V1.1 | GET:/v1.1/iot-03/locations/ip |
多语言管理
API名称 | 接口地址 |
获取多语言列表 | GET:/v1.0/iot-03/app-contents/lang/infos |
获取设备日志
API名称 | 接口地址 |
查询设备状态上报日志 | GET:/v1.0/iot-03/devices/{device_id}/report-logs |
获取设备事件日志 | GET:/v1.0/iot-03/devices/{device_id}/logs |
策略管理
API名称 | 接口地址 |
创建策略 | POST:/v2.0/cloud/iam/policy |
删除策略 | DELETE:/v2.0/cloud/iam/policy/{policy_id} |
修改策略信息 | PUT:/v2.0/cloud/iam/policy/{policy_id} |
查询策略列表 | GET:/v2.0/cloud/iam/policy/list |
查询策略可用 action 列表 | GET:/v2.0/cloud/iam/policy/action |
红外学习功能
API名称 | 接口地址 |
更新遥控器学习码 | PUT:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/learning-codes |
保存遥控器学习码 | POST:/v2.0/infrareds/{infrared_id}/learning-codes |
下发学习码 | POST:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/learning-codes |
获取遥控器的学习码 | GET:/v2.0/infrareds/{infrared_id}/remotes/{remote_id}/learning-codes |
切换设备学习状态 | PUT:/v2.0/infrareds/{infrared_id}/learning-state |
获取网关接收到的遥控码 | GET:/v2.0/infrareds/{infrared_id}/learning-codes |
删除学习码 | DELETE:/v2.0/infrareds/{infrared_id}/learning-codes/{learn_id} |
获取通用按键信息 | GET:/v2.0/infrareds/{category_id}/base-key |
Banner管理
API名称 | 接口地址 |
删除 Banner | DELETE:/v1.0/iot-03/app-contents/banners/{banner_id} |
下架 Banner | POST:/v1.0/iot-03/app-contents/banners/{banner_id}/actions/unshelve |
分页查询 Banner 信息 | GET:/v1.0/iot-03/app-contents/banners |
创建 Banner | POST:/v1.0/iot-03/app-contents/banners |
更新 Banner | PUT:/v1.0/iot-03/app-contents/banners/{banner_id} |
发布 Banner | POST:/v1.0/iot-03/app-contents/banners/{banner_id}/actions/publish |
实时位置
API名称 | 接口地址 |
批量查询设备实时位置 | GET:/v2.0/iot-01/tracks/location |
权限规则管理
API名称 | 接口地址 |
修改门禁规则 | PUT:/v1.0/iot-02/access-controls/{access_control_id} |
新增门禁规则 | POST:/v1.0/iot-02/access-controls |
删除门禁规则 | DELETE:/v1.0/iot-02/access-controls/{access_control_id} |
国家码查询
API名称 | 接口地址 |
获取国家码列表 | GET:/v3.0/iot-03/all-countries |
电子地理围栏
API名称 | 接口地址 |
添加围栏监控对象 | POST:/v2.0/iot-01/fences/{fence_id}/entity |
创建多边形围栏 | POST:/v2.0/iot-01/fences/polygon |
修改多边形围栏 | PUT:/v2.0/iot-01/fences/polygon/{fence_id} |
查询围栏监控对象 | GET:/v2.0/iot-01/fences/{fence_id}/entity |
查询所有围栏 | GET:/v2.0/iot-01/fences/list |
创建圆形围栏 | POST:/v2.0/iot-01/fences/circle |
开启关闭围栏 | PUT:/v2.0/iot-01/fences/{fence_id}/open |
批量查询私有围栏 | GET:/v2.0/iot-01/fences/private/batch |
批量保存圆形私有围栏 | POST:/v2.0/iot-01/fences/circle/private/batch |
修改圆形围栏 | PUT:/v2.0/iot-01/fences/circle/{fence_id} |
根据围栏 ID 查询围栏 | GET:/v2.0/iot-01/fences/batch |
批量保存多边形私有围栏 | POST:/v2.0/iot-01/fences/polygon/private/batch |
环境数据查询
API名称 | 接口地址 |
查询设备环境指标的实时数据 | GET:/v1.0/iot-03/assets/{asset_id}/devices/environment-status |
查询设备环境指标的统计数据 | GET:/v1.0/iot-03/assets/{asset_id}/devices/environment-statistics |
查询资产环境指标的实时数据 | GET:/v1.0/iot-03/assets/{asset_id}/environment-status |
查询资产环境指标的统计数据 | GET:/v1.0/iot-03/assets/{asset_id}/environment-statistics |
查询设备环境指标的告警数据 | GET:/v1.0/iot-03/assets/{asset_id}/devices/environment-alarms |
环境指标的统计数据 | GET:/v1.1/iot-03/environment-indicators/statistics |
周届主机布防撤防管理
API名称 | 接口地址 |
主机布/撤防 | POST:/v1.0/intrusion/{device_id}/actions/chan-action |
断路器开关管理
API名称 | 接口地址 |
设置使能开关 | POST:/v1.0/electric-energy/{device_id}/actions/hand-enable |
设置线路开关 | POST:/v1.0/electric-energy/{device_id}/actions/switch |
设备组管理
API名称 | 接口地址 |
获取群组设备任务详情 | GET:/v1.0/iot-03/device-groups/{group_id}/tasks |
内容管理
API名称 | 接口地址 |
编辑内容 | PUT:/v1.0/iot-03/app-contents/{content_id} |
置顶内容 | POST:/v1.0/iot-03/app-contents/actions/top |
取消置顶内容 | POST:/v1.0/iot-03/app-contents/actions/untop |
分页查询内容 | GET:/v1.0/iot-03/app-contents |
查询指定内容详情 | GET:/v1.0/iot-03/app-contents/{content_id} |
发布内容 | POST:/v1.0/iot-03/app-contents/actions/publish |
创建内容 | POST:/v1.0/iot-03/app-contents |
删除内容 | DELETE:/v1.0/iot-03/app-contents |
下线内容 | POST:/v1.0/iot-03/app-contents/actions/unshelve |