文档中心
文档
备案
控制台
登录
立即注册
导航
实时音视频
搜索目录或文档标题
搜索目录或文档标题
实时音视频
产品动态
产品公告
Web SDK 兼容性升级公告：应对 Chrome 浏览器变更
发版说明
客户端 SDK
Web SDK
微信小程序 SDK
服务端 OpenAPI
其他
升级到新版本客户端 SDK
客户端升级指南
Android 客户端升级指南
iOS 客户端升级指南
macOS 客户端升级指南
Windows 客户端升级指南
Linux 客户端升级指南
Web 客户端升级指南
Web 客户端 SDK 版本对比工具
Electron 客户端升级指南
产品简介
什么是实时音视频
功能特性
基础概念
使用限制
Web SDK 浏览器兼容性和已知问题
产品计费
计费概述
计费规则
音视频通话计费
云端录制计费
转推直播计费
音频切片计费
抽帧截图计费
内容安全计费
云录屏计费
WTN 流计费（原公共流）
资源包
查看账单和用量
欠费说明
获取 SDK 和 Demo
SDK 概览
获取 SDK
获取示例项目
体验 Demo
快速入门
开通服务
跑通示例项目
Android
iOS
macOS
Windows
Linux 桌面版
Linux 命令行版
Web
抖音小程序
微信小程序
Electron
Flutter
Unity
实现音视频通话
Android
iOS (Swift)
iOS (Objective-C)
macOS (C++)
macOS (Objective-C)
Windows
Web
Electron
Flutter
微信小程序
Unity
抖音小游戏（Beta）
React Native
场景方案
在线 KTV
排麦独唱
场景介绍
Demo 体验
场景搭建（iOS）
场景搭建（Android）
体验进阶
双人合唱
场景介绍
Demo 体验
场景搭建（iOS）
场景搭建（Android）
一起看直播
场景介绍
Demo 体验
场景搭建（iOS)
场景搭建（Android）
一起看抖音
场景介绍
Demo 体验
场景搭建（iOS）
场景搭建（Android）
体验进阶
游戏房
场景介绍
Demo 体验
场景搭建（iOS）
场景搭建（Android）
音视频通话
场景介绍
Demo 体验
场景搭建（iOS）
场景搭建（Android）
体验进阶
多人音视频
场景介绍
Demo 体验
场景搭建（iOS）
场景搭建（Android）
场景搭建（Windows）
场景搭建（Web）
场景搭建（抖音小程序）
秀场直播连麦
场景介绍
视频互动
Demo 体验
场景搭建（iOS）
场景搭建（Android）
体验进阶
互动直播
Demo 体验
场景搭建（iOS）
场景搭建（Android）
体验进阶
语音聊天室
场景介绍
Demo 体验
场景搭建（iOS)
场景搭建（Android）
体验进阶
云端会议
场景介绍
Demo 体验
场景搭建 iOS
场景搭建 Android
场景搭建 Web
场景搭建 Electron
大班课
场景介绍
Demo 体验
场景搭建 iOS
场景搭建 Android
场景搭建 Web
场景搭建 Electron
小班课
场景介绍
Demo 体验
场景搭建 iOS
场景搭建 Android
场景搭建 Web
场景搭建 Electron
狼人杀
场景介绍
Demo 体验
场景搭建（抖音小游戏）
在线娃娃机
开发指南
应用管理
创建并管理应用
通过 BusinessId 细分配置下发
Token 鉴权
使用 Token 鉴权
更换 AppKey
音频管理
设置音频属性
播放音效文件
使用混音功能
美声和音频降噪
音频音量
空间音频
范围语音
Web 端音频降噪
获取原始音频数据
Native 端获取原始音频数据
Web 端获取原始音频数据
自定义音频采集和渲染
Native 端自定义音频采集和渲染
Web 端自定义音视频采集
自定义音频处理
视频管理
移动端多前台任务
设置视频发布参数
镜像
美颜
智能美化特效（付费版）
基础美颜（免费版）
Native 端基础美颜
Web 端基础美颜
Electron 基础美颜
Flutter 基础美颜
虚拟背景
Native 端虚拟背景
Web 端虚拟背景
视频采集旋转方向
添加视频水印
视频帧朝向
自定义视频采集
自定义视频渲染
自定义视频编解码
自定义视频处理
Native 端自定义视频处理
Electron 端自定义视频处理
音视频设备管理
移动端设置音频路由
设备检测
摄像头检测
麦克风检测
扬声器检测
设备权限处理
设备异常处理
通话前网络检测
Native 端通话前网络质量检测
Web 端通话前网络质量检测
使用 Simulcast 功能
推送多分辨流视频流和自动回退【V3.60 及之后版本】
音视频流自动回退和恢复【V3.58 及此前版本】
推送多分辨率视频流【V3.58 及此前版本】
订阅模式设置
同一用户加入多个房间
跨房间转发媒体流
开启音频选路
发布和订阅 WTN 流
转推直播
关于转推直播
客户端发起转推直播
集成最佳实践
在防火墙限制下进行通话
通过媒体内容发送补充信息
屏幕共享
Android 端屏幕共享
iOS 端屏幕共享
PC 端屏幕共享
macOS 端安装虚拟声卡
Web 端屏幕共享
通过 Electron SDK 实现 PC 端屏幕共享
Electron 架构下通过 Web SDK 实现屏幕共享
Flutter 屏幕共享
云端录制
关于云端录制
自定义录制文件名
在控制台开启&关闭云端录制
自动录制
录制布局模式
本地服务端录制
产品概述
资源获取
开启本地服务端录制
收集崩溃日志
性能数据
实时通话字幕和翻译
音视频内容安全
输入在线媒体流
Web 端视频截图处理
SDK 日志文件配置
Flutter 开发指南
连接状态提示
通话质量监测
监控台
数据和统计
查看通话数据
诊断通话
根据异常类型诊断（用户体验诊断）
通过诊断工具深入诊断
实时监控
告警通知
嵌入 RTC 监控台
访问控制
最佳实践
按需集成插件以缩小应用体积
通话打断和恢复
客户端 API 参考
Android 3.60
概览
API 详情
回调
错误码
类型详情
iOS 3.60
概览
API 详情
回调
错误码
类型详情
macOS 3.60
概览
API 详情
回调
错误码
类型详情
Windows 3.60
概览
API 详情
回调
错误码
类型详情
Linux 3.60
概览
API 详情
回调
错误码
类型详情
Web 4.67
概览
API 详情
事件
错误码
数据类型
微信小程序 3.3
概览
API 详情
事件
错误码
Electron 3.58
概览
API 详情
回调
错误码
类型详情
Flutter 3.58
Unity 3.58
概览
API 详情
回调
错误码
类型详情
React Native 3.58
概览
API 详情
回调
错误码
类型详情
服务端 API 参考
API 列表
调用方法
如何调用 OpenAPI
服务接入点
公共参数
签名方法
返回结构
公共错误码
服务端回调
开通消息通知服务
回调格式参考
消息事件参考
接收消息通知回调
房间管理
封禁音视频流 BanUserStream
解封音视频流 UnbanUserStream
封禁房间&用户 BanRoomUser
更新房间&用户封禁规则 UpdateBanRoomUserRule
获取实时用户列表 GetRoomOnlineUsers
查询用户状态 GetRoomUsersProperty
限制 Token 发布权限 LimitTokenPrivilege
（不推荐使用）移出用户 KickUser
（不推荐使用）解散房间 DismissRoom
云端录制
开始云端录制 StartRecord
更新云端录制 UpdateRecord
结束云端录制 StopRecord
查询录制任务状态 GetRecordTask
转推直播
开始合流转推 StartPushMixedStreamToCDN
开始单流转推 StartPushSingleStreamToCDN
更新合流转推 UpdatePushMixedStreamToCDN
结束转推直播 StopPushStreamToCDN
查询单流转推任务状态 GetPushSingleStreamToCDNTask
查询合流转推任务状态 GetPushMixedStreamToCDNTask
音频切片
开启音频切片 StartSegment
更新音频切片 UpdateSegment
结束音频切片 StopSegment
查询音频切片任务状态 GetSegmentTask
抽帧截图
开启抽帧截图 StartSnapshot
更新抽帧参数 UpdateSnapshot
关闭抽帧截图 StopSnapshot
查询抽帧截图任务状态 GetSnapshotTask
输入在线媒体流
开始在线媒体流输入 StartRelayStream
更新在线媒体流输入 UpdateRelayStream
停止在线媒体流输入 StopRelayStream
查询输入媒体流任务 ListRelayStream
WTN 流
发布 WTN 流 StartPushPublicStream
更新 WTN 流 UpdatePublicStreamParam
停止 WTN 流 StopPushPublicStream
云录屏
开启云录屏 StartWebcast
结束云录屏 StopWebcast
查询云录屏任务状态 GetWebCastTask
实时数据监控
获取通话时长数据 ListRealTimeQuality
获取实时运营数据 ListRealTimeOperationData
获取实时分布质量数据 ListRealTimeQualityDistribution
获取通话质量指标 ListCallDetail
获取实时公共流订阅数据 ListRealTimePublicStreamInfo
历史数据查询
获取离线数据指标 ListQuality
获取离线运营数据 ListOperationData
获取离线运营分布数据 ListOperationDistribution
获取离线分布质量数据 ListQualityDistribution
获取离线通话房间列表 ListRoomInfo
获取离线用户通话详情 ListUserInfo
获取通话时长数据 ListUsages
应用管理
创建应用 CreateApp
查询应用 ListApps
启用&停用应用 ModifyAppStatus
业务标识管理
添加业务标识 AddBusinessID
修改业务标识名称 ModifyBusinessRemarks
获取业务标识 GetAllBusinessID
删除业务标识 DeleteBusinessID
实时消息通信
发送房间外点对点消息 SendUnicast
发送房间内点对点消息 SendRoomUnicast
发送房间内广播消息 SendBroadcast
批量发送房间内点对点消息 BatchSendRoomUnicast
音视频内容安全
开启审核 StartDetection
停止审核 StopDetection
任务状态查询 ListDetectionTask
回调审核结果 DetectionResult
实时通话字幕和翻译
开启实时字幕 StartSubtitle
更新实时字幕 UpdateSubtitle
停止实时字幕 StopSubtitle
历史版本（文档停止维护）
2024-06-01
实时对话式AI
启动智能体 StartVoiceChat（请使用新版 API）
更新智能体 UpdateVoiceChat
关闭智能体 StopVoiceChat
2023-08-01
房间管理
获取实时用户列表 GetRoomOnlineUsers
2023-06-01
转推直播
开始合流转推 StartPushMixedStreamToCDN
开始单流转推 StartPushSingleStreamToCDN
更新合流转推 UpdatePushMixedStreamToCDN
结束转推直播 StopPushStreamToCDN
查询合流转推任务状态 GetPushMixedStreamToCDNTask
GetPushSingleStreamToCDNTask - 查询单流转推任务状态 GetPushSingleStreamToCDNTask
云端录制
StartRecord - 开始云端录制 StartRecord
更新云端录制 UpdateRecord
结束云端录制 StopRecord
查询录制任务状态 GetRecordTask
2022-06-01
云端录制
开始云端录制 StartRecord
更新云端录制 UpdateRecord
结束云端录制 StopRecord
查询录制任务状态 GetRecordTask
音频切片
开启音频切片 StartSegment
更新音频切片 UpdateSegment
结束音频切片 StopSegment
查询音频切片任务状态 GetSegmentTask
抽帧截图
开启抽帧截图 StartSnapshot
更新抽帧参数 UpdateSnapshot
关闭抽帧截图 StopSnapshot
查询抽帧截图任务状态 GetSnapshotTask
2020-12-01
房间管理
解封音视频流 UnbanUserStream
封禁音视频流 BanUserStream
封禁房间&用户 BanRoomUser
更新房间&用户封禁规则 UpdateBanRoomUserRule
云端录制
开始云端录制 StartRecord
更新云端录制 UpdateRecord
结束云端录制 StopRecord
查询录制任务状态 GetRecordTask
转推直播
开始合流转推 StartPushMixedStreamToCDN
开始单流转推 StartPushSingleStreamToCDN
更新合流转推 UpdatePushMixedStreamToCDN
结束转推直播 StopPushStreamToCDN
查询合流转推任务状态 GetPushMixedStreamToCDNTask
查询单流转推任务状态 GetPushSingleStreamToCDNTask
音频切片
开启音频切片 StartSegment
更新音频切片 UpdateSegment
结束音频切片 StopSegment
抽帧截图
开启抽帧截图 StartSnapshot
更新抽帧参数 UpdateSnapshot
关闭抽帧截图 StopSnapshot
输入在线媒体流
开始在线媒体流输入 StartRelayStream
更新在线媒体流输入 UpdateRelayStream
停止在线媒体流输入 StopRelayStream
查询输入媒体流任务 ListRelayStream
公共流
发布公共流 StartPushPublicStream
更新公共流 UpdatePublicStreamParam
停止发布公共流 StopPushPublicStream
云录屏
开启云录屏 StartWebcast
结束云录屏 StopWebcast
查询云录屏任务状态 GetWebCastTask
获取数据指标
获取通话时长数据 ListUsages
获取离线质量数据 ListQuality
获取离线运营数据 ListOperationData
获取实时质量数据 ListRealTimeQuality
获取实时分布质量数据 ListRealTimeQualityDistribution
获取通话质量指标 ListCallDetail
获取离线通话房间列表 ListRoomInfo
获取离线用户通话详情 ListUserInfo
获取离线分布质量数据 ListQualityDistribution
获取实时运营数据 ListRealTimeOperationData
获取离线运营指标维度分布数据 ListOperationDistribution
获取通话时长数据 ListUsages
应用管理
创建应用 CreateApp
启用&停用应用 ModifyAppStatus
查询应用 ListApps
实时消息通信
发送房间外点对点消息 SendUnicast
发送房间内点对点消息 SendRoomUnicast
发送房间内广播消息 SendBroadcast
批量发送房间内点对点消息 BatchSendRoomUnicast
音视频内容安全
开启审核 StartDetection
停止审核 StopDetection
任务状态查询 ListDetectionTask
附录
常见问题
基础功能咨询
集成相关
参数赋值规范
Android 集成常见问题
iOS 集成常见问题
macOS 集成常见问题
Electron 集成常见问题
切换自定义和内部视频采集/编码模块
房间管理相关问题
自定义视频前处理相关
如何创建和配置 App Group
Web 端自动播放策略
通话音量和媒体音量有什么区别？
Token 使用常见问题
如何在 Visual Studio 中安装 Qt 扩展？
为什么通过系统音量无法调节背景音乐音量
质量相关
消除音频噪声
Native 排查无声问题
Web 排查无声问题
排查音频卡顿问题
排查视频卡顿问题
排查摄像头启动异常
排查视频模糊问题
排查视频画面异常
开启摄像头时，画面初始偏暗，逐渐变亮
用户网络带宽推荐
Web 排查设备权限获取失败问题
微信小程序 SDK 相关
与其他端互通
微信小程序 SDK 媒体能力上限
微信小程序端显示远端用户的音视频设备状态
如何解决暂停接收远端视频流后音频出现高延时
如何解决网络断开重连后用户无法进房
uni-app 编译报错 TypeError: Converting circular structure to JSON
历史版本文档
实时对话式 AI
什么是实时对话式 AI
Demo 体验
快速集成
前置准备
集成实时对话式 AI（软件应用）
集成实时对话式 AI（嵌入式硬件）
进阶功能
接入端到端实时语音大模型
大模型配置
语音识别配置
语音合成配置
实时字幕（对话记录）
上下文管理
接入记忆库（长期记忆）
打断智能体
配置对话触发模式
语音降噪
控制语音播报内容
自定义语音播放
Function Calling（流式返回结果）
视觉理解能力
与数字人对话
接入联网问答 Agent
接入 MCP
接入第三方大模型或 Agent
接入自定义 ASR 或 TTS
接收智能体状态
接收智能体任务状态及报错信息
管理大模型上下文
API 参考
调用方法
启动智能体 StartVoiceChat
更新智能体 UpdateVoiceChat
关闭智能体 StopVoiceChat
声纹管理
注册声纹 RegisterVoicePrint
更新声纹 UpdateVoicePrint
查询声纹 ListVoicePrint
删除声纹 DeleteVoicePrint
事件和错误码
对话式 AI FAQ
对话式 AI 功能咨询
对话式 AI 如何实现联网能力？
对话式 AI 如何接入知识库 RAG？
如何提升语音识别准确性？
如何提升多语言 AI 交互体验？
如何降低对话延迟？
智能体未进房或未正常工作？
对话式 AI 计费
发版说明
硬件对话智能体
什么是硬件对话智能体
硬件对话智能体计费
获取 SDK
快速集成
前置准备
集成硬件对话智能体（高质量方案）
集成硬件对话智能体（低负载方案）
控制台操作
产品管理
设备管理
智能体管理
进阶功能
接入 MCP
接入联网问答 Agent
接入记忆库（长期记忆）
客户端 API
概述
API 参考
回调
数据类型
服务端 API
调用方法
创建智能体 AibotCreate
更新智能体 AibotUpdate
删除智能体 AibotDelete
查询智能体 AibotQuery
关联智能体到产品或设备 AibotBind
取消关联智能体与产品/设备 AibotUnbind
查询指定产品或设备关联的智能体 AibotDescribeBinding
附录
Cluster ID 和模型列表
实时信令
什么是实时信令
使用限制
质量指标
RTS 计量计费
实时信令开发指南
客户端与客户端通信
客户端与业务服务器通信
RTS SDK
SDK 概览
RTS SDK 发版说明
下载 RTS SDK
体验 RTS Demo
跑通 RTS 快速开始 Demo
Android
iOS
Web
RTS SDK API 参考
Android 3.54
概览
API 详情
回调
错误码
类型详情
iOS 3.54
概览
API 详情
回调
错误码
类型详情
Web 4.54
概览
API 详情
事件
错误码
数据类型
互动白板
什么是互动白板
获取 SDK 和 Demo
SDK 概览
获取 SDK
体验 Demo
产品计费
白板计费规则
欠费说明
体验和跑通白板 Demo
Android
iOS
Web
构建白板应用
Android
iOS
Web
Electron
微信小程序
高级功能
自定义光标图标
文档上传
在 RTC 房间共享白板
白板录制
客户端 API 参考
白板 SDK 发版说明
Android
概览
API 详情
回调
类型详情
iOS
概览
API 详情
回调
错误码
类型详情
Web
概览
API 详情
回调
错误码
类型详情
版本升级指引
微信小程序
概览
API 详情
回调
错误码
类型详情
Open API 参考
API 列表
文档转码
发起文档转码任务
查询文档转码进度 WbTranscodeQuery
获取转码输出链接 WbTranscodeGet
白板录制
创建白板录制任务 StartWBRecord
结束白板录制任务 StopWBRecord
白板错误码
附录
历史版本
文档转码
发起文档转码任务 WbTranscodeCreate
查询文档转码进度 WbTranscodeQuery
获取转码输出链接 WbTranscodeGet
白板录制
创建白板录制任务 StartWBRecord
结束白板录制任务 StopWBRecord
白板常见问题
查看历史版本文档
即时通讯 IM
什么是即时通讯 IM
发版说明
客户端 SDK
C++ SDK
服务端 OpenAPI
产品计费
计费规则
欠费说明
获取 SDK 和 Demo
快速开始
开通服务
Token 鉴权
不含 UI 集成方案
Android
iOS
Web
微信小程序
Mac
Windows
HarmonyOS Next
含 UI 集成方案
Android
iOS
Web
跑通快速开始 Demo
Android
iOS
Web
Mac
Windows
微信小程序
HarmonyOS Next
高级功能
消息相关
会话相关
群组相关
直播群功能
好友关系
用户资料
控制台功能
简介
应用管理
数据统计
第三方回调
开通回调通知服务
回调签名验证
回调格式参考
回调事件列表
客户端 API 参考
Android
概览
API 详情
回调
错误码
类型详情
iOS
概览
API 详情
回调
错误码
类型详情
C++
概览
API 详情
回调
错误码
类型详情
Web
概览
API 详情
事件
错误码
类型详情
微信小程序
概览
API 详情
事件
错误码
类型详情
HarmonyOS Next
概览
API 详情
事件
错误码
类型详情
服务端 API 参考
服务端 OpenAPI
API 列表
调用 OpenAPI
对 OpenAPI 请求进行签名
服务端 SDK
Java SDK
Go SDK
成员相关
会话成员管理
批量添加群聊成员 BatchAddConversationParticipant
批量删除群聊成员 BatchDeleteConversationParticipant
批量修改群聊成员详情 BatchModifyConversationParticipant
批量禁言/拉黑会话成员 BatchAddBlockParticipants
批量取消禁言/取消拉黑会话成员 BatchDeleteBlockParticipants
批量添加直播群管理员 BatchAddManager
批量移除直播群管理员 BatchRemoveManager
批量添加全员禁言下白名单成员 BatchAddWhitelistParticipant
批量移除全员禁言下白名单成员 BatchRemoveWhitelistParticipant
更新直播群成员资料 BatchUpdateLiveParticipants
会话成员查询
查询会话成员数量 GetConversationUserCount
分批扫描群聊中的成员详细信息 ScanConversationParticipantList
批量查询会话成员详细信息 BatchGetConversationParticipant
判断用户是否在会话中 IsUserInConversation
分批获得禁言/拉黑成员列表 BatchGetBlockParticipants
批量查询全员禁言下白名单成员 BatchGetWhitelistParticipant
查询直播群成员状态 QueryLiveParticipantStatus
会话相关
会话管理
创建会话 CreateConversation
修改会话信息 ModifyConversation
修改用户对会话的设置 ModifyConversationSetting
解散群聊 DestroyConversation
标记会话 MarkConversation
会话查询
查询成员对会话的设置 GetConversationSetting
查询用户拥有会话 GetUserConversations
批量查询会话 BatchGetConversations
会话标记查询 GetConversationMarks
消息相关
消息管理
发送消息 SendMessage
删除用户消息 DeleteMessage
删除会话消息 DeleteConversationMessage
撤回用户消息 RecallMessage
修改消息扩展字段 ModifyMessage
批量发单聊消息 BatchSendMessage
发送透传消息 P2PSendMessage
批量发送群聊/直播群消息 BatchSendGroupMessage
发送用户透传消息
消息查询
批量查询消息 GetMessages
分批查询会话中的消息 GetConversationMessages
已读回执
获取消息的已读回执详情
用户相关
用户状态
查询用户在线状态 QueryOnlineStatus
好友管理
添加好友 AddFriend
删除好友 DeleteFriend
更新好友 UpdateFriend
查询好友列表 ListFriend
校验好友关系 IsFriend
黑名单管理
添加黑名单 AddBlackList
移出黑名单 RemoveBlackList
更新黑名单 UpdateBlackList
查询黑名单 GetBlackList
校验用户是否在黑名单 IsInBlackList
全员广播
更新用户标签 BatchUpdateUserTags
全员广播
用户注册
注册用户 RegisterUsers
注销用户 UnRegisterUsers
用户资料
更新用户资料 BatchUpdateUser
查询用户资料
获取 Token GetAppToken
数据结构
错误码
关于产品
产品术语
相关协议
视频云服务专用条款
【即时通讯】服务等级协议
即时通讯 IM SDK 协议
即时通讯 IM（SDK）隐私政策
即时通讯 IM（SDK）开发者使用合规规范
IM 扩展功能说明目录
即时通讯 IM 应用协议
veIM（应用）免责声明
veIM（应用）隐私政策
veIM（应用）用户协议
veIM（应用）个人信息收集清单
veIM（应用）申请操作系统权限列表
veIM（应用）第三方信息共享清单
常见问题
相关协议
视频云服务专用条款
【实时音视频】服务等级协议
开源软件合规声明
veRTC（SDK）协议
veRTC（SDK）隐私政策
veRTC（SDK）开发者使用合规规范
veRTC（应用）协议
veRTC（应用）免责声明
veRTC（应用）隐私政策
veRTC（应用）用户协议
veRTC（应用）第三方信息共享清单
veRTC（应用）个人信息收集清单
veRTC（应用）申请操作系统权限列表
文档首页
/
实时音视频
/
实时音视频
/
服务端 API 参考
/
历史版本（文档停止维护）
历史版本（文档停止维护）
2024-06-01
2023-08-01
2023-06-01
2022-06-01
2020-12-01