微信协议 API
wekeapi 官网API文档下载
wekeapi 官网API文档下载
    • 接入必读
    • 使用流程
    • 最佳实践
    • 消息回调
    • API参考
      • 登录
        • 登录模块参考
        • 获取登录二维码
        • 检测扫码结果
        • 检查在线状态
        • 快捷登录
        • 退出登录
      • 通讯录
        • 获取通讯录列表
        • 获取联系人/群/公众号简要信息
        • 获取联系人/群/公众号详细信息
        • 搜索联系人
        • 添加好友
        • 同意添加好友
        • 设置好友仅聊天
        • 设置好友备注
        • 删除好友
        • 获取企微好友列表
        • 获取企微好友信息
        • 搜索企微联系人
        • 添加企微好友
        • 设置企微好友设置备注
        • 删除企微好友
        • 获取手机通讯录好友
        • 上传手机通讯录
        • 更新通讯录列表
      • 群聊
        • 创建微信群
        • 获取群成员列表
        • 获取群成员详情
        • 邀请成员进群
        • 添加成员进群
        • 获取群二维码
        • 扫码进群
        • 同意进群
        • 同意邀请进群申请
        • 添加群成员为好友
        • 转让群主
        • 添加管理员
        • 移除管理员
        • 设置群公告
        • 获取群公告
        • 设置群聊邀请确认
        • 修改群名称
        • 修改群备注
        • 修改群内昵称
        • 群拍一拍
        • 移除群成员
        • 解散群聊
        • 退出群聊
        • 保存群到通讯录
        • 从通讯录移除群
      • 标签
        • 获取标签列表
        • 添加标签
        • 删除标签
        • 修改好友标签
      • 消息
        • 发送文本
        • 发送语音
        • 发送图片
        • 转发图片
        • 转发图片消息
        • 发送视频
        • 转发视频
        • 转发视频消息
        • 发送文件
        • 转发文件
        • 转发文件消息
        • 发送链接
        • 转发链接
        • 转发链接消息
        • 发送小程序消息
        • 转发小程序消息
        • 发送Emoji
        • 发送名片
        • 发送AppMsg消息
        • 撤回消息
        • 下载语音
        • 下载图片
        • 下载视频
        • 下载文件
        • 下载Emoji
        • CDN下载
      • 代理
        • 获取设备代理信息
        • 设置设备代理信息
        • 检查城市是否有代理

    消息回调

    消息回调说明#

    创建访问凭证 AccessToken 后,在该 AccessToken 上绑定一个回调地址。配置完成后,该 AccessToken 下所有设备接收到的微信消息,都会通过 HTTP POST 方式推送给该回调地址。
    回调地址对应您自行开发的接口,需要满足以下要求:
    1.
    接收到消息后,异步处理消息,接口马上返回响应;
    2.
    3秒内未响应,视为本次推送失败;
    3.
    响应的HTTP Status不是200,视为本次推送失败。

    消息格式#

    {
        "appId": "消息所属设备的AppId",
        "wxid": "接收消息微信账号的wxid",
        "msgFlag": "消息类型,目前支持AddMsg|ModContact|DelContact",
        "msgData": "消息具体数据,不同类型消息的数据结构不同"
    }

    AddMsg消息#

    主要使用的消息格式,微信收发的消息属于这个类型

    消息格式#

    {
        "msg_type": 1,
        "from_user_name": {
          "str": "发送人wxid"
        },
        "to_user_name": {
          "str": "接收人wxid"
        }
        "content": {
          "str": "消息内容"
        },
        "new_msg_id": 5671465775673464000,
        "msg_id": 1135049119,
        "msg_seq": 817202053,
        "create_time": 1780293948,
        "img_buf": {
          "len": 0
        },
        "img_status": 1,
        "msg_source": "<msgsource>\n\t<pua>1</pua>\n\t<eggIncluded>1</eggIncluded>\n\t<silence>1</silence>\n\t<membercount>87</membercount>\n\t<signature>N0_V1_z3Eas3gN|v1_VY9XpTw+</signature>\n\t<tmp_node>\n\t\t<publisher-id></publisher-id>\n\t</tmp_node>\n</msgsource>\n",
        "status": 3,
      }

    消息排重#

    由于重新登录后消息同步、服务端服务重启或者网络抖动导致推送失败后重试等各种原因,系统推送给您的消息会有重复,请务必对接收消息进行排重
    使用 AddMsg 中的 new_msg_id 进行唯一性判断

    如何判断是否自己发的消息#

    同微信账号在其他设备上发的消息,会同步到本设备,所以会接收到自己发的消息
    如果 AddMsg 中的发送人 from_user_name = wxid,是自己发的消息

    如何判断群消息和发送人#

    如果 AddMsg 中的发送人 from_user_name 是群id,则接收到的是群消息
    群消息的 content 是 发送人wxid:内容 的形式,可用来解析发送人

    AddMsg 部分消息类型及标志#

    类型标志消息内容
    文本消息msg_type = 1从 content.str 里取消息内容
    图片消息msg_type = 3从 content.str 里取 xmlmsg, img_buf.buffer 里取缩略图数据
    语音消息msg_type = 34从 content.str 里取 xmlmsg;短语音数据可以直接从 img_buf.buffer 里取到,长语音取不到,需另行下载
    视频消息msg_type = 43从 content.str 里取 xmlmsg
    链接消息msg_type = 49, xmlmsg 中 appmsg.type = 5从 content.str 里取 xmlmsg
    文件消息msg_type = 49, xmlmsg 中 appmsg.type = 6从 content.str 里取 xmlmsg
    聊天记录msg_type = 49, xmlmsg 中 appmsg.type = 19从 content.str 里取 xmlmsg
    小程序消息msg_type = 49, xmlmsg 中 appmsg.type = 33从 content.str 里取 xmlmsg
    视频号消息msg_type = 49, xmlmsg 中 appmsg.type = 51从 content.str 里取 xmlmsg
    引用消息msg_type = 49, xmlmsg 中 appmsg.type = 57从 content.str 里取 xmlmsg
    群公告msg_type = 49, xmlmsg 中 appmsg.type = 87从 content.str 里取 xmlmsg
    转账消息msg_type = 49, xmlmsg 中 type = 2000从 content.str 里取 xmlmsg
    红包消息msg_type = 49, xmlmsg 中 type = 2001从 content.str 里取 xmlmsg
    表情动画msg_type = 47从 content.str 里取 xmlmsg
    位置消息msg_type = 48从 content.str 里取 xmlmsg
    名片消息msg_type = 42从 content.str 里取 xmlmsg
    加好友请求msg_type = 37从 content.str 里取 xmlmsg
    消息撤回msg_type = 10002, xmlmsg 中 sysmsg.type = "revokemsg"从 content.str 里取 xmlmsg
    群拍一拍msg_type = 10002, xmlmsg 中 sysmsg.type = "pat"从 content.str 里取 xmlmsg

    ModContact 消息#

    联系人或群的信息有变更,会收到 ModContact 消息
    {
        "addContactScene": 0,
        "additionalContactList": {
          "item": {}
        },
        "albumFlag": 0,
        "albumStyle": 0,
        "bigHeadImgUrl": "大尺寸头像",
        "bitMask": 4294967295,
        "bitVal": 3,
        "chatRoomNotify": 0,
        "chatroomAccessType": 0,
        "chatroomInfoVersion": 0,
        "chatroomMaxCount": 0,
        "chatroomStatus": 0,
        "chatroomVersion": 0,
        "city": "Changping",
        "contactType": 0,
        "country": "CN",
        "customizedInfo": {
          "brand_flag": 0
        },
        "deleteContactScene": 0,
        "deleteFlag": 0,
        "domainList": {},
        "encryptUserName": "v3_020b3826fd03010000000000f2be13fd86767b000000501ea9a3dba12f95f6b60a0536a1adb6752fb86c5864dc33b388282b89c7632d6c018326c1328cae00d9cc4b7d04546546118fc56e745288bf1df6f5de@stranger",
        "extFlag": 0,
        "hasWeiXinHdHeadImg": 1,
        "imgBuf": {
          "len": 0
        },
        "imgFlag": 1,
        "level": 1,
        "newChatroomData": {
          "info_mask": 0,
          "member_count": 0,
          "unknow": {}
        },
        "nickName": {
          "str": "昵称"
        },
        "personalCard": 1,
        "phoneNumListInfo": {
          "count": 0
        },
        "province": "Beijing",
        "pyinitial": {
          "str": "xxx"
        },
        "quanPin": {
          "str": "xxx"
        },
        "remark": {},
        "remarkPyinitial": {},
        "remarkQuanPin": {},
        "roomInfoCount": 0,
        "sex": 1,
        "smallHeadImgUrl": "小尺寸头像",
        "snsUserInfo": {
          "sns_bgimg_id": "",
          "sns_bgobject_id": 12417959280734180000,
          "sns_flag": 1,
          "sns_flagex": 2689,
          "sns_privacy_recent": 0
        },
        "source": 1000015,
        "userName": {
          "str": "wxid"
        },
        "verifyFlag": 0,
        "weiboFlag": 0
      }

    DelContact 消息#

    删除好友或退出群聊,会收到 DelContact 消息
    {
        "deleteContactScene": 0,
        "userName": {
            "str": "好友或群的id"
    }
    修改于 2026-06-15 07:21:54
    上一页
    最佳实践
    下一页
    登录模块参考
    Built with