4.2 设备注册与绑定

本篇介绍设备如何在 JoyInside 平台完成注册与绑定。
接入前需先理清一个关键点: 平时说的「设备ID」通常指硬件SN,而平台建连、鉴权实际使用的是botId——本文会带您弄清 appId、botId、SN 三层身份的映射关系。

三层身份映射

身份	是什么	哪里拿	谁用
appId	应用唯一标识,一个应用对应一个产品型号,定义交互功能(技能/指令/人设/音色)	应用管理页,应用卡片下方	注册设备、调用 API
botId	设备在平台的唯一标识,注册设备后生成,WS 建联必需	设备管理页,设备「ID」列	WS 建联参数、getToken 参数
sn / deviceId	厂商为每个产品分配的序列号,硬件物理标识	厂商自行分配(建议作为 deviceId)	注册设备时传入

典型流程:

设备注册

注册三要素

字段	必选	说明
vendorId	是	厂商唯一标识
appId	是	应用唯一标识
deviceId	是	设备唯一标识,厂商保证唯一,建议用设备 SN
type	是	`APP_ROBOT`(测试设备) / `PHYSICAL_ROBOT`(生产设备)
name	是	设备名称
deviceModel	否	设备型号,非标准参数, 在运营平台创建且与IOT指令技能有关
timbreId	否	音色 id
desc	否	描述
resourceAuthedList	否	JoyInside支持播放自有以及三方的音乐、故事资源。通过该字段指定设备后续进行资源检索、播放及计费所使用的资源提供方。若不传该字段，则默认使用 JoyInside 自有资源。注意：如需使用该字段，请提前联系JoyInside产品运营完成相关配置。取值：WANG_YI_CLOUD：网易云音乐

注册接口:

项	值
URL	`https://api.joyinside.com/device/register`
方式	POST
Header	`Authorization: Bearer ${accessToken}`

注册方式:

测试阶段:运营平台设备管理处手动添加单个虚拟设备
正式接入:每台设备开机配网后通过 API 单设备注册(type=PHYSICAL_ROBOT)

注册示例(Python,点击展开)

python

headers = {"Authorization": "Bearer " + token}
params = {
    "vendorId": "企业ID",
    "appId": "应用ID",
    "deviceId": "建议用SN编码",
    "type": "APP_ROBOT",  # 测试设备
    "name": "测试"
}
res = requests.post("https://api.joyinside.com/device/register", headers=headers, json=params)
# 返回 data 字段即为 botId

返回示例(点击展开)

json

{
  "state": "SUCCESS",
  "code": "0000",
  "result": "创建成功",
  "data": "0428f41d89fc436b8d63a529cf7141a7"  // ← 这就是 botId
}

特别注意：一个deviceId只能注册一个设备，如果重复注册，则返回已经注册的botId，不会生成新的botId，不会更新第一次注册的信息

设备绑定角色(AI 伙伴)

一台设备(botId)可以绑定一个 AI 角色(系统角色或自定义角色),绑定后该设备的对话人设、音色、开场白等均以该角色为准。角色不通过 WS 建连参数传入,改用 HTTP 绑定接口。

操作	说明	接口
绑定角色	把 roleId 绑定到 botId	`/soulmate/role/botBindRole/save`
查询绑定	查 botId 当前绑定的角色	`/soulmate/role/botBindRole/get`

⚠ 旧方式 roleCode 建连参数不再推荐,新接入统一用绑定接口。 ⚠ 切换角色需重建 WebSocket 连接才能生效(见 10.6 音色/查询类)。绑定接口走 HTTP,通常由小程序或后台调用,不是设备端 WS 协议。系统角色 / 自定义角色列表查询、绑定接口完整字段见附录 A.4 AI 角色管理。

设备绑定用户(uid)

一台设备(botId)可以绑定一个用户(uid),绑定后该设备的对话归属到这个用户名下,产生长期记忆与聊天报告。uid 是用户唯一标识(如京东用户 pin,也可由厂商自行维护),详细规则(≤128 字节、必须真实)见 4.3 重要参数介绍。

操作	说明	接口
绑定用户	把 uid 绑定到 botId	`/device/bindUser`
查询绑定	查 botId 当前绑定的 uid	`/device/queryBotBind`
解绑用户	解除 uid 与 botId 的绑定	`/device/unbindUser`

绑定/解绑接口走 HTTP,通常由小程序或后台调用,不是设备端 WS 协议。接口明细见附录 A.6 用户绑定。

uid 在 WS 建联时的传递

绑定后,设备端 WS 建联与上行事件里也可带 uid(非必传,但传了就必须一致):

可以不传:不传 uid 时,服务端按匿名会话处理
传了就必须一直传:同一设备要么始终传 uid,要么始终不传,禁止值与 null 混着来
禁止所有设备用固定值:如所有设备都传 123456,会导致不同用户的记忆混在一起

如接入有声书技能,无论是否关联用户场景,ws 建连以及有声书的全部上行事件,uid 参数要么全部增加,要么全部不增加,且 uid 必须保持一致。
⚠ uid 长度不超过 128 字节,且必须真实。完整规则见 4.3 重要参数介绍。

互踢机制

同一个 botId 同时建立两个 WebSocket 连接时,后建的连接会踢掉先建的连接,先建的连接收到 REPEAT_CLIENT_SESSION 事件后被关闭。

为什么这么设计:一个 botId 代表一台设备,同一台设备不应同时有两个活跃对话通道(否则上下文、打断、TTS 播放都会混乱)。

互踢时序

常见触发场景

场景	后果
调试时开两个 Demo 实例用同一 botId	互相踢,对话中断
生产设备重连时未等旧连接释放就建新连接	旧连接被踢
同一台设备多处入口同时建联	后建的踢先建的
客户端多线程导致的重复建连	互相踢

排查:设备端有REPEAT_CLIENT_SESSION 事件出现,说明同一 botId 有多处连接。排查设备是否重复建联,或是否有调试实例在跑。

下一步

核心参数理解:4.3 重要参数介绍
理解语音对话协议:4.4 WebSocket语音通道
排查互踢问题:10.1 建联失败类

4.2 设备注册与绑定 ​

三层身份映射 ​

设备注册 ​

注册三要素 ​

设备绑定角色(AI 伙伴) ​

设备绑定用户(uid) ​

uid 在 WS 建联时的传递 ​

互踢机制 ​

互踢时序 ​

常见触发场景 ​

下一步 ​