芯步智能语音壁挂音箱(30W)提供完整的HTTP API接口,支持远程音量调节、语音播报等控制功能。以下方案涵盖接口协议、签名算法、具体实现步骤及常见问题处理。
1. 概述
1.1 产品简介
芯步智能语音壁挂音箱30W(型号:UNI-YY-YX-BG-30W)是一款支持WiFi联网的智能语音设备。该产品开放标准的HTTP API接口,允许开发者通过任何支持HTTP请求的编程语言(如Java、Python、PHP、Go等)或应用(如Web、APP、小程序、SaaS系统)进行远程控制。
1.2 核心功能
远程音量调节:支持0-9级共10个档位的音量远程实时调整。
文本语音播报:直接推送文本内容,设备端完成语音合成(TTS)并播报,无需预录音。
多参数可调:除音量外,还可远程控制音色(男/女)、语速(0-9)、语调(0-9)。
即装即用:设备通过WiFi 2.4GHz直连网络,无需额外网关,支持5组WiFi自动切换。
1.3 技术优势
开放性:接口协议公开,支持私有化部署和局域网通信。
低延迟:从命令下发到设备响应约80-300ms。
跨平台:接口统一,适用于OA、ERP、SaaS、低代码等各类软件项目。
2. 接口对接原理
2.1 接口架构
芯步的云平台作为设备与第三方系统的中介。您的业务系统通过调用平台提供的 设备控制接口(/device/control/),将指令下发至云端,云端再实时转发给目标音箱。
2.2 核心请求地址
POST https://api.thingboot.com/{AppID}/device/control/?sign={sign}&ts={ts}| 参数 | 位置 | 说明 |
|---|---|---|
| AppID | URL Path | 您的应用ID,在芯步控制台“”中获取。 |
| ts | URL Query | 当前Unix时间戳(秒),用于签名校验。 |
| sign | URL Query | 接口签名,用于身份验证,详见2.3节签名算法。 |
2.3 签名算法
签名用于确保请求的合法性和安全性,其生成规则如下:
假设您的
AppSecret为ABC123,当前时间戳ts为1715678900。计算
md5_1 = md5(AppSecret)。计算
sign = md5(md5_1 + ts)(将第一步结果与时间戳拼接后进行第二次MD5)。
示例:
原始AppSecret: ABC123 第一步 MD5: MD5(ABC123) = e99a18c428cb38d5f260853678922e03 待签名字符串: e99a18c428cb38d5f260853678922e031715678900 最终签名: MD5(e99a18c428cb38d5f260853678922e031715678900) = 8d5a498a74bef84d45b...
注意:AppSecret 严禁在客户端代码中硬编码,请一定要在您的后端服务中计算签名。
3. 远程音量调节实现
3.1 关键指令:音量调节
要调节音量,需向音箱下发包含 volume 字段的JSON指令。
请求Body结构:
参数说明:
device:字符串,必填。目标设备的唯一ID(可在控制台或通过设备列表接口获取)。支持批量控制,多个ID用英文逗号隔开,如
"1001,1002"。order.volume:字符串,必填。音量级别,取值范围为
"0"至"9"。"0":静音"1"~"8":逐步增大"9":最大音量
3.2 代码实现示例
3.2.1 Python 实现
参考代码结构自
3.2.2 Java 实现
参考代码结构自
3.2.3 cURL 命令
4. 其他常用控制指令
除了音量调节,该音箱还支持以下丰富的控制能力,您可类似地在 order JSON对象中指定参数
| 功能 | 指令Key | 取值范围 | 示例 order |
|---|---|---|---|
| 音色选择 | voice | "0"(女声), "1"(男声) | {"voice":"1"} |
| 语速调节 | speed | "0" ~ "9" | {"speed":"6"} |
| 语调调节 | tone | "0" ~ "9" | {"tone":"5"} |
| 文本播报 | play:gbk:16 | 任意文本字符串 | {"play:gbk:16":"现在时刻 下午两点整"} |
| 停止播报 | stop | "0"(停止当前), "1"(全部停止) | {"stop":"1"} |
| 播放内置提示音 | message | "1" ~ "5" | {"message":"1"} |
| 播放内置告警音 | alert | "1" ~ "5" | {"alert":"3"} |
5. 对接流程和需要注意的点
5.1 对接步骤
注册与登录:访问芯步官网,注册开发者账号。
获取凭证:登录后,在控制台的“开发设置”中获取
AppID和AppSecret。设备配网:按照产品手册将30W音箱连接至WiFi,记录其在平台生成的
设备ID。接口调试:使用Postman或cURL,按照上述说明调用音量调节接口进行测试。
系统集成:将接口调用逻辑集成到您的业务后端(如收银系统、工单系统、安防平台等)。
5.2 关键注意事项
网络环境:音箱仅支持 2.4GHz WiFi,不支持5GHz。请确保网络环境覆盖良好。
防火墙策略:如果您的服务器有防火墙,需开放对
api.thingboot.com的HTTPS(443端口)访问。如果选择私有化部署,需将API服务部署在局域网内。错误处理:接口调用后请一定要判断返回码。常见的错误如签名错误(sign invalid)、设备不在线(device offline)等,需针对性处理。
音量调整策略:在公共场合(如商场、食堂),避免直接调至最大音量(9级),可采用渐进式调整,如
volume: "5" -> "7" -> "9",以避免突兀。命令冲突:如果同一设备短时间内收到多条指令(如播放和音量调节),云端会按顺序执行。在播放前先下发音量设置指令,确保播报效果。