蓝牙设备接口文档.pdf

目 录 一 ．概述 二 ．接口说明 1.接口调用说明 2.授权认证接口 3.聊天接口 4.提醒事项查询 5.闹钟记录查询 三.音频指令示例 四.错误码表 五.示例 本文档使用 看云 构建 - 2 - 一 ．概述 一 ．概述 本文档是灵聚智能引擎蓝牙设备接口的说明及接入指引。 蓝牙设备通过手机APP接入灵聚 ，与其他接入方式有所不同 ，请注意以下事项 ： 1. 1.开发者在我司开发者平台创建软件android应用后 ，将会得到appkey用于接入服务 ：appkey ，该appkey 对应于开发者在我司开发者平台创建的应用 ，主要用于accessToken的获取及重置 ，请开发者妥善保管。 2. 2.对userid的说明和要求 userid是蓝牙设备id ，灵聚需获取唯一的userid,根据userid标识终端id并实现授权 限制及个性化的上下文应答。userid必须提前通过excel文档或者其他方式 （后期可通过开发者平台自主提 交 ）提供给灵聚添加到对应的应用下 ，才能保证提供正常的服务。 3. 3.定制开发不同的产品请生成不同的应用 ，获取不同的appkey ；在对接时 ，也务必使用不同的应用appkey 接入。 本文档使用 看云 构建 - 3 - 二 ．接口说明 二 ．接口说明 我司目前共开放4个接口 ，分别是 ：授权认证接口、聊天应答接口、提醒查询接口、闹钟查询接口。接口调用的 一个原则是 ：授权接口获取accessToken ，然后凭此值调用其余接口工作。随着场景的拓展 ，往后将开放更多的 接口 ，敬请关注开发者平台的公告。 本文档使用 看云 构建 - 4 - 1.接口调用说明 1.接口调用说明 接口调用流程见图1 ： 针对开发者用户唯一性授权的要求 ，开发者需自行标识自身的用户 ，为每一个用户配备一个唯一的userid ，重复 的ID在我司的服务接口中将会引起应答混乱 ，这一点请开发者牢记。 请注意 ：Auth授权的流程建议放在开发者服务端来完成 ，如上图所示 ，开发者服务端将获得的accessToken返回 到用户端进行机器人对话。此流程不是强制性要求 ，开发者也可在用户端 （app端 ）进行auth授权获取 accessToken ，但需注意此做法容易泄漏appkey及授权码 ，若引发损失请开发者自行负责。 本文档使用 看云 构建 - 5 - 2.授权认证接口 2.授权认证接口 接口路径 ：http//dev.lingju.ai8999/bltapi/authorize.do 名称 授权认证接口 接口路径 http//dev.lingju.ai8999/bltapi/authorize.do 请求方式 get/post http get请求示例 ： http://dev .lingju.ai:8999/bltapi/authorize.do?appkey xxxxxuserid xxxx 请求参数说明 ： 参数 数据类型 可需 描述 必须保证与提前发给灵聚录入数 appkey String 必填 据库的userid对应的应用 appkey保持一致 必须保证与提前发给灵聚录入数