限制 Token 发布权限 LimitTokenPrivilege--实时音视频-火山引擎

文档中心

立即注册

实时音视频

请输入

房间管理

限制 Token 发布权限 LimitTokenPrivilege

本文档 API 接口为最新版本接口，后续相关功能的新增都会在此更新，推荐使用最新版本接口。旧版接口文档请参考历史版本。

在实时音视频通话场景中，若你需要对特定用户设定发布权限的限制，可以通过调用此接口实现。

通过指定应用标识、房间 ID、用户 ID 以及需要限制的 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	是	`661e****543cf`	你的音视频应用的唯一标志，参看获取 AppId。
RoomId	String	是	`Room1`	指定房间 ID
UserId	String	是	`User1`	指定用户 ID
Token	String	是	`001661e****543cf80`	需要限制发布权限的 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": "661e****543cf",
    "RoomId": "Room1",
    "UserId": "user1",
    "Token": "001661e****543cf80",
    "ForbiddenInterval": 60
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230****10420",
        "Action": "LimitTokenPrivilege",
        "Version": "2023-11-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "Message": "success",
        "EndTime": 1681660939
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。

最近更新时间：2025.11.10 19:15:08

这个页面对您有帮助吗？

有用

无用