开发者中心
音视频通话 2.0
视频教程知识库工单
中文
文档API 参考SDK 下载Demo 及源码最佳实践新手入门
普通搜索
普通搜索
音视频通话 2.0
服务端
动态与公告
更新日志
活动与公告
【活动】内容安全检测限时补贴活动
关于RTC反垃圾送检计费变更的说明
新手接入指南
产品简介
产品介绍
功能特性
产品优势
应用场景
基本概念
服务端 API 说明
简介
API 概览
调用方式
数据结构
错误码和状态码
Token 鉴权
基础 Token 鉴权
高级 Token 鉴权
房间管理
房间管理概述
创建房间
查询房间信息
查询活跃房间列表
查询房间在线成员信息
查询房间历史成员信息
移除房间成员
撤销移除房间成员
查询房间移除成员列表
设置房间成员封禁状态
删除房间
房间管理事件抄送
安全通
安全通概述
开通安全通服务
创建安全通审核任务
安全通审核自动打码
查询审核视频截图
查询审核音频断句
停止安全通审核任务
安全通最佳实践
实现音视频安全检测
安全通审核事件抄送
云端播放
云端播放概述
云端播放计费说明
创建云端播放任务
更新云端播放任务
查询云端播放任务
暂停云端播放任务
恢复云端播放任务
销毁云端播放任务
云端播放事件抄送
云端录制
云端录制概述
云端录制计费说明
云端录制的实现流程
创建云端录制任务
录制布局
查询云端录制配置
更新订阅名单
停止录制任务
获取录制文件
云端录制事件抄送
旁路推流
旁路推流概述
实现旁路推流
创建旁路推流任务
旁路推流画面布局
更新旁路推流任务
查询指定旁路推流任务
查询所有旁路推流任务
停止旁路推流任务
旁路推流事件抄送
消息抄送
消息抄送服务概述
开通消息抄送服务
房间管理事件抄送
安全通审核事件抄送
云端播放事件抄送
云端录制事件抄送
旁路推流事件抄送
质量数据监控台
质量数据监控
质量数据分析
质量数据分析案例
常见问题处理

API 概览

更新时间： 2023/04/11 17:03:59

除客户端 API 外，云信还提供 RESTful 形式的服务端 API，通过发送 HTTPS 请求就可以获取 （GET），更新（PUT）, 创建 （POST），删除 （DELETE） 房间管理、房间踢人等相关数据或执行相关操作。

房间管理

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}
查看被移除成员列表 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
  • 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/livewallsolution/submit
查询审核视频截图 POST https://logic-dev.netease.im/livewallsolution/query/image
查询审核音频断句 POST https://logic-dev.netease.im/livewallsolution/query/audio/task
停止安全通审核任务 POST https://logic-dev.netease.im/livewallsolution/feedback

云端播放

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/pause
  • https://logic-dev.netease.im/v3/api/task/pause?cname={cname}
恢复云端播放任务 POST
  • https://logic-dev.netease.im/v2/api/task/resume
  • https://logic-dev.netease.im/v3/api/task/resume?cname={cname}
销毁云端播放任务 POST
  • https://logic-dev.netease.im/v2/api/task/close
  • https://logic-dev.netease.im/v3/api/task/close?cname={cname}

云端录制

API
方法
 请求 URL

云端录制（旧版）

POST
  • https://logic-dev.netease.im/v2/api/record/{cid}
  • https://logic-dev.netease.im/v3/api/record?cname={cname}

创建录制任务

POST
  • https://logic-dev.netease.im/v2/api/cloudrecord/submit
  • https://logic-dev.netease.im/v3/api/cloudrecord/submit?cname={cname}

更新订阅列表

POST
  • https://logic-dev.netease.im/v2/api/cloudrecord/updateSubs
  • https://logic-dev.netease.im/v3/api/cloudrecord/updateSubs?cname={cname}

查询录制任务信息

POST
  • https://logic-dev.netease.im/v2/api/cloudrecord/tasks
  • https://logic-dev.netease.im/v3/api/cloudrecord/tasks?cname={cname}
查询云端录制文件信息 POST - https://api.netease.im/nimserver/history/queryMediaFileByChannelId.action

停止录制任务

POST
  • https://logic-dev.netease.im/v2/api/cloudrecord/stop
  • https://logic-dev.netease.im/v3/api/cloudrecord/stop?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}
此文档是否对你有帮助？
有帮助
我要吐槽
文档反馈在线咨询
  • 房间管理
  • 安全通
  • 云端播放
  • 云端录制
  • 旁路推流