获取麦位信息
更新时间: 2023/10/25 06:30:43
通过该接口可以获取麦位列表信息,包括麦位状态和麦位人员信息。
请求
URI
GET https://{endpoint}/neroom/v3/rooms/:room_archive_id/seats/slot_list
{endpoint} 为 NERoom 接入地址的域名,默认为 roomkit.netease.im
。如果您的应用主要服务于海外用户,请将域名设置为海外数据中心域名(roomkit-sg.netease.im
)。
Header
请求 Header 的设置请参见 请求结构。
路径参数
参数名称 | 类型 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|
room_archive_id | String | 是 | 4***251 | 创建房间时,NERoom 服务端自动生成的一个用于标识房间的 ID,全局唯一,最大长度36个字符。 获取方法请参见创建房间 中的返回参数。 |
请求示例
javahttps://roomkit.netease.im/neroom/v3/rooms/123/seats/slot_list
响应
响应参数
参数名称 | 类型 | 示例 | 描述 |
---|---|---|---|
code | Integer | 0 | 状态码,0 表示成功,具体请参见错误码。 |
msg | String | Success | 业务结果描述,Success 表示成功。 |
ts | Long | 1648021056815 | NERoom 服务器处理该请求的完成时间。该时间为 Unix 时间戳,即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数。 |
request_id | String | 7c4b6d9c3e9d42*****cc6e3a4d995 | 请求的唯一标识。 |
cost | String | 48ms | 处理该请求所消耗的时间。 |
+ data | Array of Object | - | 麦位信息列表 |
响应体示例
java{
"code": 0,
"msg": "Operation succeeded.",
"ts": 1684374465150,
"cost": "405ms",
"request_id": "local_b3d293d26bf74cc1aaca3d589c9d2366",
"data": [
{
"index": 1,
"status": 2,
"user": {
"user_uuid": "user01",
"name": "张三",
"icon": "https://tupian.jpg ",
"inviter_user_uuid":"user02",
"on_seat_type": 0,
"ext":"ext"
}
},
{
"index": 2,
"status": 0
},
{
"index": 3,
"status": 0
},
{
"index": 4,
"status": 0
}
]
}
错误码
错误码 | 错误信息 | 说明 | 处理建议 |
---|---|---|---|
0 | Success | 请求成功 | 无需处理 |
400 | Invalid parameter. | 参数错误 | 检查接口传参 |
1004 | Room not found. | 房间不存在或者已关闭 | 根据业务场景处理 |
此文档是否对你有帮助?