除客户端 API 外,云信还提供 RESTful 形式的服务端 API,通过发送 HTTPS 请求就可以获取 (GET),更新(PUT), 创建 (POST),删除 (DELETE) 房间管理、房间踢人等相关数据或执行相关操作。
安全通和云端录制配置相关接口由音视频通话 2.0 产品提供。
房间管理
| API |
方法 |
请求 URL |
| 创建房间 |
POST |
https://logic-dev.netease.im/v2/api/room |
| 查看房间信息 |
GET |
https://logic-dev.netease.im/v2/api/rooms/{cid}https://logic-dev.netease.im/v3/api/rooms?cname={cname}
|
| 查看房间内成员信息 |
GET |
https://logic-dev.netease.im/v2/api/rooms/{cid}/membershttps://logic-dev.netease.im/v3/api/rooms/members?cname={cname}
|
| 移除成员 |
POST |
https://logic-dev.netease.im/v2/api/kicklist/{cid}/members/{uid}https://logic-dev.netease.im/v3/api/kicklist/members?cname={cname}&uid={uid}https://logic-dev.netease.im/v2/api/kicklist/{cid}/members/{uid}/{duration}https://logic-dev.netease.im/v3/api/kicklist/members?cname={cname}&uid={uid}&duration={duration}
|
| 查看被移除成员列表 |
GET |
https://logic-dev.netease.im/v2/api/kicklist/{cid}https://logic-dev.netease.im/v3/api/kicklist?cname={cname}
|
| 撤销移除 |
DELETE |
https://logic-dev.netease.im/v2/api/kicklist/{cid}/members/{uid}https://logic-dev.netease.im/v3/api/kicklist/members?cname={cname}&uid={uid}
|
| 设置房间成员封禁状态 |
POST |
https://logic-dev.netease.im/v2/api/right/change{uid}https://logic-dev.netease.im/v3/api/right/change?cname={cname}
|
| 删除房间 |
DELETE |
https://logic-dev.netease.im/v2/api/rooms/{cid}https://logic-dev.netease.im/v3/api/rooms?cname={cname}
|
推流任务管理
| API |
方法 |
请求 URL |
| 创建推流任务 |
POST |
https://logic-dev.netease.im/v2/api/rooms/{cid}/taskhttps://logic-dev.netease.im/v3/api/rooms/task?cname={cname}
|
| 查看指定推流任务详情 |
GET |
https://logic-dev.netease.im/v2/api/rooms/{cid}/task/{taskId}https://logic-dev.netease.im/v3/api/rooms/task?cname={cname}&taskId={taskId}
|
| 查看所有推流任务详情 |
GET |
https://logic-dev.netease.im/v2/api/rooms/{cid}/taskshttps://logic-dev.netease.im/v3/api/rooms/tasks?cname={cname}
|
| 更新推流任务 |
POST |
https://logic-dev.netease.im/v2/api/rooms/{cid}/update/taskhttps://logic-dev.netease.im/v3/api/rooms/update/task?cname={cname}
|
| 删除推流任务 |
DELETE |
https://logic-dev.netease.im/v2/api/rooms/{cid}/taskhttps://logic-dev.netease.im/v3/api/rooms/task?cname={cname}
|
输入在线媒体流
| API |
方法 |
请求 URL |
| 创建云端播放任务 |
POST |
https://logic-dev.netease.im/v2/api/task/create |
| 更新云端播放任务 |
POST |
https://logic-dev.netease.im/v2/api/task/updatehttps://logic-dev.netease.im/v3/api/task/update?cname={cname}
|
| 查询云端播放任务 |
POST |
https://logic-dev.netease.im/v2/api/task/listhttps://logic-dev.netease.im/v3/api/task/list?cname={cname}
|
| 销毁云端播放任务 |
POST |
https://logic-dev.netease.im/v2/api/task/closehttps://logic-dev.netease.im/v3/api/task/close?cname={cname}
|