Gewechat
  1. 联系人模块
Gewechat
  • 基础API
    • 登录模块
      • 获取Token(步骤1)
      • 获取登录二维码(步骤2)
      • 执行登录(步骤3)
      • 设置消息回调地址
      • 查看设备列表
    • 联系人模块
      • 获取通讯录列表
        POST
      • 获取通讯录列表缓存
        POST
      • 搜索好友
        POST
      • 添加联系人/同意添加好友
        POST
      • 删除好友
        POST
      • 上传手机通讯录
        POST
      • 获取群/好友简要信息
        POST
      • 获取群/好友详细信息
        POST
      • 设置好友仅聊天
        POST
      • 设置好友备注
        POST
      • 获取手机通讯录
        POST
    • 群模块
      • 创建微信群
      • 修改群名称
      • 修改群备注
      • 修改我在群内的昵称
      • 邀请/添加 进群
      • 删除群成员
      • 退出群聊
      • 解散群聊
      • 获取群信息
      • 获取群成员列表
      • 获取群成员详情
      • 获取群公告
      • 设置群公告
      • 同意进群
      • 添加群成员为好友
      • 获取群二维码
      • 群保存到通讯录
      • 管理员操作
      • 聊天置顶
      • 设置消息免打扰
      • 扫码进群
      • 确认进群申请
    • 消息模块
      • 回调消息详解
      • 下载
        • 下载图片
      • 发送文字消息
      • 发送文件消息
      • 发送图片消息
      • 发送语音消息
      • 发送视频消息
      • 发送链接消息
      • 发送名片消息
      • 发送emoji消息
      • 发送appmsg消息
      • 发送小程序消息
      • 转发文件
      • 转发图片
      • 转发视频
      • 转发链接
      • 转发小程序
      • 撤回消息
    • 标签模块
      • 添加标签
      • 删除标签
      • 标签列表
      • 修改好友标签
    • 个人模块
      • 获取个人资料
      • 获取自己的二维码
      • 获取设备记录
      • 隐私设置
      • 修改个人信息
      • 修改头像
    • 收藏夹模块
      • 同步收藏夹
      • 获取收藏夹内容
      • 删除收藏夹
    • 账号管理
      • 断线重连
      • 退出
      • 检查是否在线
  1. 联系人模块

获取通讯录列表

POST
/contacts/fetchContactsList
本接口为长耗时接口,耗时时间根据好友数量递增,若接口返回超时可通过获取通讯录列表缓存接口获取响应结果
本接口返回的群聊仅为保存到通讯录中的群聊,若想获取会话列表中的所有群聊,需要通过消息订阅做二次处理。原因:当未获取的群有成员在群内发消息的话会有消息回调, 开发者此刻调用获取群详情接口查询群信息入库保存即可,比如说手机上三年前不说话的群,侧滑删除了,用户手机上也不会看到被删除的群聊的 ,但是有群成员说了话他会显示,原理就是各个终端(Android、IOS、桌面版微信)取得了消息回调,又去获取群详情信息,本地数据库缓存了下来,显示的手机群聊,让用户感知的。

请求参数

Header 参数
X-GEWE-TOKEN
string 
必需
示例值:
{{gewe-token}}
Body 参数application/json
appId
string 
设备ID
必需
示例
{
  "appId": "{{appid}}"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/contacts/fetchContactsList' \
--header 'X-GEWE-TOKEN: {{gewe-token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appId": "{{appid}}"
}'

返回响应

🟢200成功
application/json
Body
ret
integer 
必需
msg
string 
必需
data
object 
必需
friends
array[string]
好友的wxid
必需
chatrooms
array[string]
必需
保存到通讯录中群聊的ID
ghs
array[string]
关注的公众号ID
必需
示例
{
  "ret": 200,
  "msg": "操作成功",
  "data": {
    "friends": [
      "tmessage",
      "medianote",
      "qmessage",
      "qqmail",
      "wxid_910acevfm2nb21",
      "qqsafe",
      "wxid_9299552988412",
      "weixin",
      "exmail_tool",
      "wxid_mp05xmje0ctn22",
      "wxid_09oq4f4j4wg912",
      "wxid_6bfguz79h8n122",
      "wxid_lyuq4hr4lrjq22",
      "wxid_a1zqyljsrsdu12",
      "wxid_lv3pb3zhna3522",
      "wxid_k2biq6fuinsr22",
      "wxid_ujredjhxz9y712",
      "wxid_uwb7989u0jea12",
      "wxid_in46ey732vxu12",
      "wxid_3rvervwohj6921",
      "wxid_4wkls7tu62ua12",
      "wxid_g0bdknnotx2f12",
      "wxid_ce5fgp0icb3y21",
      "wxid_1482424825211",
      "wxid_vw3p4f6jy7bm12",
      "wxid_o2m8xm71c23522",
      "wxid_bclqpc2ho6o412",
      "wxid_98pjjzpiisi721",
      "wxid_noq2wsn5c8h222"
    ],
    "chatrooms": [
      "2180313478@chatroom",
      "14358945067@chatroom",
      "17362526147@chatroom",
      "11685224357@chatroom",
      "17522822550@chatroom"
    ],
    "ghs": [
      "gh_7aac992b0363",
      "gh_d7293b5f14f4",
      "gh_f51ce3ef83a4",
      "gh_7d20df86e26b",
      "gh_69bfb92a3e43"
    ]
  }
}
上一页
查看设备列表
下一页
获取通讯录列表缓存
Built with