应用端 API 列表

最近更新时间：2023-07-06 10:01:13

我的收藏

本页目录：

简介
本文档为您介绍应用端 API 相关使用内容。
用户管理
相关接口
接口名称
备注
微信号注册登录
用于微信用户注册登录，获取开发平台的用户访问 AccessToken，首次调用时，自动为该微信号注册对应账号。
手机号注册用户
提供手机号码方式的用户注册。
随机发送手机短信
用于手机号注册、绑定、重置密码时，发送验证码。
邮箱账号注册用户
提供邮箱账号方式注册用户。
随机发送邮箱验证码
用于邮箱注册、绑定、重置密码和登录时，发送验证码。
手机号、邮箱账号登录
用于手机号码、邮箱账号登录，获取用户访问 AccessToken。
使用手机号重置密码
用于使用手机号重置密码。
使用邮箱重置密码
用于使用邮箱重置密码。
用户注销
用于用户退出登录态。
修改用户信息
用于修改用户信息。
配网管理
相关接口
接口名称
备注
生成 Wi-Fi 设备配网 Token
用于生成 Wi-Fi 配网任务的随机 Token。
查询配网 Token 状态
用于查询配网 Token 的当前状态。
用户绑定 Wi-Fi 设备
用于小程序或 App 用户绑定 Wi-Fi 类设备。
设备管理
相关接口
接口名称
备注
获取产品信息
获取产品信息。
用户删除设备
为用户提供删除设备的功能，删除后用户需要重新配网进行绑定。
获取用户绑定设备列表
用于获取用户已绑定设备列表。
获取设备当前状态
用于查询设备状态。
修改设备名称
用于修改设备名称。
获取设备详情
用于查询设备详情。
设备更换房间
设备更换房间。
配网绑定设备
用于小程序或 App 进行 Wi-Fi 设备配网绑定操作。
设备控制
相关接口
接口名称
备注
用户控制设备
用于用户对绑定的设备下发属性物模型数据，实现设备远程控制。
同步调用设备行为
用于用户向已成功绑定的设备同步下发行为物模型请求，实现设备远程控制。
异步调用设备行为
用于向用户所绑定的设备异步下发行为物模型请求，实现设备远程控制。
数据查询
相关接口
接口名称
备注
获取设备物模型数据
用于获取设备物模型数据，可用于【_sys_xp2p_info】的获取。
获取设备物模型历史数据
用于获取设备物模型历史数据。
获取设备的历史事件
用于获取设备的历史事件。
云存服务
接口名称
备注
拉取云存事件列表
用于获取云存时间列表。
拉取云存事件缩略图
用于拉取云存事件缩略图地址。
获取具有云存的日期
用于获取具有云存的日期。
获取某一天云存时间轴
用于获取某一天云存时间轴。
获取视频防盗链播放 URL
用于获取视频防盗链播放 URL。
拉取图片流数据
用于拉取图片流数据。
设备分享
接口名称
备注
App 端发送设备分享
用于发送设备分享邀请。
获取设备分享 Token
用于获取设备分享 Token。
获取设备分享 Token 信息
用于获取设备分享 Token 信息。
绑定用户分享的设备
用于绑定用户分享的设备。
查询用户分享设备列表
用于查询用户分享的设备列表。
删除用户分享的设备
用于删除用户分享的设备。
查询设备的用户列表
用于查询设备用户列表。
删除设备分享的用户
用于删除设备分享的用户。
家庭管理
接口名称
备注
创建家庭
用于创建家庭。
删除家庭
用于删除家庭。
修改家庭
用于修改家庭。
获取家庭列表
用于获取家庭列表。
获取家庭详情
用于获取家庭详情。
新建房间
用于新建房间。
修改房间
用于修改房间。
删除房间
用于删除房间。
获取房间列表
用于获取房间列表。
邀请家庭成员
用于向微信好友发送邀请加入家庭请求。
成员加入家庭
用于成员加入家庭。
删除家庭成员
用于管理员删除家庭成员。
成员退出家庭
用于成员主动退出某个家庭。
获取家庭成员列表
用于获取家庭成员列表。
App 端邀请家庭成员
用于发送家庭分享邀请。
固件升级
接口名称
备注
查询设备固件是否升级
用于查询设备固件升级信息。
确认固件升级任务
用于用户确认升级后，云端向设备发起固件升级请求。
查询设备固件升级状态
用于查询设备固件升级状态及进度。
长连接通信
接口名称
备注
注册监听
用于向 WS 服务端进行订阅，订阅成功后可以通过 ws.onmessage 的监听获取到 WS 服务端实时推送设备上下线状态及属性数据。
心跳
设备保活，通过该接口更新设备时间戳，保持设备监听状态，同时保持 WebSocket 连接。可以多次调用，推荐每60s调用一次。
设备状态推送
设备状态推送用于在小程序或 App 实时获取用户绑定设备的上下线状态、设备上报的属性与事件以及设备行为执行结果。需要成功调用注册设备监听接口，通过监听 WebSocket 的 OnMessage 获取设备状态与属性值的实时推送，若获取到的 event.data.push 为 true，则代表该条消息为设备状态变更的主动推送。
﻿

上一篇: 小程序应用端接入手册下一篇: 产品版本

接口名称	备注
微信号注册登录	用于微信用户注册登录，获取开发平台的用户访问 AccessToken，首次调用时，自动为该微信号注册对应账号。
手机号注册用户	提供手机号码方式的用户注册。
随机发送手机短信	用于手机号注册、绑定、重置密码时，发送验证码。
邮箱账号注册用户	提供邮箱账号方式注册用户。
随机发送邮箱验证码	用于邮箱注册、绑定、重置密码和登录时，发送验证码。
手机号、邮箱账号登录	用于手机号码、邮箱账号登录，获取用户访问 AccessToken。
使用手机号重置密码	用于使用手机号重置密码。
使用邮箱重置密码	用于使用邮箱重置密码。
用户注销	用于用户退出登录态。
修改用户信息	用于修改用户信息。

接口名称	备注
生成 Wi-Fi 设备配网 Token	用于生成 Wi-Fi 配网任务的随机 Token。
查询配网 Token 状态	用于查询配网 Token 的当前状态。
用户绑定 Wi-Fi 设备	用于小程序或 App 用户绑定 Wi-Fi 类设备。

接口名称	备注
获取产品信息	获取产品信息。
用户删除设备	为用户提供删除设备的功能，删除后用户需要重新配网进行绑定。
获取用户绑定设备列表	用于获取用户已绑定设备列表。
获取设备当前状态	用于查询设备状态。
修改设备名称	用于修改设备名称。
获取设备详情	用于查询设备详情。
设备更换房间	设备更换房间。
配网绑定设备	用于小程序或 App 进行 Wi-Fi 设备配网绑定操作。

接口名称	备注
用户控制设备	用于用户对绑定的设备下发属性物模型数据，实现设备远程控制。
同步调用设备行为	用于用户向已成功绑定的设备同步下发行为物模型请求，实现设备远程控制。
异步调用设备行为	用于向用户所绑定的设备异步下发行为物模型请求，实现设备远程控制。

接口名称	备注
获取设备物模型数据	用于获取设备物模型数据，可用于【_sys_xp2p_info】的获取。
获取设备物模型历史数据	用于获取设备物模型历史数据。
获取设备的历史事件	用于获取设备的历史事件。

接口名称	备注
拉取云存事件列表	用于获取云存时间列表。
拉取云存事件缩略图	用于拉取云存事件缩略图地址。
获取具有云存的日期	用于获取具有云存的日期。
获取某一天云存时间轴	用于获取某一天云存时间轴。
获取视频防盗链播放 URL	用于获取视频防盗链播放 URL。
拉取图片流数据	用于拉取图片流数据。

接口名称	备注
App 端发送设备分享	用于发送设备分享邀请。
获取设备分享 Token	用于获取设备分享 Token。
获取设备分享 Token 信息	用于获取设备分享 Token 信息。
绑定用户分享的设备	用于绑定用户分享的设备。
查询用户分享设备列表	用于查询用户分享的设备列表。
删除用户分享的设备	用于删除用户分享的设备。
查询设备的用户列表	用于查询设备用户列表。
删除设备分享的用户	用于删除设备分享的用户。

接口名称	备注
创建家庭	用于创建家庭。
删除家庭	用于删除家庭。
修改家庭	用于修改家庭。
获取家庭列表	用于获取家庭列表。
获取家庭详情	用于获取家庭详情。
新建房间	用于新建房间。
修改房间	用于修改房间。
删除房间	用于删除房间。
获取房间列表	用于获取房间列表。
邀请家庭成员	用于向微信好友发送邀请加入家庭请求。
成员加入家庭	用于成员加入家庭。
删除家庭成员	用于管理员删除家庭成员。
成员退出家庭	用于成员主动退出某个家庭。
获取家庭成员列表	用于获取家庭成员列表。
App 端邀请家庭成员	用于发送家庭分享邀请。

接口名称	备注
查询设备固件是否升级	用于查询设备固件升级信息。
确认固件升级任务	用于用户确认升级后，云端向设备发起固件升级请求。
查询设备固件升级状态	用于查询设备固件升级状态及进度。

接口名称	备注
注册监听	用于向 WS 服务端进行订阅，订阅成功后可以通过 ws.onmessage 的监听获取到 WS 服务端实时推送设备上下线状态及属性数据。
心跳	设备保活，通过该接口更新设备时间戳，保持设备监听状态，同时保持 WebSocket 连接。可以多次调用，推荐每60s调用一次。
设备状态推送	设备状态推送用于在小程序或 App 实时获取用户绑定设备的上下线状态、设备上报的属性与事件以及设备行为执行结果。需要成功调用注册设备监听接口，通过监听 WebSocket 的 OnMessage 获取设备状态与属性值的实时推送，若获取到的 event.data.push 为 true，则代表该条消息为设备状态变更的主动推送。