背景音乐列表取得

优质
小牛编辑
187浏览
2023-12-01

1.1. 获取背景音乐列表接口文档

1.1.1. 概述

本文档目的是描述Rokid云背景音乐列表HTTP接口协议,面向想要获取背景音乐列表,并具有一定开发能力的开发者或用户。

1.1.2. 服务地址

环境地址用途
线上https://mapi.open.rokid.com/rest/getBgmList对外提供的正式稳定环境

1.1.3. 协议详解

  • 请求认证:在建立http连接时,通过http header authorization 进行权限认证
  • 背景音乐列表获取

HTTP API 接入参考Demo

curl -X POST \
--header "Content-Type:application/json" \
--header "Authorization:${Authorization}" \
https://mapi.open.rokid.com/rest/getBgmList

${Authrization}为您根据请求认证得到的字符串

1.1.4. 协议概述

此协议遵循http协议。协议采用先认证,再使用的方式,步骤如下:

  • 建立 https 连接,注意是 https,在此基础上进行请求认证
  • service 设置为 getBgmList,此连接后续可进行一次背景音乐列表获取

背景音乐列表获取

请求
  1. 需要带包含认证信息的 authorization 的 http header 请求认证
  2. 使用 HTTP POST 方式
  3. 其中 Content-Type 为 Content-Type:application/json
  4. 请求内容为空
响应
  1. 响应是json格式的,字段如下:
参数类型描述
recodestring返回码
messagestring返回描述
successbool是否成功
datalist返回结果集
  1. data里对象参数详解
参数类型描述
idstring背景音乐ID
bgmurlstring背景音乐mp3文件地址
bgmnamestring背景音乐名称
  1. 返回码表
code 值涵义
0000成功
1000系统异常
3004验签失败
  1. 返回参数示例
{
    "data": [
        {
            "id": "8899576FE6CC1D92E0530100007F2CFA",
            "bgmurl": "https://club.10155.com/wxringpic/1557562775613022692.mp3",
            "bgmname": "第2个",
        },
        {
            "id": "872DF013C0BE5272E0530100007F3048",
            "bgmurl": "https://club.10155.com/wxringpic/1556005104221682472.mp3",
            "bgmname": "正常测试",
        }
    ],
    "recode": "000000",
    "success": true,
    "message": "成功"
}