一起听 - 结束房间
结束一起听房间并停止后续同步。
接口信息
| 项目 | 值 |
|---|---|
| 接口地址 | /listentogether/end |
| 请求方式 | GET / POST |
| 需要登录 | 是 |
| 对应模块 | listentogether_end |
| 文档分类 | 一起听 |
| 上游路径 | /api/listen/together/end/v2 |
请求参数
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
roomId | string | ✅ | - | 房间 ID |
HTTP 示例
bash
POST /listentogether/end?roomId=MzA0NjY5...编程式调用
ts
import { listentogetherEnd } from 'hana-music-api';
const result = await listentogetherEnd({
roomId: 'MzA0NjY5...',
});
console.log(result.body);返回关注点
code: 是否调用成功。data.success: 在上游示例页里用于判断房间是否成功关闭。message: 失败时的错误原因。
返回内容
body.code 收紧为 200；data.success、data.roomType 和 message 是宽松字段，其余 data 字段只见过 null，未声明。
调用场景
- 房主结束一起听会话。
- 前端检测到房间无效后执行清理。
- 测试脚本在回收临时房间时执行收尾。。