Skip to content

获取收藏夹列表

同步当前微信实例的收藏夹列表。

接口地址: POST /weChatFavorites/favSync

前置条件

  • 微信实例已登录,并已获得可用的 wId
  • 首次同步时 keyBufnull
  • 如果响应中 continueFlag1,说明还有下一页,需要继续用响应中的 keyBuf 发起下一次同步。

请求参数

参数名必选类型说明
wIdstring登录实例标识
keyBufbyte[]/null同步游标;首次传 null,后续传上一次响应返回的 keyBuf

响应参数

参数名类型说明
codestring1000 成功,1001 失败
messagestring反馈信息
data.retint接口状态,0 表示成功
data.favListarray收藏列表
data.keyBufbyte[]/null下一次同步需要使用的游标
data.continueFlagint0 表示同步结束,1 表示还需要继续同步
data.favList[].favIdint收藏 ID
data.favList[].typeint收藏类型
data.favList[].updateTimelong收藏更新时间戳

请求示例

json
{
 "wId": "0000016e-c561-9bbd-0001-3dc796084901",
 "keyBuf": null
}

成功响应

json
{
 "message": "成功",
 "code": "1000",
 "data": {
 "ret": 0,
 "favList": [
 {
 "favId": 1,
 "type": 2,
 "updateTime": 1538560491
 }
 ],
 "keyBuf": null,
 "continueFlag": 0
 }
}

错误响应

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

使用建议

  • 业务侧应循环同步,直到 continueFlag0 后再认为列表同步完成。
  • 建议保存每条收藏的 favIdtypeupdateTime,详情内容按需再调用「获取收藏夹内容」。
  • 收藏列表可能较多,建议后台任务分批同步,避免用户请求长时间阻塞。