分批获得禁言/拉黑成员列表 BatchGetBlockParticipants--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

分批获得禁言/拉黑成员列表 BatchGetBlockParticipants

最近更新时间：2024.02.20 15:22:49首次发布时间：2023.05.25 18:20:26

你可以使用此接口分批在直播群中获得禁言或拉黑成员列表。

使用说明

接口行为

你可以调用 BatchGetBlockParticipants 接口，指定你所属的 AppId、会话 ID、会话成员 UserId 列表和具体的操作行为，批量获取禁言或拉黑成员列表。
查询到的禁言/拉黑成员列表会按照成员 UserId 从小到大进行排序。

目前仅直播群支持此接口

调用接口

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

注意事项

QPS 不得超过 100。

请求说明

请求方式：POST
请求地址：https://rtc.volcengineapi.com?Action=BatchGetBlockParticipants&Version=2020-12-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`BatchGetBlockParticipants`	接口名称。当前 API 的名称为 `BatchGetBlockParticipants`。
Version	String	是	`2020-12-01`	接口版本。当前 API 的版本为 `2020-12-01`。

Body

参数	类型	是否必选	示例值	描述
AppId	Integer	是	`000000`	应用的唯一标志
ConversationShortId	Long	是	`000001`	会话 ID
BlockAction	Integer	否	`0`	操作行为 `0`：获取禁言列表 `1`：获取拉黑列表默认为 `0`。
Cursor	Long	是	`0`	分批起始位置
Limit	Long	是	`20`	每批查询条数，最大值为 `20`。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
HasMore	Boolean	`false`	是否还有更多数据
NextCursor	Long	`10003`	下一批数据起始位置
Participants	Array of BlockParticipant	`-`	禁言/拉黑成员列表

BlockParticipant

参数	类型	示例值	描述
ParticipantUserId	Long	`10001`	群成员 ID
CreateTime	Long	`1682321838`	禁言/拉黑设置对应的时间戳，单位为秒
BlockTime	Long	`1682327838`	禁言/拉黑到何时对应时间戳，单位为秒
NickName	String	`xxxx`	禁言/拉黑成员昵称
Ext	JSON Map	`{"key":"value"}`	禁言/拉黑成员扩展字段。`key` 的类型为 string，`value` 的类型为 string。
AvatarUrl	String	`https://xxxx.com`	禁言/拉黑成员头像
Marks	Array of String	`["Mark1","Mark2"]`	直播群群成员标记

请求示例

POST https://rtc.volcengineapi.com?Action=BatchGetBlockParticipants&Version=2020-12-01
{
    "AppId": 000000,
    "ConversationShortId": 0000001,
    "Cursor": 0,
    "Limit": 20
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "BatchGetBlockParticipants",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "HasMore": false,
        "NextCursor": -1,
        "Participants": [
            {
                "ParticipantUserId": 10002,
                "CreateTime": 1703753226,
                "BlockTime": 1703756826,
                "NickName": "Your_NickName",
                "Ext": {
                    "key":"value"
                },
                "AvatarUrl": "https://xxxx.com",
                "Marks": ["Mark1","Mark2"]
            }
        ]
    }
}

错误码

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