You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /
  • 实时音视频

限制 Token 发布权限 LimitTokenPrivilege

最近更新时间：2024.04.11 11:50:52

首次发布时间：2024.01.03 20:25:18

我的收藏

如果你需要限制某个用户指定 Token 的发布权限，你可以使用此接口。

使用说明

接口行为

你可以使用此接口，指定你所属的 AppId和RoomId，限制用户指定 Token 发布权限。

限制 Token 发布权限后，正在发布的用户会立即停止发布。未发布的用户在限制时间内无法进行发布。
正在发布的用户权限被禁止时：

调用接口

关于调用接口的请求结构、公共参数、签名算法和返回结构，参看调用方法。

注意事项

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
是
Your_AppId
你的音视频应用的唯一标志
RoomId
String
是
Your_RoomId
指定房间 ID
UserId
String
是
Your_UserId
指定用户 ID
Token
String
是
Your_Token
需要限制发布权限的 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" : "Your_AppId",
    "RoomId" : "Your_RoomId",   
    "UserId" : "Your_UserId",
    "Token" : "Your_Token",
    "ForbiddenInterval" : 60   
}

返回示例

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

错误码

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