小雅OS开放平台文档

小雅OS开放平台文档

  • 快速入门
  • 客户端接入
  • 服务端接入

›API 接入

概述

  • 客户端接入

API 接入

  • WebSocket接口协议定义
  • Http接口协议定义
  • 调用样例
  • API 列表
  • 实体列表
  • 错误码

设备端

    Android SDK

    • 配置工程
    • 初始化
    • 功能
    • 回调
    • Demo 使用
    • 更新日志

    iOS SDK

    • 配置工程
    • 初始化
    • 功能
    • 回调
    • 更新日志

    C++ SDK

    • SDK获取方法
    • 环境要求
    • 目录结构
    • SDK架构
    • 调用示例
    • 接口文档

手机伴侣

    Android SDK

    • 接入准备
    • 账号模块
    • 内容模块
    • 反向控制
    • 设备管理模块
    • 技能模块
    • 蓝牙模块
    • 更新日志

    iOS SDK

    • 接入准备
    • 账号模块
    • 内容模块
    • 反向控制
    • 设备管理模块
    • 技能模块

内容页

    Android

    • 更新日志
    • 初始化

    iOS

    • 更新日志
    • 初始化

错误码

接口异常时 http code 返回500,并返回 ErrorResponse 对象

ErrorResponse

字段名类型描述
timestamplong毫秒时间戳
statusIntegerhttp 错误状态代码
errorString业务错误代码
messageString错误描述信息
pathString访问路径

其中error取值描述信息如下:

错误码描述信息
5000未知错误
5001内部操作数据库错误
5002参数错误
5003内部http服务调用异常
5004权限验证失败
5005某资源未发现引发的错误
5006程序运行时产生的错误(比如操作数据有误导致出错)
5007频次限制引发的错误
5008内部thrift服务调用异常
5009内部技能服务调用异常
5011内部nlu服务调用异常
{
    "timestamp": 1510649738100,
    "status": 500,
    "error": "5004",
    "message": "authentication error!",
    "path": "/text/query"
}

资源获取错误

在内容技能内,在无法为用户输出资源地址用于播放时,将返回资源错误码。你可以将技能返回值解析为 JSON 后, 通过 JSON.response.data.resSoundState 获得错误码。

错误码描述信息
101正常返回
102版权降级
103付费未登录状态降级
-以下错误码不返回资源地址
201无资源
202无版权
203付费未登陆状态无法输出
204已经登录 - 但未购买 会员畅听专辑
205已经登录 - 但未购买 会员专享专辑
206已经登录 - 但未购买 精品专辑
207已经登录 - 但未购买VIP 会员抢先听
← 实体列表配置工程 →
  • ErrorResponse
  • 资源获取错误
北京小雅星空科技有限公司 京ICP备19010603号