OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
input | String | Required | 搜索内容,可以是音乐名称/ID/地址,如名称:不要说话 陈奕迅,ID:25906124,地址:http://music.163.com/#/song?id=25906124 | ||
filter | Enum | Required | name | Range: name/id/url | 搜索类型,name是搜索音乐名称,id是搜索ID,url是搜索地址 |
website | Enum | Required | Range: netease/qq/kugou/kuwo/xiami/baidu/1ting/migu/lizhi/qingting/ximalaya/kg/5singyc/5singfc | 搜索站点,其中,netease:网易、qq:QQ、kugou:酷狗、kuwo:酷我、xiami;虾米、baidu:百度、1ting:一听、migu:咪咕、lizhi:荔枝、qingting:蜻蜓、ximalaya:喜马拉雅、kg:全民K歌、5singyc:5sing原创、5singfc:5sing翻唱 | |
page | Int | Optaion | 1 | 页数 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
input | *Required | |
filter | *Required | |
website | *Required | |
page | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
music | Object | 搜索的音乐结果信息,没有结果返回空对象 |
music.type | String | 网站类型 |
music.link | String | 音乐链接 |
music.songid | String | 音乐ID |
music.title | String | 音乐标题 |
music.author | String | 歌手 |
music.lrc | String | 歌词 |
music.url | String | 播放链接 |
music.pic | String | 图片 |
HTTP Response Code
HTTP Status Code | Description |
---|---|
Http Status = 200 | Success |
Http Status = 400 | Illegal-Params |
Http Status = 401 | Illegal-Token |
Http Status = 402 | IP-Banned |
Http Status = 404 | API-NOT-Exsits |
Http Status = 406 | Illegal-APPKEY |
Http Status = 407 | APPKEY-Expired-Out |
Http Status = 408 | APPKEY-Busy |
Http Status = 409 | Illegal-Sign |
Http Status = 413 | API-Traffic-NOT-Enough |
Http Status = 415 | API-LOCKED |
Http Status = 500 | Internal-Server-Error |