You need to enable JavaScript to run this app.
文档中心
实时音视频

实时音视频

复制全文
下载 pdf
房间管理
解封音视频流 UnbanUserStream
复制全文
下载 pdf
解封音视频流 UnbanUserStream
本文档 API 接口为最新版本接口,后续相关功能的新增都会在此更新,推荐使用最新版本接口。旧版接口文档请参考历史版本。​
调用 UnbanUserStream 接口,恢复指定用户在房间内发布音频或视频流的权限。解封后,房间内其他用户会收到相应通知(onVideoStreamBanned/onAudioStreamBanned)。​
注意事项​
请求频率:QPS 不得超过 60。​
请求说明​
  • 请求方式:POST​
  • 请求地址:https://rtc.volcengineapi.com?Action=UnbanUserStream&Version=2023-11-01​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Query​
Action String 必选 示例值:UnbanUserStream​
接口名称。当前 API 的名称为 UnbanUserStream。​
​
Version String 必选 示例值:2023-11-01​
接口版本。当前 API 的版本为 2023-11-01。​
​
​
Body​
AppId String 必选 示例值:66****3cf​
实时音视频应用的 AppId。可在控制台获取。​
​
RoomId String 必选 示例值:Room1​
用户所在房间的 ID。​
​
UserId String 必选 示例值:User1​
需解封流的目标用户 ID。​
​
Video Boolean 可选 示例值:true​
是否解封视频流:​
  • true:解封。​
  • false(默认值):不解封。​
​
Audio Boolean 可选 示例值:true​
是否解封音频流:​
  • true:解封。​
  • false(默认值):不解封。​
​
​
返回参数​
下表仅列出本接口特有的返回参数,公共返回参数请参见返回结构。​
Message String 示例值:success​
仅在请求成功时返回消息 "success", 失败时为空。​
​
​
请求示例​
​
POST https://rtc.volcengineapi.com?Action=UnbanUserStream&Version=2023-11-01​
{​
"AppId": "66****3cf",​
"RoomId": "Room1",​
"UserId": "User1",​
"Video": true,​
"Audio": true​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420",​
"Action": "UnbanUserStream",​
"Version": "2023-11-01",​
"Service": "rtc",​
"Region": "cn-north-1"​
},​
"Result": {​
"Message": "success"​
}​
}​
​
错误码​
您可访问公共错误码,获取更多错误码信息。​
最近更新时间:2026.03.13 10:26:43
这个页面对您有帮助吗?
有用
有用
无用
无用