API 概览

更新时间: 2023/02/13 02:08:30

除客户端 API 外,网易云信 PK 直播组件还提供 RESTful 形式的服务端 API,通过发送 HTTP 或 HTTPS 请求就可以创建(POST)直播间或执行相关操作。

账号管理

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
创建直播间 POST http://roomkit.netease.im/scene/apps/{appKey}/ent/live/v1/createLive
关闭直播间 POST http://roomkit.netease.im/scene/apps/{appKey}/ent/live/v1/destroyLive
直播间打赏 POST http://roomkit.netease.im/scene/apps/{appKey}/ent/live/v1/reward

直播数据查询

API 方法 请求 URL
查询直播信息 POST http://roomkit.netease.im/scene/apps/{appKey}/ent/live/v1/info
查询直播列表 POST http://roomkit.netease.im/scene/apps/{appKey}/ent/live/v1/list
查询 PK 信息 POST http://roomkit.netease.im/scene/apps/{appKey}/ent/pk/v1/info
查询 PK 直播间打赏榜 POST http://roomkit.netease.im/scene/apps/{appKey}/ent/pk/v1/rewardTop

PK 连麦操作

API 方法 请求 URL
PK 邀请控制 POST http://roomkit.netease.im/scene/apps/{appKey}/ent/pk/v1/inviteControl
结束 PK 连麦 POST http://roomkit.netease.im/scene/apps/{appKey}/ent/pk/v1/end
此文档是否对你有帮助?
有帮助
去反馈
  • 账号管理
  • 直播间管理
  • 直播数据查询
  • PK 连麦操作