批量查询全员禁言下白名单成员 BatchGetWhitelistParticipant--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

批量查询全员禁言下白名单成员 BatchGetWhitelistParticipant

最近更新时间：2024.02.20 15:21:53首次发布时间：2023.06.21 18:41:10

你可以使用此接口批量查询全员禁言下白名单成员。

使用说明

接口行为

你可以调用BatchGetWhitelistParticipant接口，指定你所属的AppId、会话 ID、查询起始位置和查询条数批量查询全员禁言下白名单成员。

目前仅直播群支持此接口

调用接口

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

注意事项

QPS 不得超过 100。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
AppId	Integer	是	`000000`	应用的唯一标志
ConversationShortId	Long	是	`000001`	会话 ID
Cursor	Long	是	`0`	查询起始位置
Limit	Long	是	`20`	每批查询条数。最大值为 `20`。

返回参数

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

参数	类型	示例值	描述
NextCursor	Long	`-1`	下一批数据起始位置。`-1`表示无更多数据。
HasMore	Boolean	`true`	是否还有更多数据
Participants	Array of WhitelistParticipant	`-`	白名单成员信息

WhitelistParticipant

参数	类型	示例值	描述
ParticipantUserId	Long	`10002`	白名单成员 UserId
CreateTime	Long	`1686406665`	用户加入白名单时间，单位为秒
Operator	Long	`10001`	执行加入白名单操作操作人 UserId
NickName	String	`Your_NickName`	白名单成员昵称
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=BatchGetWhitelistParticipant&Version=2020-12-01
{
    "AppId": 00000,
    "ConversationShortId": 000001,
    "Cursor": 0,
    "Limit": 20
}

返回示例

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

错误码

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