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

分批扫描群聊中的成员详细信息 ScanConversationParticipantList

最近更新时间：2024.01.30 16:36:08

首次发布时间：2023.04.24 11:11:46

我的收藏

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

使用说明

接口行为

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

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

调用接口

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

注意事项

QPS 不得超过 100。

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
AppIdInteger是000000应用的唯一标志
ConversationShortIdLong是000001会话 ID
CursorLong是1查询起始位置
LimitLong是2查询人数

Reverse

Boolean

否

false

按照进群的时间正序或逆序查询。

  • false：正序。
  • true：逆序。
    默认值为：fasle。

OnlyUserIds

Boolean

否

false

是否只查询群成员 UserId。

  • true：是。
  • false：否。
    默认值为 false。

ScanOnlineParticipant

Boolean

否

false

直播群专用字段。是否需要获得直播群在线成员列表。

  • true：是：拉取直播群在线成员列表（包含群主和管理员，只要在线就会返回，非直播群不会返回任何数据）。
  • false：否：拉取成员列表（非直播群），拉取群主管理员（直播群）。
    默认值为 false。

    当此字段设置 true 时，Reverse 和 OnlyUserIds 字段均会失效，该接口按成员进入直播群时间逆序返回在线成员列表。
MarkTypeString否Mark1标记类型。仅支持查询具有该标记的在线成员。

返回参数

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

参数类型示例值描述
ParticipantsArray of Participant-群成员详细信息
HasMoreBooleantrue是否还有下一页
NextCursorInteger2下一页起始位置。为负时表示后续没有成员数据

Participant

参数类型示例值描述
ConversationShortIdLong000001会话 ID
ParticipantUserIdLong10001群成员 ID
LevelInteger1成员等级
NickNameStringYour_NickName成员昵称
OperatorLong000010操作人对应的 UserId

Status

Integer

0

成员状态。

  • 0：正常
  • 1：退出
CreateTimeLong1669694619成员进群时间对应时间戳，单位为秒
ExtJSON Map{"key":"value"}成员的扩展字段

Role

Long

0

成员身份。

  • 0：普通成员。
  • 1：群主。
  • 2：群管理员。
BlockTimeLong0禁言时间戳，单位为秒。0表示不禁言
AvatarUrlStringYour_AvatarUrl群成员头像
MarksArray 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"
}

返回示例

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

错误码

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