Skip to content

获取通讯录列表

获取当前微信实例的好友、群聊、公众号 ID 列表。

接口地址: POST /getAddressList

前置条件

  • 已完成微信登录,并保存当前登录返回的 wId
  • 已调用 初始化通讯录
  • 本接口只返回 ID 列表,不返回昵称、头像、备注等详情。

数据范围

字段数据范围说明
data.friends好友 ID当前微信实例的好友 ID
data.chatrooms群聊 ID仅包含已保存到通讯录的群聊
data.ghs公众号 ID公众号通常以 gh_ 开头
data.others其他联系人业务侧可按需保存或忽略

请求参数

参数名必选类型说明
wIdstring登录实例标识

响应参数

参数名类型说明
codestring1000 成功,1001 失败
messagestring反馈信息
data.chatroomsarray群聊 ID 列表
data.friendsarray好友 ID 列表
data.ghsarray公众号 ID 列表
data.othersarray其他联系人

请求示例

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
}

使用建议