实时音视频
实时音视频
文档指南
请输入
- 文档首页
实时音视频实时音视频服务端 API 参考房间管理限制 Token 发布权限 LimitTokenPrivilege
复制全文
下载 pdf限制 Token 发布权限 LimitTokenPrivilege
文档反馈
问问助手调用 LimitTokenPrivilege 接口，禁止指定用户在规定时间内使用特定凭证（Token）发布音视频流。此操作会立即停止正在发布的用户，并通知订阅端。
调用后，接口将返回操作结果及权限限制的结束时间，确保你能够有效管理音视频流的发布权限。
使用说明
接口行为
限制 Token 发布权限后，正在发布的用户会立即停止发布。未发布的用户在限制时间内无法进行发布。
正在发布的用户权限被禁止时：
- 发布端 SDK 会收到回调 onStreamStateChanged，错误码为 ERROR_CODE_NO_PUBLISH_PERMISSION -1002。
- 订阅端 SDK 会收到回调 onUserpublishStreamVideo 或 onUserpublishStreamAudio。
注意事项
- 在调用该接口前需要前往控制台开启连麦鉴权。
- QPS 不得超过 40。
请求说明
- 请求方式：POST
- 请求地址：https://rtc.volcengineapi.com?Action=LimitTokenPrivilege&Version=2023-11-01
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Query
Action String 必选 示例值：LimitTokenPrivilege
接口名称。当前 API 的名称为 LimitTokenPrivilege。
Version String 必选 示例值：2023-11-01
接口版本。当前 API 的版本为 2023-11-01。
Body
AppId String 必选 示例值：66****3cf
RoomId String 必选 示例值：Room1
指定房间 ID。
UserId String 必选 示例值：User1
指定用户 ID。
Token String 必选 示例值：00*****f80
需要限制发布权限的 Token。
ForbiddenInterval Integer 必选 示例值：60
限制 Token 发布权限时长，取值范围为 [60,259200]，单位为秒。
- 若传入值大于 0，且小于 60，自动修改为 60。
- 若传入值大于 259200，自动修改为 259200。
返回参数
Message String 示例值：success
请求成功时返回 “Success”，失败时为空。
EndTime Integer 示例值：1681660939
Token 权限限制结束时间，Unix 时间，单位为秒。
请求示例
POST https://rtc.volcengineapi.com?Action=LimitTokenPrivilege&Version=2023-11-01
{
"AppId": "66****3cf",
"RoomId": "Room1",
"UserId": "User1",
"Token": "00*****f80",
"ForbiddenInterval": 60
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20230604110420",
"Action": "LimitTokenPrivilege",
"Version": "2023-11-01",
"Service": "rtc",
"Region": "cn-north-1"
},
"Result": {
"Message": "success",
"EndTime": 1681660939
}
}
错误码
最近更新时间：2026.07.18 23:50:58
这个页面对您有帮助吗？
有用
有用
无用
无用