1、云音箱 ID (SPEAKERID)：

云音箱机身上帖有云音箱的 ID 码，每台云音箱拥有唯一永久 ID，SPEAKERID由字母、数字组成， 在生产过程中写入云音箱，云音箱出厂后不会再改变。

2、TOKEN:

厂商分配给每个代理商的唯一 token, 通过安全渠道提供给代理商，使得代理商对它购买的SPEAKERID 有操作权限。若报文中提交的token错误或token无权操作报文中提交的SPEAKERID，服务器会返回错误。

token是一个长度为12字节的字符串，包含数字和英文字母，区分大小写。 基于安全角度，token可能会不定期更新，厂商会提前通知代理商。

例如：厂商给某个代理的 token 是 100286158508，并向其销售了 speakerid 为 1000 到 1999 的一千个云音箱，则该代理用 100286158508 这个 token 能且仅能 操作 speakerid 为 1000 到 1999 的云音箱。其它代理由于不知道这个 token，无法操作这一千个云音箱。

3、、用户ID (USERID)：

代理商会给每位云音箱使用人分配一个唯一的帐号，这个帐号会有相关联的支付服务商下商户账号，用来接收相应的收款消息。一个用户帐号可以绑定多个云音箱，目前暂定单个用户最多可以绑定的有效喇叭数为 300 个。 这个 USERID 是字符串，长度最大 255 字节，可使用英文字母和数字和下划线， 区分大小写。 例如: 某个饭店商户在代理商注册了个帐户叫“张三”，为避免重复，并且为了使用字母和数字，代理商分配给他的帐号名为”zhang3_2017”，于是代理商可以 用”zhang3_2017”来绑定例如 ID 为 1090 的云音箱，并且代理商用”zhang3_2017”来 提交支付消息，服务器会将此支付消息推送到 ID 为 1090 的云音箱。

1）接口地址：https://speaker.17laimai.cn

2）协议和端口号： HTTP 80，HTTPS 443

3）请求方式：GET 或 POST

4）提交数据格式：

id=SPEAKERID&uid=USERID&price=PRICevalUE&token=TOKEN

5）返回数据格式：JSON

6）网关返回码

本文档接口表格中各列意义说明：

·“参数”列: 指提交 GET 或 POST 方式时带的参数名称字符串，编程时使用

·“意义”列: 解释参数名称的意义，仅为了利于记忆，不是编程时的字符串

·“必须”列：带*号表示此参数是必须的，不能缺少

基础接口为云音箱正常工作的必备接口，代理商必须实现

2.1 云音箱绑定或解绑

最终用户在手机专用客户端（或网页）上输入（或扫描）云收款 ID，提交到云音箱服务器，服务器的数据表将此用户帐号与云音箱 ID 作关联。出于安全考虑， 代理商在将账号与云音箱 ID 作绑定前，要确认操作人是该云音箱的拥有者。 比如，用户在申请绑定时，代理商提交一条随机支付消息到该云音箱，用户收听播报价格后输入给代理商，代理商确认用户输入的数字与提交的数字相同，即可验证。原理类似于手机验证码。出于安全考虑，已经绑定过帐号的云音箱 ID 不允许更改绑定到其它帐号， 除非原帐户人申请解绑此云音箱。

1）URL: https://speaker.17laimai.cn/bind.php

2）请求参数：

例子1：

https://speaker.17laimai.cn/bind.php?id=335&m=1&uid=AF337099&token=123456789012

表示申请将用户 ID AF337099 与云音箱 335 绑定

例子2：

https://speaker.17laimai.cn/bind.php?id=335&m=0&uid=AF337099&token=123456789012

表示申请将用户 ID AF337099 与云音箱 335 解除绑定

3) 返回参数：

2.2 支付语音播报

将支付结果提交到云音箱服务器、服务器将支付结果推送给云音箱，云音箱接收后播报。

1）URL：https://speaker.17laimai.cn/add.php

2）请求参数：

备注：

云音箱收到支付结果后，播放内容为：支付类型 + 金额 + 后缀，后缀和前缀可以通过“更改语音信息”接口修改

例子：

https://speaker.17laimai.cn/add.php?id=335&price=3879&token=123456789012

表示代理商的 token 为 123456789012，向 id 为 335 的云音箱提交支付金额为 38.79 元的支付结果

3) 返回参数：

代理商可根据情况实现可选接口，可选接口不影响云音箱的正常使用。

3.1 通知语音播报

将通知消息提交到云音箱服务器、服务器将支付结果推送给云音箱，云音箱接收后播报。

备注：该接口为2G版音箱专用接口，通过2G版音箱自带的TTS播放，WIFI版音箱不可用

1）URL：https://speaker.17laimai.cn/notify.php

2）请求参数：

例子1： https://speaker.17laimai.cn/notify.php?id=10000091&token=123456789012&message=你的验证码为6688

ID为10000091的云音箱播报语音 “你的验证码为6688”

例子1： https://speaker.17laimai.cn/notify.php?id=10000091&token=123456789012&message=支付宝到账120元,实收110元,星POS为你优惠10元

ID为10000091的云音箱播报语音 “支付宝到账120元,实收110元,星POS为你优惠10元”

3) 返回参数：

3.2 更改语音信息

更改开机语音，自定义播报前缀，播报后缀。

1）URL：https://speaker.17laimai.cn/modify_bootvoice.php

2）请求参数：

例子： https://speaker.17laimai.cn/modify_bootvoice.php?id=10000091&token=123456789012&sound=欢迎光临&type=0

表示将云喇叭 ID 10000091 开机语音设置为 “欢迎光临”

3) 返回参数：

3.3 云音箱绑定状态查询

查询某些（或某个） 云音箱 ID， 或者某个用户帐号的绑定情况。

1) URL： https://speaker.17laimai.cn/list_bind.php

2) 请求参数：

例子1：

https://speaker.17laimai.cn/list_bind.php?ids=1000&ide=1030&uid=wangxi2017&token=123456789012

表示查询云音箱范围为 1000 到 1030 并且用户 ID 为 wangxi2017 的绑定记录

例子2:

https://speaker.17laimai.cn/list_bind.php?fm=0&id=1000&token=123456789012

表示查询云音箱 ID 1000 的绑定记录

3) 返回参数：

detail 说明：

1)结果表中的 userid, 前 4 位为代理商 ID (AGENCYID)，第 6 位开始才是真实用户 ID。（这是为了保证不同代理商用相同用户 ID 时，用户 ID 在表中是唯一的）例如: userid 1000_wangxi2007, 其真实用户 id 为 wangxi2007结果表中 real_userid 是真实用户 id

2)结果表中 active, 值 1 表示绑定是有效状态，值 0 表示以前绑定过但是后来已经解绑了。

3.4 查询云音响操作权限

代理商查询其对哪些喇叭有操作权

1）URL：https://speaker.17laimai.cn/list_speakeragency.php

2）请求参数：

例子1：

https://speaker.17laimai.cn/list_speakeragency.php?ids=1000&ide=1500token=123456789012

查询ID范围从1000 到 1500 云音箱是否有权限

例子2:

https://speaker.17laimai.cn/list_bind.php?fm=0&id=1000&token=123456789012

表示查询云音箱 ID 1000 是否有权限

3) 返回参数：

detail 说明：

{"total_count":1,"list_count":1,"records":{"0":{"ID":"649138","datetime":"2017-11-2820:37:57","speakerid":"1432","agencyid":"1004","active":"1","descs":null}}}

1) 结果表中的 speakerid, 即表示该代理商有权限的喇叭。

2)结果表中 active, 值 1 表示是有效状态，值 0 表示以前分配过但是后来已经被工厂删除权限了。

3.5 查询第一条未播放语音

代理商向服务器提交支付消息后，假如云音箱未取走这些支付消息，将会按时间先后存在服务器虚拟队列中。 代理商可用这个接口查询这个队列中最早的一条未被取走的支付消息。例如，代理商向服务器提交云音箱 ID 为 335 的支付消息，先后四次提交分别为 1.35元， 3.77 元， 6.78 元， 4.66 元。而云音箱取走了 1.35 元这条消息。那么代理商用这个接口查询的结果是 3.77 元。等到云音箱又先后取走了 3.77 元、 6.78 元这两条消息，那么这个接口的查询结果将为 4.66 元。如果要查询详细支付消息历史，请使用后文的支付消息历史查询接口。同时，这个接口也可以查询当前音量值设置值，音量值是最后一次提交的设置值，与是否被云音箱取走无关。

1）URL：https://speaker.17laimai.cn/get_last.php

2）请求参数:

例子：

?id=10000091&token=123456789012

查询 ID 为 3998 的云音箱的支付消息和音量。

3) 返回参数：

detail 说明： 若无错误，并且此 ID 有新支付消息，服务器应该回复如下文本字符串：{"price":支付金额,"volume":音量,"price_type":支付类型}其中:支付金额: 一个表示整数的字符串，单位为分， 范围为 1 至 2147483647，即 1 分到 2 千多万。音量: 一个表示整数的字符串，范围为 0-100。（出于用户体验考虑，建议只回复40-100 的值，否则音量太小可能会听不清）金额和音量之间的分隔号是半角英文逗号”,”例如： {"price":3877,"volume":80,"price_type":0 } 表示支付金额 38.77 元，支付类型为通用类， 当前音量为 80%，。2. 若无错误，但此 ID 没有新支付消息，服务器应该回复如下文本字符串：{"price":0,"volume":音量,"price_type":0}例如: {"price":0,"volume":70,"price_type":0} 表示未有新支付消息，当前音量为 70%

3.6 查询历史支付消息

查询提交过的历史支付结果消息。

1）URL：https://speaker.17laimai.cn/list.php

2）请求参数

例子：

https://speaker.17laimai.cn/list.php?ids=335&ide=338&st=20170927000000&et=20170927235959&fm=1&p=0&token=123456789012

查询喇叭 ID 为 335,336,337,338，在 2017-09-27 当天的记录， 开头 200 条， 返回纯文本格式

3) 返回参数：

    以上就是本篇文章【收款云音箱云喇叭API开发接口文档（2020-4-20）】的全部内容了，欢迎阅览 ！ 文章地址：http://dfvalve.xrbh.cn/news/1593.html 
     资讯      企业新闻      行情      企业黄页      同类资讯      首页      网站地图      返回首页 迅博思语资讯移动站 http://keant.xrbh.cn/ , 查看更多