Skip to content

初始化通讯录

首次登录成功后调用此接口同步通讯录数据,配合 获取通讯录列表 接口使用。

接口地址: POST /initAddressList

前置条件

  • 已完成微信登录,并保存当前登录返回的 wId
  • 建议在 Step 3 登录成功后调用一次,再调用 获取通讯录列表
  • 本接口为耗时接口,通常需要 10 秒 ~ 3 分钟,请在服务端设置足够的请求超时时间。

调用时机

场景是否建议调用说明
首次登录成功后初始化好友、群聊、公众号等基础联系人数据
微信实例重新登录后避免本地缓存与微信侧数据不一致
每次发送消息前不建议高频调用,发送前只需要确认 wId 可用

请求参数

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

响应参数

参数名类型说明
codestring1000 成功,1001 失败
messagestring反馈信息
datanull无返回数据

请求示例

json
{
 "wId": "6a696578-16ea-4edc-ac8b-e609bca39c69"
}

成功响应

json
{
 "code": "1000",
 "message": "成功",
 "data": null
}

错误响应

json
{
 "code": "1001",
 "message": "失败",
 "data": null
}

使用建议

初始化完成后,建议立即调用 获取通讯录列表,并把返回的联系人 ID 存入自己的业务数据库。后续需要联系人详情时,再按需调用 获取联系人详情