weimi
  1. 好友接口
weimi
  • wmi_api
    • 开发指南
      • 开发前必读
      • 配置文件说明
    • 账号接口
      • 获取二维码
      • 切换账号获取二维码
      • 获取设备登录过的账号
      • 检测扫码结果
      • 恢复登录
      • 获取账号登录状态
      • 获取账号列表
      • 获取单个账号信息
      • 退出账号
    • 消息接口
      • 发送文本消息
      • 发送图片消息
      • 发送名片
      • 发送动态表情
      • 发送位置
      • 发送引用消息
      • 转发小程序
      • 撤回消息
      • 下载消息中的文件
      • 解析消息中的下载信息
    • 好友接口
      • 同步好友信息
        POST
      • 搜索好友
        POST
      • 添加好友
        POST
      • 验证好友请求
        POST
      • 获取好友列表、本地缓存
        POST
      • 获取好友信息、本地缓存
        POST
      • 获取好友信息,非本地
        POST
      • 设置好友标签
        POST
      • 设置好友备注
        POST
      • 删除好友
        POST
      • 检测好友关系
        POST
    • 标签接口
      • 同步标签信息
      • 获取标签信息,本地缓存
      • 添加标签
      • 删除标签
    • 群接口
      • 设置群昵称
      • 设置群公告
      • 获取群公告
      • 取消/保存通讯录
      • 同步群成员信息
      • 获取群成员信息,实时
      • 获取群成员信息,本地缓存
      • 获取群详情,实时
      • 获取群详情,本地缓存
      • 添加群成员
      • 邀请群成员
      • 删除群成员
      • 添加群管理员
      • 删除群管理员
      • 转让群
      • 退出群聊
      • 创建群
    • 朋友圈接口
      • 发布图文朋友圈
      • 转发朋友圈
      • 删除朋友圈
      • 获取朋友圈列表
      • 获取好友朋友圈
      • 获取指定ID朋友圈
      • 朋友圈点赞
      • 朋友圈评论
      • 朋友圈取消点赞
      • 删除朋友圈评论
      • 下载朋友圈中的图片/视频
    • 消息推送
      • 消息推送说明
      • 所有消息推送
      • 账号上下线通知
      • 新好友请求通知推送
      • 加入新好友通知推送
      • 成员入群通知推送
      • 加入群聊通知推送
      • 联系人信息修改通知推送
      • 联系人删除通知推送
      • 消息文件下载进度推送
  1. 好友接口

获取好友列表、本地缓存

开发中
POST
/v1/friend/getlocalcontactlist
获取好友列表,本地缓存的数据,当扫码成功登录后,会自动同步一次好友信息,并且将数据存入本地

请求参数

Header 参数
token
string 
可选
api 验证token,可以在setting.json文件里自行配置
Body 参数application/json
clientids
array[string] | null 
客户端ID
可选
通过服务端转发调用的时候有必要,比如查询某个客户端的全部联系人
ownerwxids
array[string | null]
好友归属wxid
可选
searchtext
string  | null 
搜索关键词
可选
可以通过好友wxid,alias,昵称,备注模糊搜索
pageindex
integer 
分页,当前页
可选
pagesize
integer 
页大小
可选
最大10000,默认30
示例
{
  "clientids": [],
  "ownerwxids": [],
  "searchtext": "",
  "pageindex": 0,
  "pagesize": 30
}

返回响应

🟢200成功
application/json
Body
code
integer 
必需
data
array [object {22}] 
必需
uuid
string 
设备ID
必需
ownerwxid
string 
归属微信ID
必需
wxid
string 
好友微信ID
必需
nickname
string 
昵称
可选
pyinitial
string 
呢称拼音首写
可选
quanpin
string 
昵称全拼
可选
sex
integer 
性别
可选
0女性,1男性,其他未知
country
string 
国家
可选
province
string 
省份
可选
city
string 
城市
可选
bigheadimgurl
string 
大头像
可选
不一定有
smallheadimgurl
string 
小头像
可选
remark
string 
备注
可选
remarkpyinitial
string 
备注拼音首写
可选
remarkquanpin
string 
备注全拼
可选
contacttype
integer 
联系人类型
可选
alias
string 
微信号
可选
有修改过微信号才有
phonenumlistinfo
string 
手机号备注
可选
labelidlist
string 
标签ID
可选
labelnamelist
string 
标签名称
可选
description
string 
描述
可选
deleteflag
integer 
可选
text
string 
必需
rowcount
integer 
必需
showmsg
boolean 
必需
示例
{
  "code": 0,
  "data": [
    {
      "uuid": "string",
      "ownerwxid": "string",
      "wxid": "string",
      "nickname": "string",
      "pyinitial": "string",
      "quanpin": "string",
      "sex": 0,
      "country": "string",
      "province": "string",
      "city": "string",
      "bigheadimgurl": "string",
      "smallheadimgurl": "string",
      "remark": "string",
      "remarkpyinitial": "string",
      "remarkquanpin": "string",
      "contacttype": 0,
      "alias": "string",
      "phonenumlistinfo": "string",
      "labelidlist": "string",
      "labelnamelist": "string",
      "description": "string",
      "deleteflag": 0
    }
  ],
  "text": "string",
  "rowcount": 0,
  "showmsg": true
}
上一页
验证好友请求
下一页
获取好友信息、本地缓存
Built with