本文档由 Tester 自动生成,最后修改时间 2020-09-04 00:42:40
一、接口说明
你可以在这里对接口进行一些简单的描述
二、请求方式
POST https://api.bbbug.com/api/room/hotRooms
三、请求参数
字段 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
plat | string | 是 | pc | - |
version | number | 是 | 10000 | - |
access_token | string | 是 | 123456 | 身份令牌 |
示例JSON:
{
"plat": "pc",
"access_token": "123456",
"version": 10000
}
四、更多参数
Headers:
Content-Type:application/json;
五、返回数据
字段 | 类型 | 固定 | 示例值 | 说明 |
---|---|---|---|---|
code | number | 是 | 200 | - |
msg | string | 是 | 数据获取成功 | - |
data | array | 是 | [] | - |
data.room_id | number | 是 | 888 | 房间ID |
data.room_user | number | 是 | 10000 | 房间所有人 |
data.room_score | number | 是 | 2 | 房间积分 |
data.room_online | number | 是 | 2 | 在线人数 |
data.room_name | string | 是 | BBBUG点歌音乐房 | 房间名称 |
data.room_type | number | 是 | 1 | 房间类型,见房间类型说明 |
data.room_public | number | 是 | 1 | 1需要密码 |
data.room_notice | string | 是 | 欢迎来到BBBUG | 房间公告 |
data.room_order | number | 是 | 10000000 | 房间排序 |
data.room_addsong | number | 是 | 1 | 1仅房主可点歌 |
data.room_sendmsg | number | 是 | 0 | 1全员禁言0正常 |
data.room_robot | number | 是 | 0 | 1打开机器人点歌 |
data.room_huya | string | 是 | https://www.huya.com/1234 | 虎牙直播地址 |
data.room_reason | string | 是 | 违规 | 封禁原因 |
data.room_status | number | 是 | 0 | 状态1封禁 |
data.user_id | number | 是 | 10000 | 房间所有人ID |
data.user_name | string | 是 | Hamm | 所有人昵称 |
data.user_admin | boolean | 是 | false | 所有人是否管理员 |
示例返回结果:
{
"code": 200,
"msg": "数据获取成功",
"data": [
{
"room_id": 888,
"room_user": 10000,
"room_online": 2,
"room_score": 123,
"room_name": "BBBUG点歌音乐房",
"room_type": 1,
"room_public": 0,
"room_notice": "欢迎来到BBBUG,点歌系统升级完成,欢迎来点歌呀",
"room_order": 10000000,
"room_addsong": 1,
"room_sendmsg": 0,
"room_robot": 0,
"room_huya": 'https://huya.com/1234',
"room_reason": "",
"room_status": 0,
"user_id": 10000,
"user_name": "Hamm",
"user_admin": false
},
{
"room_id": 6666,
"room_user": 10007,
"room_online": 0,
"room_score": 123,
"room_name": "听歌猜歌游戏房",
"room_type": 2,
"room_public": 0,
"room_notice": "欢迎来猜歌,请等待上一局游戏结束后参与!",
"room_order": 800000,
"room_addsong": 1,
"room_sendmsg": 0,
"room_robot": 0,
"room_huya": 'https://huya.com/1234',
"room_reason": "",
"room_status": 0,
"user_id": 10007,
"user_name": "猜歌小伙",
"user_admin": false
},
{
"room_id": 999,
"room_user": 1,
"room_online": 0,
"room_score": 123,
"room_name": "开发者房间",
"room_type": 1,
"room_public": 1,
"room_notice": "这里是开发者房间,讨论项目开发等事情",
"room_order": 1001,
"room_addsong": 1,
"room_sendmsg": 0,
"room_robot": 0,
"room_huya": 'https://huya.com/1234',
"room_reason": "",
"room_status": 0,
"user_id": 1,
"user_name": "机器人",
"user_admin": true
}
]
}
六、测试用例
https://tester.hamm.cn/#/20200915/c46fc41ce0a28bd64c884f28b70e547bf989a63f