帮你快速理解、总结文档立即下载
文档中心>物联网开发平台>客户端 API>应用端>小程序>TXIoTDeviceManager

TXIoTDeviceManager

最近更新时间：2026-09-20 16:47:03
我的收藏

本页目录：

概述

TXIoTDeviceManager 负责设备的绑定/解绑、房间归属、设备分享、指令下发、属性查询与别名修改、设备 VoIP 通知等。TXIoTDeviceManager 通过 TXIoTEngine.getDeviceManager 获取实例，需在登录成功后调用。
说明：
设备必须先绑定到家庭后才能进行后续操作。绑定方式有两种：
1. 通过 bindDevice 使用设备绑定签名直接绑定。
2. 通过 bindDeviceSharedWithMe 接受他人分享的设备。

方法列表

方法签名
描述
绑定设备到家庭。
从家庭解绑设备。
将设备添加到房间。
获取设备 VoIP 授权票据。
注册设备 VoIP 通知。
注销设备 VoIP 通知。
获取设备 VoIP 授权用户列表。
将设备从房间移除。
获取家庭设备列表（支持分页）。
创建设备分享令牌。
绑定别人分享给我的设备。
取消绑定别人分享给我的设备。
获取设备已分享的用户列表。
移除设备已分享用户。
获取别人分享给我的设备列表（支持分页）。
向设备发送指令。
查询设备属性。
修改设备别名。

bindDevice

bindDevice
bindDevice
(String familyId, String deviceBindSignature)
绑定设备到家庭
参数
描述
familyId
String；家庭 ID。
deviceBindSignature
String；设备绑定签名。
返回值
描述
操作结果。

unbindDevice

unbindDevice
unbindDevice
(String familyId, TXIoTDeviceId deviceId)
从家庭解绑设备
参数
描述
familyId
String；家庭 ID。
deviceId
TXIoTDeviceId；设备标识（含 productId / deviceName）。
返回值
描述
Promise<Void>
操作结果。

addDeviceToRoom

addDeviceToRoom
addDeviceToRoom
(TXIoTDeviceId deviceId, String familyId, String roomId)
将设备添加到房间
参数
描述
deviceId
TXIoTDeviceId；设备标识（含 productId / deviceName）。
familyId
String；家庭 ID。
roomId
String；房间 ID。
返回值
描述
Promise<Void>
操作结果。

requestVoIPSnTicket

requestVoIPSnTicket
requestVoIPSnTicket
(TXIoTDeviceId deviceId, String modelId, String appId)
获取设备 VoIP 授权票据
返回的 sn/snTicket 供小程序自行调用 wx.requestDeviceVoIP 完成微信侧授权弹窗（插件上下文无此 API）。
参数
描述
deviceId
TXIoTDeviceId；设备标识（含 productId / deviceName）。
modelId
String；微信公众平台「设备接入」分配的 model_id。
appId
String；小程序 AppID。
返回值
描述
Promise<Object>
包含 sn（设备序列号）与 snTicket（VoIP 授权票据）字段。

registerVoIPNotificationForDevice

registerVoIPNotificationForDevice
registerVoIPNotificationForDevice
(TXIoTDeviceId deviceId, String modelId, String appId, String wxOpenId)
注册设备 VoIP 通知
调用前需先通过 requestVoIPSnTicket 获取票据，并调用 wx.requestDeviceVoIP 完成微信侧授权弹窗。
参数
描述
deviceId
TXIoTDeviceId；设备标识（含 productId / deviceName）。
modelId
String；微信公众平台「设备接入」分配的 model_id。
appId
String；小程序 AppID。
wxOpenId
String；当前用户微信 OpenID。
返回值
描述
Promise<Void>
操作结果。

unregisterVoIPNotificationForDevice

unregisterVoIPNotificationForDevice
unregisterVoIPNotificationForDevice
(TXIoTDeviceId deviceId, String modelId, String appId, String wxOpenId)
注销设备 VoIP 通知
参数
描述
deviceId
TXIoTDeviceId；设备标识（含 productId / deviceName）。
modelId
String；微信公众平台「设备接入」分配的 model_id。
appId
String；小程序 AppID。
wxOpenId
String；当前用户微信 OpenID。
返回值
描述
Promise<Void>
操作结果。

getAuthorizedVoIPUserList

getAuthorizedVoIPUserList
getAuthorizedVoIPUserList
(TXIoTDeviceId deviceId)
获取设备 VoIP 授权用户列表
参数
描述
deviceId
TXIoTDeviceId；设备标识（含 productId / deviceName）。
返回值
描述
Promise<List<String>>
已授权用户的微信 OpenID 列表。

removeDeviceFromRoom

removeDeviceFromRoom
removeDeviceFromRoom
(TXIoTDeviceId deviceId, String familyId)
将设备从房间移除
参数
描述
deviceId
TXIoTDeviceId；设备标识（含 productId / deviceName）。
familyId
String；家庭 ID。
返回值
描述
Promise<Void>
操作结果。

getDeviceList

getDeviceList
getDeviceList
(String familyId, String nextPageToken)
获取家庭设备列表（支持分页）
参数
描述
familyId
String；家庭 ID。
nextPageToken
String；分页令牌，首次传空字符串。
返回值
描述
Promise<TXIoTPageResult<TXIoTDeviceInfo>>
设备列表。

createDeviceSharingToken

createDeviceSharingToken
createDeviceSharingToken
(String family_id, TXIoTDeviceId deviceId)
创建设备分享令牌
参数
描述
family_id
String；家庭 ID。
deviceId
TXIoTDeviceId；设备标识（含 productId / deviceName）。
返回值
描述
Promise<String>
分享令牌。

bindDeviceSharedWithMe

bindDeviceSharedWithMe
bindDeviceSharedWithMe
(TXIoTDeviceId deviceId, String shareToken)
绑定别人分享给我的设备
参数
描述
deviceId
TXIoTDeviceId；设备标识（含 productId / deviceName）。
shareToken
String；分享令牌。
返回值
描述
Promise<Void>
操作结果。

unbindDeviceSharedWithMe

unbindDeviceSharedWithMe
unbindDeviceSharedWithMe
(TXIoTDeviceId deviceId)
取消绑定别人分享给我的设备
参数
描述
deviceId
TXIoTDeviceId；设备标识（含 productId / deviceName）。
返回值
描述
Promise<Void>
操作结果。

getDeviceSharedUsers

getDeviceSharedUsers
getDeviceSharedUsers
(TXIoTDeviceId deviceId)
获取设备已分享的用户列表
参数
描述
deviceId
TXIoTDeviceId；设备标识（含 productId / deviceName）。
返回值
描述
Promise<List<TXIoTUserInfo>>
用户列表。

removeDeviceSharedUser

removeDeviceSharedUser
removeDeviceSharedUser
(TXIoTDeviceId deviceId, String userId)
移除设备已分享用户
参数
描述
deviceId
TXIoTDeviceId；设备标识（含 productId / deviceName）。
userId
String；用户 ID。
返回值
描述
Promise<Void>
操作结果。

getDeviceListSharedWithMe

getDeviceListSharedWithMe
getDeviceListSharedWithMe
(String nextPageToken)
获取别人分享给我的设备列表（支持分页）
参数
描述
nextPageToken
String；分页令牌，首次传空字符串。
返回值
描述
Promise<TXIoTPageResult<TXIoTDeviceInfo>>
设备列表。

sendCommand

sendCommand
sendCommand
(TXIoTDeviceId deviceId, String jsonData)
向设备发送指令
参数
描述
deviceId
TXIoTDeviceId；设备标识（含 productId / deviceName）。
jsonData
String；JSON 格式的指令数据。
返回值
描述
Promise<String>
发送的指令。

getProperties

getProperties
getProperties
(TXIoTDeviceId deviceId)
查询设备属性
参数
描述
deviceId
TXIoTDeviceId；设备标识（含 productId / deviceName）。
返回值
描述
Promise<String>
设备属性。

modifyAliasName

modifyAliasName
modifyAliasName
(TXIoTDeviceId deviceId, String aliasName)
修改设备别名
参数
描述
deviceId
TXIoTDeviceId；设备标识（含 productId / deviceName）。
aliasName
String；设备别名。
返回值
描述
Promise<Void>
操作结果。
中国站