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

接口行为

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

目前仅直播群支持此接口

请求方式

使用 POST 方式发起请求。

请求参数

Query

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

Body

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

请求示例代码

Query

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

Body

{
    "AppId":000000,
    "ConversationShortId":000001,
    "Cursor":0,
    "Limit":20
}
Json

返回调用结果

返回参数说明

返回结果参看 BaseResponse。

其中 Result 的结构如下：

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

WhitelistParticipant

参数名	类型	描述
ParticipantUserId	Int	白名单成员 UserId
CreateTime	Int	用户加入白名单时间，单位为秒
Operator	Int	执行加入白名单操作操作人 UserId
NickName	Int	白名单成员昵称
Ext	map-key(string)-value(string)	白名单成员扩展字段
AvatarUrl	String	白名单成员头像

正常返回示例

{
    "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": 1687213873,
                "Operator": 10003,
                "NickName": "Your_NickName",
                "Ext": {
                    "key":"value"
                },
                "AvatarURL": "https://xxxx.com"
            }
        ]
    }
}
json