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

移出黑名单 RemoveBlackList

最近更新时间：2023.09.25 19:45:01

首次发布时间：2023.09.25 19:45:01

我的收藏

你可以使用此接口将用户移出黑名单。

接口行为

你可以调用 RemoveBlackList 接口，指定你所属的 AppId、用户 ID 和黑名单中的用户 ID，将黑名单中的用户移出黑名单。一次最多支持将 10 个用户移出黑名单。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用 OpenAPI。

接口限制

QPS 不得超过 50。

请求方式

使用 POST 方式发起请求。

请求参数

Query

参数名类型必填示例值描述
ActionString是RemoveBlackList接口名称，本接口取值：RemoveBlackList
VersionString是2020-12-01接口版本，本接口取值：2020-12-01

Body

参数名类型必填示例值描述
AppIdInt是000000应用的唯一标志
UserIdInt是10001用户 ID
InboxTypeInt否0信箱，用做逻辑隔离。默认值为 0
BlackListUserIdsArray of Int是[10002，10003]需要移出黑名单的用户的 ID，一次最多移出 10 个用户

请求示例代码

Query

https://rtc.volcengineapi.com?Action=RemoveBlackList&Version=2020-12-01

Body

{
    "AppId":000000,
    "UserId":10001,
    "InboxType":0,
    "BlackListUserIds":[10002，10003]
}

返回调用结果

返回参数说明

返回结果参看 BaseResponse。

成功时 Result 返回为空。

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "RemoveBlackList",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
    }
}