小雅OS开放平台文档

小雅OS开放平台文档

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

›Android SDK

概述

  • 客户端接入

API 接入

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

设备端

    Android SDK

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

    iOS SDK

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

    C++ SDK

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

手机伴侣

    Android SDK

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

    iOS SDK

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

内容页

    Android

    • 更新日志
    • 初始化

    iOS

    • 更新日志
    • 初始化

内容模块

当前专辑相关性推荐接口

a. 根据主播推荐

val albumId = "6233693"
val slot = Slots.GetAlbumListByAnnouncer(albumId)
if (clear) {
    slot.offset = 0
} else {
    slot.offset = dataSize
}

XYMobileSdk.getContentSdk().getAlbumListByAnnouncer(Slots.GetAlbumListByAnnouncer slot, JsonXYCallback<XYAlbumList> callback);

b. 根据内容推荐

val albumId = "6233693"
val slot = Slots.GetRelativeAlbumList(albumId)
if (clear) {
    slot.offset = 0
} else {
    slot.offset = dataSize
}

XYMobileSdk.getContentSdk().getRelativeAlbumList(Slots.GetRelativeAlbumList slot, JsonXYCallback<XYAlbumList> callback);

信息流接口

val slot = if (clear) {
    Slots.QueryHistory(0, 0)
} else {
    Slots.QueryHistory(offest = dataSize, timeLine)
}

XYMobileSdk.getContentSdk().getQueryHistoryList(Slots.QueryHistory slot, JsonXYCallback<XYSpeakerHistory> callback);

XYSpeakerHistory

{
    "pageInfo": {
        "hasMore": true,
        "count": 10,
        "timeline": 1564559741
    },
    "list": [{
        "request": {
            "feedback": "",
            "domain": "fm",
            "speechUrl": "https://xyxk-shasr-1256573505.cos.ap-shanghai.myqcloud.com/20190731/a4348382a27f0d72581a44f3b2d667bc?response-content-type=application%2Foctet-stream&sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKID0KLBxlWwPkzkKugldP1XeaL3zIVYoyJT%26q-sign-time%3D1564559681%3B1565164541%26q-key-time%3D1564559681%3B1565164541%26q-header-list%3Dhost%26q-url-param-list%3D%26q-signature%3D4f8fc648fc686e4ccf02bb858453d612f2236fce",
            "text": "我要听郭德纲的相声",
            "intent": "play_fm"
        },
        "historyId": 37751,
        "response": {
            "feedback": "",
            "card": {
                "text": "好的,为您播放,郭德纲21年相声精选,《人在江湖》郭德纲 于谦"
            }
        },
        "createTs": 1564555776,
        "sid": "a4348382a27f0d72581a44f3b2d667bc"
    }, {
        "request": {
            "feedback": "",
            "domain": "music",
            "speechUrl": "https://xyxk-shasr-1256573505.cos.ap-shanghai.myqcloud.com/20190731/7f89f5485183cdd50d0290f17cb4c1f7?response-content-type=application%2Foctet-stream&sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKID0KLBxlWwPkzkKugldP1XeaL3zIVYoyJT%26q-sign-time%3D1564559681%3B1565164541%26q-key-time%3D1564559681%3B1565164541%26q-header-list%3Dhost%26q-url-param-list%3D%26q-signature%3D1ce2f5133dfaadd6b9f84622be63d0dfc457af03",
            "text": "我要听周杰伦的歌",
            "intent": "search_music"
        },
        "historyId": 37736,
        "response": {
            "feedback": "",
            "card": {
                "text": "没有找到这个内容,换一个试试吧!"
            }
        },
        "createTs": 1564555600,
        "sid": "7f89f5485183cdd50d0290f17cb4c1f7"
    }, {
        "request": {
            "feedback": "",
            "domain": "general_command",
            "speechUrl": "https://xyxk-shasr-1256573505.cos.ap-shanghai.myqcloud.com/20190731/3ee99c89c9287ded6776a71fade5c562?response-content-type=application%2Foctet-stream&sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKID0KLBxlWwPkzkKugldP1XeaL3zIVYoyJT%26q-sign-time%3D1564559681%3B1565164541%26q-key-time%3D1564559681%3B1565164541%26q-header-list%3Dhost%26q-url-param-list%3D%26q-signature%3D30e211eccaf18e684d039951647f74942f003a7f",
            "text": "",
            "intent": "next"
        },
        "historyId": 37732,
        "response": {
            "feedback": "",
            "card": {
                "text": "好的,Lenka,Trouble is a Friend"
            }
        },
        "createTs": 1564555583,
        "sid": "3ee99c89c9287ded6776a71fade5c562"
    }, ...]
}

获取推荐专辑列表

传参: "slots":{"offset":0,"limit":20}

参数类型是否必要
slots.offsetInteger否首条记录的索引位置,默认为0
slots.limitInteger否返回结果中的最大条目数量,默认为5,最大不超过50

调用:

XYMobileSdk.getContentSdk().getRecommendAlbumList(Slots.RecommendAlbumList slot,               JsonXYCallback<XYAlbumList> callback);

返回:

XYAlbumList;

搜索专辑列表

传参: "slots":{"keyword":"郭德纲","offset":0,"limit":20}

参数类型是否必要
slots.offsetInteger否首条记录的索引位置,默认为0
slots.limitInteger否返回结果中的最大条目数量,默认为5,最大不超过50
slots.keywordString是需要搜索的关键词

调用:

XYMobileSdk.getContentSdk().searchAlbumList(Slots.SearchAlbumList slot, JsonXYCallback<XYAlbumList> callback);

返回:

response.data中包含page对象,对象中Items数组元素为Album类型的对象;

当前专辑相关性推荐接口

传参:"slots":{"albumId":"123","offset":0,"limit":20}

参数类型是否必要
slots.offsetInteger否首条记录的索引位置,默认为0
slots.limitInteger否返回结果中的最大条目数量,默认为5,最大不超过50
slots.albumIdInteger是专辑id

调用:

XYMobileSdk.getContentSdk().getRelativeAlbumList(Slots.GetRelativeAlbumList slot, JsonXYCallback<XYAlbumList> callback);

返回:

对象中Items数组元素为Album类型的对象;

内容运营页

首页楼层接口

传参:

参数类型是否必要
slots.sdk_versionString是SDK版本信息
slots.product_idString是ProductID

接口调用:

XYMobileSdk.getContentSdk().getFloorHomePageData(slot, object : JsonXYCallback<List<XYFloorItem>>() {}

接口返回:

XYFloorItem形式的数组;

楼层推荐更多接口

传参:

参数类型是否必要
slots.limitString是SDK版本信息
slots.offsetString是ProductID
slots.floor_idString否楼层ID

接口调用:

XYMobileSdk.getContentSdk().getFloorRecommendList(slot, object : JsonXYCallback<XYList<XYAlbum>>() {}

返回数据:

XYAlbum形式数组;

专辑详情接口

传参:

参数类型是否必要
slots.album_idString是albumID
slots.product_idString是ProductID

调用:

XYMobileSdk.getContentSdk().getAlbumDetail(slot, object : JsonXYCallback<XYAlbum>() {}

接口返回数据:

XYAlbum数据;

获取声音接口

传参:

参数类型是否必要
slots.album_idString是albumID
slots.limitint否返回结果中的最大条目数量,默认为5,最大不超过50
slots.offsetint否首条记录的索引位置,默认为0
slots.sortString是asc: 喜马拉雅正序,desc: 喜马拉雅逆序,默认为 asc

调用接口:

XYMobileSdk.getContentSdk().getTracks(slot, object : JsonXYCallback<XYList<XYTrack>>() {}

搜索的热词接口

传参:无需传参

调用接口:

XYMobileSdk.getContentSdk().getHotWords(slot, object : JsonXYCallback<XYSearchHotWords>() {}

接口返回数据:

hotword:返回字符串数组

placeholder:默认搜索词

← 账号模块反向控制 →
  • 当前专辑相关性推荐接口
  • 信息流接口
  • 获取推荐专辑列表
  • 搜索专辑列表
  • 当前专辑相关性推荐接口
  • 内容运营页
    • 首页楼层接口
    • 楼层推荐更多接口
    • 专辑详情接口
    • 获取声音接口
    • 搜索的热词接口
北京小雅星空科技有限公司 京ICP备19010603号