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

执行登录(步骤3)

POST
/login/checkLogin
获取到登录二维码后需每间隔5s调用本接口来判断是否登录成功
新设备登录平台,次日凌晨会掉线一次,重新登录时需调用获取二维码且传appId取码,登录成功后则可以长期在线
登录成功后请保存appId与wxid的对应关系,后续接口中会用到

请求参数

Header 参数
X-GEWE-TOKEN
string 
必需
示例值:
{{gewe-token}}
Body 参数application/json
appId
string 
设备ID
必需
uuid
string 
取码返回的uuid
必需
captchCode
string 
必需
扫码后手机提示输入的验证码
示例
{
    "appId": "{{appid}}",
    "uuid": "IZDexGAEu9_6JkDX0pX-"
}

示例代码

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

返回响应

🟢200成功
application/json
Body
ret
integer 
必需
msg
string 
必需
data
object 
响应数据
必需
uuid
string 
二维码的uuid
必需
headImgUrl
string 
头像地址
必需
nickName
string 
昵称
必需
expiredTime
integer 
二维码超时时间
必需
status
integer 
状态
必需
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
    }
}
上一页
获取登录二维码(步骤2)
下一页
设置消息回调地址
Built with