Appearance
获取群信息
查询指定微信群聊的群资料和成员概要信息。
接口地址: POST /getChatRoomInfo
前置条件
- 微信实例已登录,并已获得可用的
wId。 - 当前微信实例仍在目标群聊中,并已获得可用的
chatRoomId。 - 群主、邀请人、成员信息的可见性受微信侧权限影响。
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
wId | 是 | string | 登录实例标识 |
chatRoomId | 是 | string | 群 ID |
响应参数
| 参数名 | 类型 | 说明 |
|---|---|---|
code | string | 1000 成功,1001 失败 |
message | string | 反馈信息 |
data | array | 群信息列表 |
data[].chatRoomId | string | 群 ID |
data[].userName | string/null | 群成员微信 ID,群概要中可能为空 |
data[].nickName | string | 群名称 |
data[].chatRoomOwner | string | 群主 ID |
data[].bigHeadImgUrl | string/null | 大头像 URL |
data[].smallHeadImgUrl | string | 小头像 URL |
data[].v1 | string | 群 v1 |
data[].memberCount | int | 群成员数 |
data[].chatRoomMembers | array | 群成员概要列表 |
data[].chatRoomMembers[].userName | string | 群成员微信 ID |
data[].chatRoomMembers[].nikeName | string | 群成员昵称,按接口现有字段名返回 |
data[].chatRoomMembers[].inviterUserName | string | 邀请人微信 ID,群主或管理员通常可见 |
请求示例
json
{
"wId": "349be9b5-8734-45ce-811d-4e10ca568c67",
"chatRoomId": "24343869723@chatroom"
}成功响应
json
{
"message": "成功",
"code": "1000",
"data": [
{
"chatRoomId": "24343869723@chatroom",
"userName": null,
"nickName": "",
"chatRoomOwner": "wxid_ylxtflcg0p8b22",
"bigHeadImgUrl": null,
"smallHeadImgUrl": "http://wx.qlogo.cn/mmcrhead/S44kIgicdUQ1LwXCuMlDEnV37pDE2RNYOq5ic7GpZR6icDPT1UvIh7iaKh7rKZMicatXKuvB9J0gIDGVDwKTpeBMyLpoCd3FEhNGic/0",
"v1": "v1_f4ef1dde421ba4039ee0e7a2dcd555fc7a18bcb3b77face81f425e5ec66e8cab814857df2124c60cc144df1ecc83a096@stranger",
"memberCount": 3,
"chatRoomMembers": [
{
"userName": "wxid_wl9qchkanp9u22",
"nikeName": "E云通知小助手(微信实例)",
"inviterUserName": "wxid_ylxtflcg0p8b22"
},
{
"userName": "wxid_i6qsbbjenjuj22",
"nikeName": "E云Team_Mr Li",
"inviterUserName": "wxid_ylxtflcg0p8b22"
},
{
"userName": "wxid_ylxtflcg0p8b22",
"nikeName": "售前客服-小诺 (工作日9:00-18:00)",
"inviterUserName": ""
}
]
}
]
}错误响应
json
{
"message": "失败",
"code": "1001",
"data": null
}使用建议
nikeName是接口现有返回字段名,请按原字段读取,不要改成nickName。- 群资料建议以
chatRoomId为主键保存;群名可能变化,不适合作为唯一标识。 - 如果只需要成员列表,建议使用 获取群成员。
