GeHub|微信 API 开发文档
官方网站后台系统企业微信
官方网站后台系统企业微信
  1. 登录模块
Ctrl+K
  • 平台介绍
  • 快速开始 ⭐
  • Webhook
    • Webhook 事件 ⭐
    • 回调结构说明v1.0
    • 回调结构说明 v2.0
    • 调试指南⭐
    • 常见问题
  • API 参考
    • 登录模块
      • 获取登录二维码(步骤1)
        POST
      • 执行登录(步骤2)
        POST
      • 设置回调地址
        POST
      • 掉线重连
        POST
      • 弹框登录
        POST
      • AID 本地代理说明
        POST
    • 联系人模块
      • 获取通讯录列表
      • 获取通讯录列表缓存
      • 获取群/好友简要信息
      • 获取群/好友详细信息
      • 搜索好友
      • 添加联系人/同意添加好友
      • 删除好友
      • 设置好友仅聊天
      • 设置好友备注
      • 获取手机通讯录
      • 上传手机通讯录
      • 搜索企微
      • 添加企微好友
      • 同步企微好友
      • 获取企微好友详情
      • 检测好友关系
    • 群模块
      • 创建微信群
      • 修改群名称
      • 修改群备注
      • 修改我在群内的昵称
      • 邀请/添加 进群
      • 删除群成员
      • 退出群聊
      • 获取群信息
      • 获取群成员列表
      • 获取群成员详情
      • 获取群公告
      • 设置群公告
      • 同意进群
      • 添加群成员为好友
      • 获取群二维码
      • 群保存到通讯录
      • 管理员操作
      • 聊天置顶
      • 设置消息免打扰
      • 扫码进群
      • 确认进群申请
      • 解散群聊
    • 消息模块
      • 下载
        • 下载文件
        • 下载图片
        • 下载语音
        • 下载视频
        • 下载emoji
        • cdn下载
      • 发送文字消息
      • 发送文件消息
      • 发送图片消息
      • 发送语音消息
      • 发送视频消息
      • 发送链接消息
      • 发送名片消息
      • 发送emoji消息
      • 发送appmsg消息
      • 发送合并消息
      • 发送小程序消息
      • 发送定位
      • 转发文件
      • 转发图片
      • 转发视频
      • 转发链接
      • 转发小程序
      • 撤回消息
    • 朋友圈模块
      • 点赞/取消点赞
      • 删除朋友圈
      • 设置朋友圈可见范围
      • 是否允许陌生人查看朋友圈
      • 设置某条朋友圈为隐私/公开
      • 下载朋友圈视频
      • 发送文字朋友圈
      • 发送图片朋友圈
      • 发送视频朋友圈
      • 发送链接朋友圈
      • 上传朋友圈图片
      • 上传朋友圈视频
      • 转发朋友圈
      • 自己的朋友圈列表
      • 联系人的朋友圈列表
      • 某条朋友圈详情
      • 评论/删除评论
    • 标签模块
      • 添加标签
      • 删除标签
      • 标签列表
      • 修改好友标签
    • 个人模块
      • 获取个人资料
      • 获取自己的二维码
      • 获取设备记录
      • 隐私设置
      • 修改个人信息
      • 修改头像
    • 收藏夹模块
      • 同步收藏夹
      • 获取收藏夹内容
      • 删除收藏夹
    • 视频号模块
      • 关注
      • 评论
      • 浏览
      • 用户主页
      • 获取私信SessionId
      • 关注列表
      • 消息列表
      • 评论列表
      • 获取赞与收藏的视频列表
      • 搜索视频号
      • 创建视频号
      • 根据id点赞
      • 根据id点小红心
      • 获取我的视频号信息
      • 修改我的视频号信息
      • 发送视频号消息
      • 发送视频号朋友圈
      • 获取私信人信息
      • 发私信文本消息
      • 发私信图片消息
      • 扫码关注
      • 搜索并关注
      • 扫码浏览
      • 扫码评论
      • 扫码点赞
      • 扫码点小红心
      • 延迟点赞、小红心
      • 扫码登录视频号助手
      • 扫码获取视频详情
      • 我的视频号二维码
      • 上传CDN视频
      • 发布CDN视频
      • 发布视频-新
      • 同步私信消息
    • 账号管理
      • 账号密码登录
      • 检查是否在线
      • 退出
      • 设置代理
      • Mac转ipad接口
  • 账号与风控
    • 养号规范
    • 风险说明
    • 解封指南
  1. 登录模块

执行登录(步骤2)

GeHub 接入说明(Token、节点和幂等要求)

X-GEHUB-TOKEN 请在后台「客户端」创建或重置凭据后复制(不是 Client Secret 本身),仅通过 HTTPS 发送。节点由客户端默认绑定决定,appId 为兼容占位,不用于选择节点。写操作必须提供新的 Idempotency-Key(8–128 位字母、数字、点、下划线、冒号或短横线);同一操作重试必须复用原值。危险操作另需 X-Confirm-Risk: destructive。首次微信登录和回调配置请在后台完成。 客户端需启用对应模块权限。

POST
/gehub/v2/api/login/checkLogin
提示:登录模块为必要步骤,如需简化流程,可跳过步骤1与步骤2,直接通过后台在线登录获取 appId 后进行接口调用。
必看说明
登录验证说明
获取二维码后,可通过本接口轮询登录状态。
建议调用间隔:5 秒
二维码有效期:150 秒
iPad 登录流程
1.
调用接口,手机提示“在新设备完成验证”
2.
接口返回二维码地址
3.
通过人脸识别 App 扫码完成验证
4.
再次调用接口,并在手机端确认登录
Mac 登录流程
新设备同样会触发验证提示,根据 autoCheck 参数不同,流程有区别。
autoCheck=true:

约 15 秒后自动跳转确认页,手机点击确认即可登录。

autoCheck=false:

接口返回二维码地址,需通过验证 App 扫码后再次调用接口完成登录。
接口作用说明
本接口为轮询接口,用于检测登录状态(如滑块验证、扫码确认、登录成功等)。

登录成功后,手机顶部显示设备在线(iPad/Mac),方可正常收发消息及调用其他接口。
登录稳定性说明
新设备首次登录后,24 小时内可能掉线一次;

掉线后需传 wcid 重新获取二维码登录,稳定后可长期在线(约 3 个月)。
相关工具下载
• iPad 登录人脸识别 App(仅支持 iOS,请使用 Safari 打开)

• Mac 登录滑块验证 App

• AID+Mac滑块验证 APP (二合一版)(Android)
登录流程图
Ipad登录流程图
ipad.png
Mac登录流程图
mac.png

请求参数

Header 参数
X-GEHUB-TOKEN
string 
必需
示例:
{{gehub-token}}
Body 参数application/json
appId
string 
兼容占位,可省略;按客户端绑定选择节点
uuid
string 
取码返回的uuid
必需
autoSliding
boolean 
可选
autoSliding 参数说明
用于控制登录验证方式(仅 mac 登录有效):
true:自动验证(无需额外操作)
false:手动验证(需通过 App 完成)
建议:
自动验证优先使用
若验证失败,可切换为手动验证
proxyIp
string 
可选
代理IP 格式:socks5://username:password@123.2.2.2
captchCode
string 
可选
手机若提示需要输入验证码传输
示例
{
    "appId": "{{appid}}",
    "proxyIp": "",
    "uuid": "obpAjgWNiBmumFz5VHmm",
    "autoSliding": false
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location 'https://wxapi.xiaoyu.fan/gehub/v2/api/login/checkLogin' \
--header 'X-GEHUB-TOKEN: {{gehub-token}}' \
--header 'Content-Type: application/json' \
--data '{
    "appId": "",
    "proxyIp": "",
    "uuid": "obpAjgWNiBmumFz5VHmm",
    "autoSliding": false
}'

返回响应

🟢200成功
application/json
Bodyapplication/json
ret
integer 
必需
msg
string 
必需
data
object 
响应数据
必需
uuid
string 
二维码的uuid
必需
headImgUrl
string 
头像地址
必需
nickName
string 
昵称
必需
expiredTime
integer 
二维码超时时间
必需
status
integer 
必需
状态 0:未扫码 1:已扫码未登录 2:登录成功
loginInfo
object 
登录成功信息
必需
示例
{
    "ret": 200,
    "msg": "操作成功",
    "data": {
        "uuid": "AZ0yN8d1wJmiNfQBKFgu",
        "headImgUrl": "http://wx.qlogo.cn/mmhead/ver_1/ZYUmcl1UNzyB2onM08Ij901TaUOLIjHj2UicK3XGDsjEWl4XgQN5IjodunHicBVsZiaZc1iaGCRfluAxkzyibbiau3WBfFj2nprzKp2KryicMjGIvDbWOQGmibwVK648a3o4A8hD/0",
        "nickName": "G",
        "expiredTime": 225,
        "status": 1,
        "loginInfo": null
    }
}
//需人脸/滑块 验证返回
{
    "ret": 200,
    "msg": "操作成功",
    "data": {
        "url": "http://api.asilu.com/qrcode/?t=http://182.40.96.72:8081/s/01KCJGKJ73YTBGQQKAZ4ZH13ZF"
    }
}
修改于 7 天前
上一页
获取登录二维码(步骤1)
下一页
设置回调地址
Built with