本文介绍 NERoom SDK 的 Restful API 列表。
账号管理
API |
方法 |
请求URL |
创建账号 |
POST |
https://{endpoint}/neroom/v3/users |
更新账号和 Token |
PATCH |
https://{endpoint}/neroom/v3/users/:user_uuid |
获取账号信息 |
GET |
https://{endpoint}/neroom/v3/users/:user_uuid |
批量获取账户信息 |
GET |
https://{endpoint}/neroom/v3/users?user_uuids=:user_uuids |
房间管理
API |
方法 |
请求URL |
创建房间 |
POST |
https://{endpoint}/neroom/v3/rooms |
关闭房间 |
DELETE |
https://{endpoint}/neroom/v3/rooms/:room_archive_id |
房间成员管理
API |
方法 |
请求URL |
查询在线人员列表 |
GET |
https://{endpoint}/v3/rooms/:room_archive_id/online_user_list?page_number=:page_number&page_size=:page_size |
变更成员角色 |
PATCH |
https://{endpoint}/neroom/v3/rooms/:room_archive_id/users/:user_uuid/role |
移出房间成员 |
DELETE |
https://{endpoint}/neroom/v3/rooms/:room_archive_id/users/:user_uuid |
即时消息
API |
方法 |
请求URL |
发送聊天室自定义消息 |
POST |
https://{endpoint}/neroom/v3/rooms/:room_archive_id/messages |
发送全服广播消息 |
POST |
https://{endpoint}/neroom/v1/broadcast |
麦位
API |
方法 |
请求URL |
获取麦位信息 |
GET |
https://{endpoint}/neroom/v3/rooms/:room_archive_id/seats/slot_list |
数据统计
API |
方法 |
请求URL |
查询房间录制记录 |
GET |
https://{endpoint}/neroom/v3/rooms/:room_archive_id/media_info |
查询房间直播流名称 |
GET |
https://{endpoint}/neroom/v3/rooms/:room_archive_id/live_stream_name |