开发者中心
互动直播 2.0
视频教程知识库工单
中文
文档API 参考SDK 下载Demo 及源码最佳实践新手入门
普通搜索
普通搜索
互动直播 2.0
服务端
动态与公告
更新日志
活动与公告
【活动】内容安全检测限时补贴活动
服务端 API 说明
简介
API概览
调用方式
请求结构
返回结果
数据结构
错误码
通用错误码
在线媒体流状态码
房间管理
创建房间
查看房间信息
查看房间内成员信息
移除成员
查看被移除成员列表
撤销移除
设置房间成员封禁状态
删除房间
推流任务管理
旁路推流概述
创建推流任务
旁路推流画面布局
更新推流任务
查看所有推流任务详情
查看指定推流任务详情
删除推流任务
输入在线媒体流
输入在线媒体流概述
输入在线媒体流计费
创建云端播放任务
更新云端播放任务
查询云端播放任务
销毁云端播放任务
消息抄送
消息抄送服务概述
开通消息抄送
实时音视频事件
互动直播事件
云端录制事件
在线媒体流事件

API 概览

更新时间： 2022/11/21 17:30:50

除客户端 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}/members
  • https://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}/task
  • https://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}/tasks
  • https://logic-dev.netease.im/v3/api/rooms/tasks?cname={cname}
更新推流任务 POST
  • https://logic-dev.netease.im/v2/api/rooms/{cid}/update/task
  • https://logic-dev.netease.im/v3/api/rooms/update/task?cname={cname}
删除推流任务 DELETE
  • https://logic-dev.netease.im/v2/api/rooms/{cid}/task
  • https://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/update
  • https://logic-dev.netease.im/v3/api/task/update?cname={cname}
查询云端播放任务 POST
  • https://logic-dev.netease.im/v2/api/task/list
  • https://logic-dev.netease.im/v3/api/task/list?cname={cname}
销毁云端播放任务 POST
  • https://logic-dev.netease.im/v2/api/task/close
  • https://logic-dev.netease.im/v3/api/task/close?cname={cname}
此文档是否对你有帮助？
有帮助
我要吐槽
文档反馈在线咨询
  • 房间管理
  • 推流任务管理
  • 输入在线媒体流