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

获取登录二维码(步骤2)

POST
/login/getLoginQrCode
appId参数为设备ID,首次登录传空,会自动触发创建设备,掉线后重新登录则必须传接口返回的appId,注意同一个号避免重复创建设备,以免触发官方风控
取码时传的appId需要与上次登录扫码的微信一致,否则会导致登录失败
响应结果中的qrImgBase64为微信二维码图片的base64,前端需要将二维码图片展示给用户并进行手机扫码操作(PS: 扫码后调用步骤2,手机上才显示登录)。(或使用响应结果中的qrData生成二维码)

请求参数

Header 参数
X-GEWE-TOKEN
string 
必需
示例值:
{{gewe-token}}
Body 参数application/json
appId
string 
必需
设备ID,首次登录传空,之后传接口返回的appId
示例
{
    "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 '/login/getLoginQrCode' \
--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 
响应数据
必需
qrData
string 
必需
二维码内包含的信息(可用二维码生成工具结合值生成可扫描的微信二维码)
appId
string 
设备ID
必需
qrImgBase64
string 
必需
二维码图片base64
uuid
string 
二维码的uuid
必需
示例
{
    "ret": 200,
    "msg": "操作成功",
    "data": {
        "appId": "wx_wR_U4zPj2M_OTS3BCyoE4",
        "qrData": "http://weixin.qq.com/x/4dmHZZMtoLbHoLZwd1wE",
        "qrImgBase64": "data:image/jpg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/wAALCAJaAloBAREA/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/9oACAEBAAA/AP1Toooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooor8gP29f29fjt8Fv2sfHPg3wb45/sbw3pv2H7JZf2RYT+X5lhbyv88sDOcvI55Y4zgcACvAP+Ho/7Tv8A0U3/AMoGl/8AyNR/w9H/AGnf+im/+UDS/wD5Go/4ej/tO/8ARTf/ACgaX/8AI1H/AA9H/ad/6Kb/AOUDS/8A5Go/4ej/ALTv/RTf/KBpf/yNR/w9H/ad/wCim/8AlA0v/wCRqP8Ah6P+07/0U3/ygaX/API1H/D0f9p3/opv/lA0v/5Go/4ej/tO/wDRTf8AygaX/wDI1H/D0f8Aad/6Kb/5QNL/APkaj/h6P+07/wBFN/8AKBpf/wAjV9//APBKT9qP4n/tKf8AC0f+Fj+Jv+Ej/sX+y/sH+gWtr5Pnfa/N/wBREm7PlR/ezjbxjJz9/wBfkB+3r+3r8dvgt+1j458G+DfHP9jeG9N+w/ZLL+yLCfy/MsLeV/nlgZzl5HPLHGcDgAV4B/w9H/ad/wCim/8AlA0v/wCRq/f6iivgD/gq3+1H8T/2a/8AhV3/AArjxN/wjn9tf2p9v/0C1uvO8n7J5X+vifbjzZPu4zu5zgY+AP8Ah6P+07/0U3/ygaX/API1fr9+wV8UvE/xp/ZO8DeMvGWp/wBs+JNS+3fa737PFB5nl39xEnyRKqDCRoOFGcZPJJr6Aor5/wD29fil4n+C37J3jnxl4N1P+xvEmm/Yfsl79nin8vzL+3if5JVZDlJHHKnGcjkA1+QP/D0f9p3/AKKb/wCUDS//AJGo/wCHo/7Tv/RTf/KBpf8A8jUf8PR/2nf+im/+UDS//kav1+/YK+KXif40/sneBvGXjLU/7Z8Sal9u+13v2eKDzPLv7iJPkiVUGEjQcKM4yeSTX0BRXz/+3r8UvE/wW/ZO8c+MvBup/wBjeJNN+w/ZL37PFP5fmX9vE/ySqyHKSOOVOM5HIBr8gf8Ah6P+07/0U3/ygaX/API1ff8A/wAEpP2o/if+0p/wtH/hY/ib/hI/7F/sv7B/oFra+T532vzf9REm7PlR/ezjbxjJz9/1+QH7ev7evx2+C37WPjnwb4N8c/2N4b037D9ksv7IsJ/L8ywt5X+eWBnOXkc8scZwOABXgH/D0f8Aad/6Kb/5QNL/APkaj/h6P+07/wBFN/8AKBpf/wAjUf8AD0f9p3/opv8A5QNL/wDkaj/h6P8AtO/9FN/8oGl//I1ff/8AwSk/aj+J/wC0p/wtH/hY/ib/AISP+xf7L+wf6Ba2vk+d9r83/URJuz5Uf3s428Yyc/f9FFfgD/w9H/ad/wCim/8AlA0v/wCRq9//AGCv29fjt8af2sfA3g3xl45/tnw3qX277XZf2RYQeZ5dhcSp88UCuMPGh4YZxg8Eiv1/oor8gP29f29fjt8Fv2sfHPg3wb45/sbw3pv2H7JZf2RYT+X5lhbyv88sDOcvI55Y4zgcACvAP+Ho/wC07/0U3/ygaX/8jV+/1fP/AO3r8UvE/wAFv2TvHPjLwbqf9jeJNN+w/ZL37PFP5fmX9vE/ySqyHKSOOVOM5HIBr8gf+Ho/7Tv/AEU3/wAoGl//ACNR/wAPR/2nf+im/wDlA0v/AORqP+Ho/wC07/0U3/ygaX/8jUf8PR/2nf8Aopv/AJQNL/8Akaj/AIej/tO/9FN/8oGl/wDyNR/w9H/ad/6Kb/5QNL/+RqP+Ho/7Tv8A0U3/AMoGl/8AyNR/w9H/AGnf+im/+UDS/wD5Go/4ej/tO/8ARTf/ACgaX/8AI1H/AA9H/ad/6Kb/AOUDS/8A5Go/4ej/ALTv/RTf/KBpf/yNR/w9H/ad/wCim/8AlA0v/wCRq/f6iiiiiiiiiivwB/4Kj/8AJ9nxN/7hn/prtK+VaKKKKKKKKKK/VT/ghj/zWz/uCf8At/X6qV+AP/BUf/k+z4m/9wz/ANNdpXyrX9VFFFflX/wXO/5on/3G/wD2wr8q6/f7/glx/wAmJ/DL/uJ/+nS7r6qor5V/4Kj/APJifxN/7hn/AKdLSvwBoor9/v8Aglx/yYn8Mv8AuJ/+nS7r6qor5V/4Kj/8mJ/E3/uGf+nS0r8Aa/VT/ghj/wA1s/7gn/t/X6qV+AP/AAVH/wCT7Pib/wBwz/012lfKtFFFfqp/wQx/5rZ/3BP/AG/r9VKKK/lXr6q/4Jcf8n2fDL/uJ/8Apru6/f6iivwB/wCCo/8AyfZ8Tf8AuGf+mu0r5Vr+qivlX/gqP/yYn8Tf+4Z/6dLSvwBooooooooooor+qiiiiiiiiiiivwB/4Kj/APJ9nxN/7hn/AKa7SvlWv6qKKKKKKKK+Vf8AgqP/AMmJ/E3/ALhn/p0tK/AGv1U/4IY/81s/7gn/ALf1+qlfgD/wVH/5Ps+Jv/cM/wDTXaV8q0UUV+qn/BDH/mtn/cE/9v6/VSvwB/4Kj/8AJ9nxN/7hn/prtK+VaK+qv+CXH/J9nwy/7if/AKa7uv3+oor8Af8AgqP/AMn2fE3/ALhn/prtK+Va/qor5V/4Kj/8mJ/E3/uGf+nS0r8Aa/VT/ghj/wA1s/7gn/t/X6qV+AP/AAVH/wCT7Pib/wBwz/012lfKtFFFfqp/wQx/5rZ/3BP/AG/r9VKKK/lXr6q/4Jcf8n2fDL/uJ/8Apru6/f6vyr/4Lnf80T/7jf8A7YV+VdFFf1UV8q/8FR/+TE/ib/3DP/TpaV+ANfqp/wAEMf8Amtn/AHBP/b+v1Uooooooor8Af+Co/wDyfZ8Tf+4Z/wCmu0r5Vr+qiiiiiiiiiiivwB/4Kj/8n2fE3/uGf+mu0r5Vr+qiuU+KXxS8MfBbwJqfjLxlqf8AY3hvTfK+13v2eWfy/MlSJPkiVnOXkQcKcZyeATXgH/D0f9mL/opv/lA1T/5Go/4ej/sxf9FN/wDKBqn/AMjUf8PR/wBmL/opv/lA1T/5Go/4ej/sxf8ARTf/ACgap/8AI1H/AA9H/Zi/6Kb/AOUDVP8A5Gr6qr5V/wCCo/8AyYn8Tf8AuGf+nS0r8Aa/VT/ghj/zWz/uCf8At/X6qV+AP/BUf/k+z4m/9wz/ANNdpXyrRRRX3/8A8EpP2o/hh+zX/wALR/4WP4m/4Rz+2v7L+wf6BdXXneT9r83/AFET7cebH97Gd3GcHH3/AP8AD0f9mL/opv8A5QNU/wDkavgD9qP9lz4n/to/HbxN8Zfg14Z/4TH4beJfsv8AZWt/b7Wx+0/Z7WK1m/c3UsUybZreVPnQZ25GVIJ8q/4dcftO/wDRMv8Ayv6X/wDJNfKte/8A7BXxS8MfBb9rHwN4y8Zan/Y3hvTft32u9+zyz+X5lhcRJ8kSs5y8iDhTjOTwCa/X/wD4ej/sxf8ARTf/ACgap/8AI1H/AA9H/Zi/6Kb/AOUDVP8A5Go/4ej/ALMX/RTf/KBqn/yNXwB+1H+y58T/ANtH47eJvjL8GvDP/CY/DbxL9l/srW/t9rY/afs9rFazfubqWKZNs1vKnzoM7cjKkE+Vf8OuP2nf+iZf+V/S/wD5Jr9VP+Ho/wCzF/0U3/ygap/8jV8//t6/t6/An40/sneOfBvg3xz/AGz4k1L7D9ksv7Iv4PM8u/t5X+eWBUGEjc8sM4wOSBX5A1+qn/BDH/mtn/cE/wDb+v1Ur8Af+Co//J9nxN/7hn/prtK+Va+qv+HXH7Tv/RMv/K/pf/yTXKfFL9gr47fBbwJqfjLxl4G/sbw3pvlfa73+17Cfy/MlSJPkinZzl5EHCnGcngE14BX3/wD8EpP2o/hh+zX/AMLR/wCFj+Jv+Ec/tr+y/sH+gXV153k/a/N/1ET7cebH97Gd3GcHH3//AMPR/wBmL/opv/lA1T/5Gr3/AOFvxS8MfGnwJpnjLwbqf9s+G9S837Je/Z5YPM8uV4n+SVVcYeNxyozjI4INdXX4A/8ADrj9p3/omX/lf0v/AOSa9/8A2Cv2Cvjt8Fv2sfA3jLxl4G/sbw3pv277Xe/2vYT+X5lhcRJ8kU7OcvIg4
上一页
获取Token(步骤1)
下一页
执行登录(步骤3)
Built with