Skip to content

一起听 - 创建房间 ​

创建一起听房间,返回 roomId 和房主信息。

接口信息 ​

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

请求参数 ​

无需业务参数。当前实现会固定带上 refer=songplay_more。

HTTP 示例 ​

bash
GET /listentogether/room/create

编程式调用 ​

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

const result = await listentogetherRoomCreate();

console.log(result.body);

返回示例 ​

json
{
  "type": "NEW_ROOM",
  "roomInfo": {
    "creatorId": 1,
    "roomId": "$ROOM_ID"
  }
}

返回关注点 ​

  • data.roomInfo.roomId: 房间 ID,后续接口基本都依赖它。
  • data.roomInfo.creatorId: 房主用户 ID,可直接作为分享链接中的 inviterId。
  • data.type: 常见为 NEW_ROOM。

返回内容 ​

body.code、body.data、body.data.roomInfo 和 body.data.roomInfo.roomId 收紧;data.type、data.avatarPendantShow、房间的 creatorId、roomUsers[] 和展示字段都是宽松字段。创建成功后 roomInfo.roomId 是后续同步、心跳和结束接口的入口,data.type 常见为 NEW_ROOM。录制里的账号编号已换成合成值。

调用顺序 ​

  1. 登录账号并创建房间。
  2. 用 songId、roomId、creatorId 拼接分享链接: https://st.music.163.com/listen-together/share/?songId=歌曲ID&roomId=房间ID&inviterId=创建者ID
  3. 调用 /listentogether/room/check 确认房间可用。
  4. 主机准备歌单后调用 /listentogether/sync/list/command 推送房间播放列表。

Released under the MIT License.