NERoom 房间组件
服务端
API概览
更新时间： 2023/03/30 11:45:11
本文介绍 NERoom SDK 的 Restful API 列表。
账号管理
| API | 方法 | 请求URL |
|---|---|---|
| 创建账号 | PUT | https://roomkit.netease.im/apps/{appKey}/v1/users/{userUuid} |
| 刷新 Token | POST | https://roomkit.netease.im/apps/v1/refreshToken |
| 更新昵称和头像 | PUT | https://roomkit.netease.im/apps/{appKey}/v1/users/{userUuid}/update |
房间管理
| API | 方法 | 请求URL |
|---|---|---|
| 创建房间 | PUT | https://roomkit.netease.im/apps/v2/room |
| 关闭房间 | DELETE | https://roomkit.netease.im/apps/v2/room?roomArchiveId={roomArchiveId} |
| 查询房间信息 | GET | https://roomkit.netease.im/apps/v2/room?roomArchiveId={roomArchiveId} |
| 查询未结束房间列表 | GET | https://roomkit.netease.im/apps/v2/active-room-list?pageNumber={pageNumber}&pageSize={pageSize} |
| 查询已结束房间列表 | GET | https://roomkit.netease.im/apps/v2/history-room-list?pageNumber={pageNumber}&pageSize={pageSize} |
房间成员管理
| API | 方法 | 请求URL |
|---|---|---|
| 查询在线人员列表 | GET | https://roomkit.netease.im/apps/v2/online-user-list?roomArchiveId={roomArchiveId}&pageNumber={pageNumber}&pageSize={pageSize} |
| 移出房间成员 | DELETE | https://roomkit.netease.im/apps/v2/room-user?roomArchiveId={roomArchiveId}&userUuid={userUuid} |
即时消息
| API | 方法 | 请求URL |
|---|---|---|
| 发送聊天室自定义消息 | POST | https://roomkit.netease.im/apps/v2/sendChatRoomCustomMessage |
数据统计
| API | 方法 | 请求URL |
|---|---|---|
| 查询房间录制记录 | GET | https://roomkit.netease.im/apps/v2/room-media?roomArchiveId={roomArchiveId} |
| 查询房间直播流名称 | GET | https://roomkit.netease.im/apps/v2/live-stream-name?roomArchiveId={roomArchiveId} |
此文档是否对你有帮助？
有帮助
我要吐槽
