IM即时通讯

查询用户加入的群组列表

URL

https://sdk.cloudroom.com/im/v1/group/joined/list

请求方式:POST

请求参数

公共参数

接口参数

名称 类型 是否必传 说明
ImUserID String 是 IM用户ID
PageNumber Integer 否 页码,默认 1
PageSize Integer 否 每页数量 ,默认 20,最大 100

返回参数

名称 类型 说明
RspCode Int 响应码
RspDesc String 响应描述
Data Object 数据对象
Data.Total Int 总数
Data.Groups String[] 群组列表

Groups 数据详情

名称 类型 说明
GroupID String 群ID
OwnerUserID String 群主(IM 用户 ID)
GroupName String 群名称
Notification String 群公告
Introduction String 群介绍
FaceURL String 群头像地址
Ex String 群扩展字段,SDK 仅负责透传,不解析内容
NeedVerification Int 进群是否需要验证。
0:群成员邀请无需验证
1:需要发送验证消息
2:允许所有人加群
MemberCount Int 当前群组成员数量
CreateTime Long 群组创建时间戳

示例

请求示例

curl -X POST https://sdk.cloudroom.com/im/v1/group/joined/list \
  -H "Content-Type: application/json" \
  -d '{
    "RequestId": "2d95a5fe-a384-5dea-0d84-db153b10ee0f",
    "CompID": "1111111",
    "SecretKey": "b7febff6a21c36fb50150f88c95ef641",
    "ImUserID": "user_12345",
    "PageNumber": 1,
    "PageSize": 20
  }'

返回示例

{
    "RspCode": 0,
    "RspDesc": "请求成功",
    "Data": {
        "Total": 1,
        "Groups": [
            {
                "GroupID": "2355472856",
                "OwnerUserID": "user_admin_001",
                "GroupName": "产品需求讨论群",
                "Notification": "",
                "Introduction": "",
                "FaceURL": "https://test.com/avatars/group_default.png",
                "Ex": "{\"department\":\"product\",\"project_id\":\"PRJ-2026\"}",
                "NeedVerification": 1,
                "MemberCount": 4,
                "CreateTime": 1706860800000
            }
        ]
    }
}

状态码

上述接口在 HTTPS Body 中返回请求的状态码,状态码详情请参见 状态码