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

查询黑名单 GetBlackList

最近更新时间：2023.10.30 19:49:37

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

我的收藏

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

接口行为

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

调用接口

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

接口限制

QPS 不得超过 100。

请求方式

使用 POST 方式发起请求。

请求参数

Query

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

Body

参数名类型必填示例值描述
AppIdInt是000000应用的唯一标志
UserIdInt是10001被查询用户的 UserId
InboxTypeInt否0信箱，用做逻辑隔离。默认值为 0
CursorInt是0查询起始位置，按照添加顺序逆序查询。默认值为 0，即最后一个添加至黑名单的用户。
LimitInt是0查询条数，每次最多查询 20 位用户。
NeedTotalBool否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 的结构如下：

参数名类型描述
BlackListInfosArray of BlackListInfo黑名单用户详细信息
TotalCountInt黑名单用户总数
HasMoreBool是否还有下一页
NewCursorInt下一页起始下标。为负时表示后续没有成员数据

BlackListInfo

参数名类型描述
BlackListUserIdInt黑名单用户 ID
BlackListUserExtMap-key(string)-value(string)黑名单用户扩展字段
CreateTimeInt加入黑名单的时间
ModifyTimeInt黑名单更新时间
FriendUserInfoFriendInfo好友信息。若黑名单用户并不是查询用户好友则不返回此字段。

FriendInfo

参数名类型描述
FriendUserIdInt好友 UserId
ExtString好友扩展字段
CreateTimeInt成为好友的时间
ModifyTimeInt好友更新时间
ApplyTimeInt发起好友申请时间
AliasString好友备注

正常返回示例

{
    "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
    }
}