云音箱服务对接指南

（流量版喇叭对接，可以只看3.1小节）

一、名词解释 (开发前必读)

1、云音箱 ID (SPEAKERID、sn)：喇叭标签上的SN码

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

2、TOKEN (接口凭证)：必须

程序调用接口控制音箱播报的凭证，预先联系客服申请分配，使得程序对该 SPEAKERID 有操控权限。只要设备授权给TOKEN，一个TOKEN可以控制无数个设备。

3、version（接口版本）：(非常重要)

由于喇叭硬件的变动，可能带来接口的变动，用此参数区分，要求开发者后台预留（1-9）个版本选项，喇叭机身的标签中，会注明对应的version

比如

型号	VERSION/接口版本	型号	VERSION/接口版本
210/310/330	1	402/404/502/504	3
204	2	901/902	9

二、接口

1、通讯协议（作为了解）

1）接口网关：

https://speaker.17laimai.cn

2）协议和端口号：

HTTP 80，HTTPS 443

3）请求方式：GET 或 POST (推荐使用POST,数据更安全)

4）提交数据格式：

id=SPEAKERID&uid=USERID&price=PRICEVALUE&token=TOKEN&version=1

5）返回数据格式：JSON

参数	类型	说明	必须
errcode	integer	返回码	*
errmsg	string	返回码描述	*
detail	string	返回的数据

6）网关返回码

0	成功
1	未知错误
2	SPEAKERID 不存在
3	SPEAKERID 已经被其它用户 ID 绑定
4	SPEAKERID 已经被同一用户 ID 绑定
5	SPEAKERID 未被任何用户 ID 绑定
6	未提供 SPEAKERID
8	此 token 无此 SPEAKERID 权限
9	无效的 token
17	重复的请求

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

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

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

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

2、基础接口

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

2.1 云音箱绑定或解绑（WIFI版必用，流量版选用）

注意：310、330使用add播报方法时，必须先调用绑定方法进行绑定，其它型号可以不绑定；另外notify方法，全部型号可以不调用绑定方法，流量版推荐notify方法。

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

2）请求参数：

参数	意义	说明	必须
id	SPEAKERID	指该云音箱标签上的的 SN/ID	*
m	METHOD	0 为解绑， 1 为绑定, 4 强制解绑（不需提供原 USERID）	*
uid	USERID	开发者自定义，保持在你自己的系统程序内唯一即可,如：商家手机号	*
token	TOKEN	代理商的 token, 预先通过安全渠道分配，使得代理商对该 SPEAKERID 有操作权限	*
version	接口版本	按各型号标注的VERSION版本，由用户配置时选择，预留1-9供选择	*
seq	SEQUENCY	用于通讯去重复的顺序号，范围为 [0,4294967295] ( 即 [0,0xFFFFFFFF])的整数。每次提交时请改变此值（比如按顺序加 1）。假如服务器在 200 秒（暂定值）内收到两个或多个 SEQUENCY 相同、并且提交的内容也相同的请求，则认为是重复提交，将忽略此请求，并返回错误码 17。此参数缺省时，服务器对此次请求不做去重检查，此次请求也不作为后续去重检查的比较依据。
descs	DESCRIPTION	代理商可以给此绑定请求提供一个描述字符串，最大 255 个字节。之后代理商用 “ 绑定状态查询接口”查询绑定消息时，可以看到此描述。此参数对云音箱或服务器工作状态没有影响。

例子1：

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

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

例子2：

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

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

3) 返回参数：

参数	类型	说明	必须
errcode	integer	返回码，参见网关返回码	*
errmsg	string	返回码描述	*
detail	string	返回的数据

2.2 支付语音播报（WIFI\流量版通用）

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

注意：310、330使用此方法时，必须先调用绑定方法进行绑定，notify方法不需要，流量版推荐notify方法。

1）URL：https://speaker.17laimai.cn/add.php（WIFI版、流量版通用播报接口）

2）请求参数：

参数	意义	解释		必须
id	SPEAKERID	指该云音箱标签上的的 SN/ID		*
uid	USERID	开发者自定义，保持在你自己的系统程序内唯一即可,如：商家手机号
price	PRICEVALUE	指支付金额值的字符串，单位为分，范围为 1 至 2147483647，即 1 分到 2 千多万。		*
pt	PRICE_TYPE	支付类型，此参数会让云音箱播放不同的提示语音一个[0,255]的整形值，目前定义如下：
pt	PRICE_TYPE	210WIFI版支持: 1 支付宝 2 微信支付 3 云支付 4 余额支付 5 微信储值 6 微信买单 7 银联刷卡 8 会员卡消费 9 会员卡充值 10 翼支付 11 退款 12 支付宝退款 13 微信退款 14 银行卡退款 15 银联退款 16 工行e支付 18 QQ钱包到账 19 京东支付 20 用户取消支付 22 西银惠支付	（901、902）WIFI版支持且仅支持以下前缀 1支付宝收款 2微信收款 3云闪付收款 8会员卡消费 9会员卡充值 10翼支付收款成功 11退款 12支付宝退款 13微信退款 19京东收款成功 20有用户取消订单	*
token	TOKEN	代理商的 token, 预先通过安全渠道分配，使得代理商对该 SPEAKERID 有操作权限		*
version	接口版本	按各型号标注的VERSION版本，由用户配置时选择，预留1-9供选择		*
vol	VOLUME	指音量设置值，范围为 0 到 100，代表从无音到最大声。
seq	SEQUENCY	用于通讯去重复的顺序号，范围为[0,4294967295] (即[0,0xFFFFFFFF])的整数。每次提交时请改变此值（比如按顺序加 1）。假如服务器在 200 秒（暂定值）内收到两个或多个SEQUENCY 相同、并且提交的内容也相同的请求，则认为是重复提交，服务器将忽略此提交，并返回错误码 17。此参数缺省时，服务器对此次请求不做去重检查，此次请求也不作为后续去重检查的比较依据。
trace_no	TRACE_ NUMBER	代理商用于追踪此支付消息的一个字符串，最大 63个字节，由代理商软件产生。之后代理商可以用此trace_no 通过用“支付消息历史查询接口”查询该条支付消息。此参数对云音箱或服务器工作状态没有影响。		*
descs	DESCRIPTION	代理商可以给此支付消息一个描述字符串，最大 255个字节。之后代理商用 “支付消息历史查询接口”查询支付消息时，可以看到此描述。此参数对云音箱或服务器工作状态没有影响。
suffix	VOLUMESUFFIX	是否开启自定义收款消息后缀， 1表示开启

备注：

云音箱收到支付结果后，播放内容为：支付类型 + 金额

例子：

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

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

3) 返回参数：

参数	类型	说明	必须
errcode	integer	返回码，参见网关返回码	*
errmsg	string	返回码描述	*
detail	string	返回的数据

3、可选接口

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

3.1 通知语音播报（不支持WIFI版，流量版专用）

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

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

1）URL：https://speaker.17laimai.cn/notify.php （流量版专用播报接口，流量版可以只用到这一个接口，其它接口选用）

2）请求参数：

参数	意义	解释	必须
id	SPEAKERID	指该云音箱标签上的的 SN/ID	*
token	代理商的 token	代理商的 token, 预先通过安全渠道分配，使得代理商对该 SPEAKERID 有操作权限	*
version	接口版本	按各型号标注的VERSION版本，由用户配置时选择，预留1-9供选择	*
message	MESSAGE	通知消息内容，长度最长128个字节数字处理策略见3.1.1备注如果需要断句，则添加逗号“,”	*
seq	SEQUENCY	用于通讯去重复的顺序号，范围为 [0,4294967295] ( 即 [0,0xFFFFFFFF])的整数。每次提交时请改变此值（比如按顺序加 1）。假如服务器在 200 秒（暂定值）内收到两个或多个 SEQUENCY 相同、并且提交的内容也相同的请求，则认为是重复提交，将忽略此请求，并返回错误码 17。此参数缺省时，服务器对此次请求不做去重检查，此次请求也不作为后续去重检查的比较依据。
vol	VOLUME	指音量设置值，范围为 0 到 100，代表从无音到最大声。
speed	SPEED	语速，速度范围为0-100，默认为50 (仅限404、504)
trace_no	TRACE_ NUMBER	代理商用于追踪此支付消息的一个字符串，最大 63个字节，由代理商软件产生。之后代理商可以用此trace_no 通过用“支付消息历史查询接口”查询该条支付消息。此参数对云音箱或服务器工作状态没有影响。

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

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

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

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

3.1.1备注：数字处理策略，适用于编号播报，车牌播报等非金额格式的播报。

当message参数中，数字是按金额来播报的，比如“123”，播报为“一百二十三”，如果要按号码、编号来播报，则需要把特殊内容用“[”“]”方括号包裹起来，

比如：

1、订单编号[123]收款66元,则播报为“订单编号一二三收款六十六元”;

2、[津A8526]正常通行，则播报为“津A八五二六”正常通行

3) 返回参数：

参数	类型	说明	必须
errcode	integer	返回码，参见网关返回码	*
errmsg	string	返回码描述	*
detail	string	返回的数据

3.2 更改语音信息（灰度测试）

更改开机语音，自定义播报前缀。(仅适用于402、404、502、504)

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

2）请求参数：

参数	意义	解释	必须
id	SPEAKERID	云音箱的 ID	*
token	TOKEN	代理商的 token, 预先通过安全渠道分配，使得代理商对该 SPEAKERID 有操作权限	*
version	接口版本	按各型号标注的VERSION版本，预留1-9供用户配置音箱时选择	*
sound	开机铃声	声音内容中文最长15字其他字节30字节	*
off_text	关机铃声	中文，可选
type	TYPE	0 表示开机欢迎声音传 off_text 时此值填写 1	*
seq	SEQUENCY	用于通讯去重复的顺序号，范围为 [0,4294967295] ( 即 [0,0xFFFFFFFF])的整数。每次提交时请改变此值（比如按顺序加 1）。假如服务器在 200 秒（暂定值）内收到两个或多个 SEQUENCY 相同、并且提交的内容也相同的请求，则认为是重复提交，将忽略此请求，并返回错误码 17。此参数缺省时，服务器对此次请求不做去重检查，此次请求也不作为后续去重检查的比较依据。
descs	DESCRIPTION	代理商可以给此绑定请求提供一个描述字符串，最大 255 个字节。之后代理商用 “ 绑定状态查询接口”查询绑定消息时，可以看到此描述。此参数对云音箱或服务器工作状态没有影响。

例子：https://speaker.17laimai.cn/modify_bootvoicewav.php?id=10000091&token=123456789021&sound=欢迎光临&off_text=谢谢使用&type=1

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

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

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

3) 返回参数：

参数	类型	说明	必须
errcode	integer	返回码，参见网关返回码	*
errmsg	string	返回码描述	*
detail	string	返回的数据

3.3 云音箱绑定状态查询（已作废）

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

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

2) 请求参数：

参数	意义	解释			必须
ids	START_SPEAKERID	查询方式	方式一	云音箱的起始 ID，如果为空，表示不限制起始 ID	*
ide	END_SPEAKERID		方式一	云音箱的结束 ID，如果为空，表示不限制结束 ID
id	SPEAKERID		方式二	云音箱的 ID可以是单个喇叭 ID，也可以是范围或枚举。范围以减号连接，包含两头值；枚举以逗号分隔。例如: 1000,1005,1008-1011,1015 表示喇叭 ID 为: 1000,1005,1008,1009,1010,1011,101
uid	USERID		方式三	用户帐号 ID，申请与云音箱 ID 绑定的用户帐号 ID，必须每个用户唯一
version	接口版本	此方法只支持版本为1
ts	START_TIME	查询条件		指只查询这个时间或这个时间之后的记录，时间格式如下：一段 14 字节的字符串 , 格式为 YYYYMMDDHHmmss其中四字节年，两字节月份，两字节日，两字节小时(24 小时制)，两字节分钟，两字节秒例如： 20170927173500 表示 2017 年 9 月 27 日 17 时 35 分零秒此参数如果缺省，表示不限制起始时间。
te	END_TIME			指只查询这个时间或这个时间之前的记录，时间格式同上。此参数如果缺省，表示不限制结束时间。
descs	DESCRIPTION			查询代理绑定消息时提交的 DESC 标识。目前暂不提供%的模糊查询
fm	FORMAT	返回格式		指定数据返回格式， 0 为内部调试用的 Html 表格格式， 1 为纯文本， 2为 Microsoft Excel 的.csv， 3 为 json；缺省时为 3
p	PAGE	显示分页		输出的页号，整数值，从 0 开始。为了防止每次返回数据太多造成服务器超时，服务器每次只返回PAGESIZE 条(缺省为 200)记录。 p=0 时表示返回最开头的 200 条，即第 0 条到第 199 条。 p=1 表示返回第 200 到第 399 条。以此类推。当用户查询到 p=n 时返回记录数为零，说明可以停止继续查询后续页。此参数缺省值为 0。此参数当 m=0 时无效，因为 html 表格已经自动分页。
pi	PAGEITEM			指定当前显示页是从第几条结果开始显示。例如 pi=350，表示当前页是从第 350条结果开始。此参数缺省值为 0。此参数不要与 PAGE 同时用，否则会忽略 PAGE 参数。例如，当 PAGESIZE 为 200 时， PAGE 为 2 与 PAGEITEM 为 400 的效果与等同。此参数当 m=0 时无效，因为 html 表格已经自动分页。
ps	PAGESIZE			每页显示的结果条数。缺省为 200。此参数当 m=0 时无效，因为 html 表格已经自动分页。
token	TOKEN	代理商的 token		代理商的 token, 预先通过安全渠道分配，使得代理商对该 SPEAKERID 有操作权限

例子1：

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

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

例子2:

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

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

3) 返回参数：

参数	类型	说明	必须
errcode	integer	返回码，参见网关返回码	*
errmsg	string	返回码描述	*
detail	string	返回的数据

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）请求参数：

参数	意义	解释			必须
ids	START_SPEAKERID	查询方式	方式一	云音箱的起始 ID，如果为空，表示不限制起始 ID	*
ide	END_SPEAKERID		方式一	云音箱的结束 ID，如果为空，表示不限制结束 ID
id	SPEAKERID		方式二	云音箱的 ID可以是单个喇叭 ID，也可以是范围或枚举。范围以减号连接，包含两头值；枚举以逗号分隔。例如: 1000,1005,1008-1011,1015 表示喇叭 ID 为: 1000,1005,1008,1009,1010,1011,101
uid	USERID		方式三	用户帐号 ID，申请与云音箱 ID 绑定的用户帐号 ID，必须每个用户唯一
version	接口版本	此方法只支持版本为1
ts	START_TIME	查询条件		指只查询这个时间或这个时间之后的记录，时间格式如下：一段 14 字节的字符串 , 格式为 YYYYMMDDHHmmss其中四字节年，两字节月份，两字节日，两字节小时(24 小时制)，两字节分钟，两字节秒例如： 20170927173500 表示 2017 年 9 月 27 日 17 时 35 分零秒此参数如果缺省，表示不限制起始时间。
te	END_TIME			指只查询这个时间或这个时间之前的记录，时间格式同上。此参数如果缺省，表示不限制结束时间。
descs	DESCRIPTION			查询代理绑定消息时提交的 DESC 标识。目前暂不提供%的模糊查询
fm	FORMAT	返回格式		指定数据返回格式， 0 为内部调试用的 Html 表格格式， 1 为纯文本， 2为 Microsoft Excel 的.csv， 3 为 json；缺省时为 3
p	PAGE	显示分页		输出的页号，整数值，从 0 开始。为了防止每次返回数据太多造成服务器超时，服务器每次只返回PAGESIZE 条(缺省为 200)记录。 p=0 时表示返回最开头的 200 条，即第 0 条到第 199 条。 p=1 表示返回第 200 到第 399 条。以此类推。当用户查询到 p=n 时返回记录数为零，说明可以停止继续查询后续页。此参数缺省值为 0。此参数当 m=0 时无效，因为 html 表格已经自动分页。
pi	PAGEITEM			指定当前显示页是从第几条结果开始显示。例如 pi=350，表示当前页是从第 350条结果开始。此参数缺省值为 0。此参数不要与 PAGE 同时用，否则会忽略 PAGE 参数。例如，当 PAGESIZE 为 200 时， PAGE 为 2 与 PAGEITEM 为 400 的效果与等同。此参数当 m=0 时无效，因为 html 表格已经自动分页。
ps	PAGESIZE			每页显示的结果条数。缺省为 200。此参数当 m=0 时无效，因为 html 表格已经自动分页。
token	TOKEN	代理商的 token		代理商的 token, 预先通过安全渠道分配，使得代理商对该 SPEAKERID 有操作权限

例子1：

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

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

例子2:

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

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

3) 返回参数：

参数	类型	说明	必须
errcode	integer	返回码，参见网关返回码	*
errmsg	string	返回码描述	*
detail	string	返回的数据

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	SPEAKERID	指该云音箱的 ID	*
token	TOKEN	代理商的 token	*

例子：

https://speaker.17laimai.cn/get_last.php?id=10000091&token=123456789021

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

3) 返回参数：

参数	类型	说明	必须
errcode	integer	返回码，参见网关返回码	*
errmsg	string	返回码描述	*
detail	string	返回的数据

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）请求参数

参数	意义	解释			必须
ids	START_SPEAKERID	查询方式	方式一	云音箱的起始 ID，如果为空，表示不限制起始 ID	*
ide	END_SPEAKERID		方式一	云音箱的结束 ID，如果为空，表示不限制结束 ID
id	SPEAKERID		方式二	云音箱的 ID可以是单个喇叭 ID，也可以是范围或枚举。范围以减号连接，包含两头值；枚举以逗号分隔。例如: 1000,1005,1008-1011,1015 表示喇叭 ID 为: 1000,1005,1008,1009,1010,1011,101
uid	USERID		方式三	用户帐号 ID，申请与云音箱 ID 绑定的用户帐号 ID，必须每个用户唯一
ts	START_TIME	查询条件		指只查询这个时间或这个时间之后的记录，时间格式如下：一段 14 字节的字符串 , 格式为 YYYYMMDDHHmmss其中四字节年，两字节月份，两字节日，两字节小时(24 小时制)，两字节分钟，两字节秒例如： 20170927173500 表示 2017 年 9 月 27 日 17 时 35 分零秒此参数如果缺省，表示不限制起始时间。
te	END_TIME			指只查询这个时间或这个时间之前的记录，时间格式同上。此参数如果缺省，表示不限制结束时间。
descs	DESCRIPTION			查询代理绑定消息时提交的 DESC 标识。目前暂不提供%的模糊查询
fm	FORMAT	返回格式		指定数据返回格式， 0 为内部调试用的 Html 表格格式， 1 为纯文本， 2为 Microsoft Excel 的.csv， 3 为 json；缺省时为 3
p	PAGE	显示分页		输出的页号，整数值，从 0 开始。为了防止每次返回数据太多造成服务器超时，服务器每次只返回PAGESIZE 条(缺省为 200)记录。 p=0 时表示返回最开头的 200 条，即第 0 条到第 199 条。 p=1 表示返回第 200 到第 399 条。以此类推。当用户查询到 p=n 时返回记录数为零，说明可以停止继续查询后续页。此参数缺省值为 0。此参数当 m=0 时无效，因为 html 表格已经自动分页。
pi	PAGEITEM			指定当前显示页是从第几条结果开始显示。例如 pi=350，表示当前页是从第 350条结果开始。此参数缺省值为 0。此参数不要与 PAGE 同时用，否则会忽略 PAGE 参数。例如，当 PAGESIZE 为 200 时， PAGE 为 2 与 PAGEITEM 为 400 的效果与等同。此参数当 m=0 时无效，因为 html 表格已经自动分页。
ps	PAGESIZE			每页显示的结果条数。缺省为 200。此参数当 m=0 时无效，因为 html 表格已经自动分页。
token	TOKEN	代理商的 token		代理商的 token, 预先通过安全渠道分配，使得代理商对该 SPEAKERID 有操作权限

例子：

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

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

3) 返回参数：

参数	类型	说明	必须
errcode	integer	返回码，参见网关返回码	*
errmsg	string	返回码描述	*
detail	string	返回的数据

detail 说明：

查询后，云服务器回复的内容是该云音箱的历史消息列表。

三、常见问题

1. 此token 无此 SPEAKERID 权限

1）：检查version,是否与当前设备型号对应正确，version(接口版本对应表)。

2）：检查TOKEN是否正确，是否完整

3）：联系我们，协助检查。

收款云音箱云喇叭API开发接口文档（2021-10-7）

云音箱服务对接指南

一、名词解释 (开发前必读)

1、云音箱 ID (SPEAKERID、sn)：喇叭标签上的SN码

2、TOKEN (接口凭证)：必须

3、version（接口版本）：(非常重要)

二、接口

1、通讯协议（作为了解）

1）接口网关：

2）协议和端口号：

3）请求方式：GET 或 POST (推荐使用POST,数据更安全)

4）提交数据格式：

5）返回数据格式：JSON

6）网关返回码

2、基础接口

2.1 云音箱绑定或解绑（WIFI版必用，流量版选用）

2.2 支付语音播报（WIFI\流量版通用）

3、可选接口

3.1 通知语音播报（不支持WIFI版，流量版专用）

3.1.1备注：数字处理策略，适用于编号播报，车牌播报等非金额格式的播报。

3.2 更改语音信息（灰度测试）

3.3 云音箱绑定状态查询（已作废）

3.4 查询云音响操作权限(已作废)

3.5 查询第一条未播放语音（已作废）

3.6 查询历史支付消息（已作废）

三、常见问题

1. 此token 无此 SPEAKERID 权限

热门文章

最新文章

相关课程

相关电子书

相关实验场景

热门

活动广场

任务中心

开发者评测

高校计划

乘风者计划

训练营

阿里云MVP

话题

直播

下载

镜像站

技术资料

插件

收款云音箱云喇叭API开发接口文档（2021-10-7）

云音箱服务对接指南

一、名词解释 (开发前必读)

1、云音箱 ID (SPEAKERID、sn)： 喇叭标签上的SN码

2、TOKEN (接口凭证)： 必须

3、version（接口版本）：(非常重要)

二、接口

1、通讯协议（作为了解）

1）接口网关：

2）协议和端口号：

3）请求方式：GET 或 POST (推荐使用POST,数据更安全)

4）提交数据格式：

5）返回数据格式：JSON

6）网关返回码

2、基础接口

2.1 云音箱绑定或解绑（WIFI版必用，流量版选用）

2.2 支付语音播报（WIFI\流量版通用）

3、可选接口

3.1 通知语音播报（不支持WIFI版，流量版专用）

3.1.1备注：数字处理策略 ，适用于编号播报，车牌播报等非金额格式的播报。

3.2 更改语音信息 （灰度测试）

3.3 云音箱绑定状态查询（已作废）

3.4 查询云音响操作权限(已作废)

3.5 查询第一条未播放语音（已作废）

3.6 查询历史支付消息（已作废）

三、常见问题

1. 此token 无此 SPEAKERID 权限

热门文章

最新文章

相关课程

相关电子书

相关实验场景

1、云音箱 ID (SPEAKERID、sn)：喇叭标签上的SN码

2、TOKEN (接口凭证)：必须

3.1.1备注：数字处理策略，适用于编号播报，车牌播报等非金额格式的播报。

3.2 更改语音信息（灰度测试）