Skip to content

一起听 - 房间检查 ​

校验房间是否存在、是否还能加入,以及当前房间状态。

接口信息 ​

项目值
接口地址/listentogether/room/check
请求方式GET / POST
需要登录是
对应模块listentogether_room_check
文档分类一起听
上游路径/api/listen/together/room/check

请求参数 ​

参数类型必填默认值说明
roomIdstring✅-房间 ID

HTTP 示例 ​

bash
POST /listentogether/room/check?roomId=MzA0NjY5...

编程式调用 ​

ts
import { listentogetherRoomCheck } from 'hana-music-api';

const result = await listentogetherRoomCheck({
  roomId: 'MzA0NjY5...',
});

console.log(result.body);

返回内容 ​

body.code、通到房间情况的 body.data 和接口就是为了拿的 data.joinable、data.status 收紧;data.copywriting 宽松;data.type 在录制里只见过 null,未声明并原样保留。结构定义和类型是 ListentogetherRoomCheckBody,见 返回体结构。

返回示例 ​

json
{
  "code": 200,
  "data": {
    "joinable": true,
    "type": "NORMAL",
    "copywriting": null,
    "status": "AVAILABLE"
  },
  "message": ""
}

示例里的 data.type 在本批录制里只见过 null,未声明,原样保留;data.copywriting 是宽松展示文案。

返回关注点 ​

  • data.joinable: 当前房间是否还能加入。
  • data.status: 房间状态,公开样例里可见 AVAILABLE。
  • data.type: 房间类型,公开样例里可见 NORMAL;未声明,原样保留。
  • data.copywriting: 服务端返回的补充文案,可能为空。

调用场景 ​

  • 房主创建房间后检查是否创建成功。
  • 从机接受邀请前后确认房间仍可加入。
  • 前端在分享页或轮询逻辑里做可用性校验。

相关接口 ​

Released under the MIT License.