Appearance
获取通讯录列表
获取当前微信实例的好友、群聊、公众号 ID 列表。
接口地址: POST /getAddressList
前置条件
- 已完成微信登录,并保存当前登录返回的
wId。 - 已调用 初始化通讯录。
- 本接口只返回 ID 列表,不返回昵称、头像、备注等详情。
数据范围
| 字段 | 数据范围 | 说明 |
|---|---|---|
data.friends | 好友 ID | 当前微信实例的好友 ID |
data.chatrooms | 群聊 ID | 仅包含已保存到通讯录的群聊 |
data.ghs | 公众号 ID | 公众号通常以 gh_ 开头 |
data.others | 其他联系人 | 业务侧可按需保存或忽略 |
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| wId | 是 | string | 登录实例标识 |
响应参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | string | 1000 成功,1001 失败 |
| message | string | 反馈信息 |
| data.chatrooms | array | 群聊 ID 列表 |
| data.friends | array | 好友 ID 列表 |
| data.ghs | array | 公众号 ID 列表 |
| data.others | array | 其他联系人 |
请求示例
json
{
"wId": "6a696578-16ea-4edc-ac8b-e609bca39c69"
}成功响应
json
{
"code": "1000",
"message": "获取通讯录成功",
"data": {
"chatrooms": ["12345678@chatroom"],
"friends": ["wxid_6tn88z16x6ou12"],
"ghs": ["gh_88b080670a71"],
"others": []
}
}错误响应
json
{
"code": "1001",
"message": "失败",
"data": null
}使用建议
- 将
friends、chatrooms、ghs分类型入库,后续业务逻辑不要只靠昵称判断联系人。 - 如需基础联系人详情,请调用 获取联系人详情;如需
v3或完整资料,请调用 获取联系人详情(完整版)。 - 如需完整群资料,请调用 获取群详情。
