查询黑名单 GetBlackList--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

查询黑名单 GetBlackList

最近更新时间：2023.10.30 19:49:37首次发布时间：2023.09.25 19:45:01

你可以使用此接口查询指定用户的黑名单列表。

接口行为

你可以调用 GetBlackList 接口，指定你所属的AppId、用户 ID，分页查询对应的黑名单列表。

调用接口

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

接口限制

QPS 不得超过 100。

请求方式

使用 POST 方式发起请求。

请求参数

Query

参数名	类型	必填	示例值	描述
Action	String	是	`GetBlackList`	接口名称，本接口取值：`GetBlackList`
Version	String	是	`2020-12-01`	接口版本，本接口取值：`2020-12-01`

Body

参数名	类型	必填	示例值	描述
AppId	Int	是	`000000`	应用的唯一标志
UserId	Int	是	`10001`	被查询用户的 UserId
InboxType	Int	否	`0`	信箱，用做逻辑隔离。默认值为 `0`
Cursor	Int	是	`0`	查询起始位置，按照添加顺序逆序查询。默认值为 `0`，即最后一个添加至黑名单的用户。
Limit	Int	是	`0`	查询条数，每次最多查询 20 位用户。
NeedTotal	Bool	否	`false`	是否需要黑名单用户总数。 `false`：不需要。 `true`：需要。默认值为 `false`。

请求示例代码

Query

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

Body

{
    "AppId":000000,
    "UserId":10001,
    "InboxType":0,
    "Cursor":0,
    "Limit":4,
    "NeedTotal":true
}

返回调用结果

返回参数说明

返回结果参看 BaseResponse。
其中 Result 的结构如下：

参数名	类型	描述
BlackListInfos	Array of BlackListInfo	黑名单用户详细信息
TotalCount	Int	黑名单用户总数
HasMore	Bool	是否还有下一页
NewCursor	Int	下一页起始下标。为负时表示后续没有成员数据

BlackListInfo

参数名	类型	描述
BlackListUserId	Int	黑名单用户 ID
BlackListUserExt	Map-key(string)-value(string)	黑名单用户扩展字段
CreateTime	Int	加入黑名单的时间
ModifyTime	Int	黑名单更新时间
FriendUserInfo	FriendInfo	好友信息。若黑名单用户并不是查询用户好友则不返回此字段。

FriendInfo

参数名	类型	描述
FriendUserId	Int	好友 UserId
Ext	String	好友扩展字段
CreateTime	Int	成为好友的时间
ModifyTime	Int	好友更新时间
ApplyTime	Int	发起好友申请时间
Alias	String	好友备注

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "GetBlackList",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "BlackListInfos": [
            {
                "BlackListUserId": 10002,
                "BlackListUserExt": {
                    "key": "value"
                },
                "CreateTime": 1695212941890,
                "ModifyTime": 1695212941890,
                "FriendUserInfo": {
                    "FriendUserId": 100,
                    "Ext": {
                        "key": "value"
                    },
                    "CreateTime": 1689685807559,
                    "ModifyTime": 1689685807559,
                    "ApplyTime": 1689685807559,
                    "Alias": "Alias1"
            },
            {
                "BlackListUserId": 10003,
                "BlackListUserExt": {
                    "key": "value"
                },
                "CreateTime": 1695212542003,
                "ModifyTime": 1695212542003
            },
            {
                "BlackListUserId": 10004,
                "BlackListUserExt": {
                    "key": "value"
                },
                "CreateTime": 1695211987986,
                "ModifyTime": 1695211987986
            }
        ],
        "TotalCount": 3,
        "HasMore": false,
        "NextCursor": -1
    }
}