你可以使用此接口分批扫描群中成员的详细信息。

使用说明

接口行为

你可以调用ScanConversationParticipantList接口，指定你所属的AppId、会话 ID，查询起始位置和人数，分批扫描群中成员的详细信息。

若只查询群成员的 UserId，单次最多可查询 50 人；若需查询群成员详细信息，单次最多可查询 20 人。

调用接口

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

注意事项

QPS 不得超过 100。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
AppId	Integer	是	`000000`	应用的唯一标志
ConversationShortId	Long	是	`000001`	会话 ID
Cursor	Long	是	`1`	查询起始位置
Limit	Long	是	`2`	查询人数
Reverse	Boolean	否	`false`	按照进群的时间正序或逆序查询。 `false`：正序。 `true`：逆序。默认值为：`fasle`。
OnlyUserIds	Boolean	否	`false`	是否只查询群成员 `UserId`。 `true`：是。 `false`：否。默认值为 `false`。
ScanOnlineParticipant	Boolean	否	`false`	直播群专用字段。是否需要获得直播群在线成员列表。 `true`：是。 `false`：否。默认值为 `false`。当此字段设置 `true` 时，`Reverse` 和 `OnlyUserIds` 字段均会失效，该接口按成员进入直播群时间逆序返回在线成员列表。
MarkType	String	否	`Mark1`	标记类型。仅支持查询具有该标记的在线成员。

返回参数

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

参数	类型	示例值	描述
Participants	Array of Participant	`-`	群成员详细信息
HasMore	Boolean	`true`	是否还有下一页
NextCursor	Integer	`2`	下一页起始位置。为负时表示后续没有成员数据

Participant

参数	类型	示例值	描述
ConversationShortId	Long	`000001`	会话 ID
ParticipantUserId	Long	`10001`	群成员 ID
Level	Integer	`1`	成员等级
NickName	String	`Your_NickName`	成员昵称
Operator	Long	`000010`	操作人对应的 UserId
Status	Integer	`0`	成员状态。 `0`：正常 `1`：退出
CreateTime	Long	`1669694619`	成员进群时间对应时间戳，单位为秒
Ext	JSON Map	`{"key":"value"}`	成员的扩展字段
Role	Long	`0`	成员身份。 `0`：普通成员。 `1`：群主。 `2`：群管理员。
BlockTime	Long	`0`	禁言时间戳，单位为秒。`0`表示不禁言
AvatarUrl	String	`Your_AvatarUrl`	群成员头像
Marks	Array of String	`["Mark1","Mark2"]`	成员标记

请求示例

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

{
    "AppId": 000000,
    "ConversationShortId": 000001,
    "Cursor": 1,
    "Limit": 2,
    "Reverse": true,
    "OnlyUserIds": true,
    "ScanOnlineParticipant": false,
    "MarkType": "Mark1"
}
json

返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "BatchModifyConversationParticipant",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "Participants": [
            {
                "ConversationShortId": 000001,
                "ParticipantUserId": 10001,
                "Level": 1,
                "NickName": "NickName1",
                "Operator": 000010,
                "Status": 0,
                "CreateTime": 1669694619,
                "Ext": {
                    "key": "value",
                    "s:from": "biz"
                },
                "Role": 1,
                "BlockTime": 0,
                "AvatarUrl": "Your_AvatarUrl",
                "Marks": ["Mark1","Mark2"]
            },
            {
                "ConversationShortId": 000001,
                "ParticipantUserId": 10002,
                "Level": 1,
                "NickName": "NickName2",
                "Operator": 000010,
                "Status": 0,
                "CreateTime": 1669694619,
                "Ext": {
                    "key": "value",
                    "s:from": "biz"
                },
                "Role": 1,
                "BlockTime": 0,
                "AvatarUrl": "Your_AvatarUrl",
                "Marks": ["Mark1","Mark2"]
            }
        ],
        "HasMore": true,
        "NextCursor": 3
    }
}
json

错误码

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