QiWX开放平台
    • 开发前必读
    • 回调结构说明
    • 客户端用例
    • 登录模块
      • 创建设备(步骤1)
        POST
      • 二维码-获取(步骤2)
        POST
      • 二维码状态-检测(步骤3)
        POST
      • 二维码-code验证(步骤4)
        POST
      • 恢复设备
        POST
      • 用户登录(免扫码登录)
        POST
      • 用户状态
        POST
      • 停用设备
        POST
    • 回调模块
      • 设置回调URL
        POST
    • 联系人模块
      • 联系人详情-批量
        POST
      • 外部联系人分页
        POST
      • 内部联系人分页
        POST
      • 联系人搜索
        POST
      • 添加个微
        POST
      • 添加企微
        POST
      • 添加群成员好友
        POST
      • 添加企微名片
        POST
      • 添加删除联系人
        POST
      • 同意申请
        POST
      • 外部联系人信息-更新
        POST
      • 内部联系人信息-更新
        POST
      • 删除联系人
        POST
      • Openid
        POST
    • 群模块
      • 群分页
      • 群详情-批量
      • 群成员变动查询
      • 创建群
      • 修改群名称
      • 修改群备注
      • 修改群内昵称
      • 邀请/添加成员
      • 禁止群成员互相添加
      • 移除成员
      • 群二维码
      • 修改群公告
      • 添加群管理员
      • 取消群管理员
      • 退群
      • 转让群主
      • 群解散
      • 开启群改名
      • 开启群邀请确认
      • 接受群邀请-By链接
      • OpenID
    • 消息模块
      • 引用消息发送说明
      • 文件多媒体(下载/上传)
        • POST 本地文件上传
        • 企微文件异步上传
        • 企微大文件异步上传
        • 个微文件下载
        • 个微文件异步下载
        • 企微文件下载
        • 企微文件异步下载
        • 企微大文件异步下载
        • 文件上传-URL
        • 文件CDN转URL
      • 发送纯文本消息
      • 发送混合文本消息
      • 发送图片消息
      • 发送GIF表情消息
      • 发送视频消息
      • 发送文件消息
      • 发送语音消息
      • 发送链接消息
      • 发送小程序消息
      • 发送名片消息
      • 发送视频号消息
      • 发送位置消息
      • 撤回已发消息
      • 语音转文字-任务申请
      • 语音转文字-任务查询
      • 修改消息状态
      • 群消息置顶-列表
      • 群消息置顶-添加
      • 群消息置顶-移除
      • 群发助手发送
      • 群发助手-状态查询
      • 群发助手-规则查询
      • 同步历史消息分页
    • 会话模块
      • 会话分页
      • 会话组-编辑
      • 会话组-查询
    • 朋友圈模块
      • POST 朋友圈文件上传
      • 朋友圈列表分页
      • 获取详情-批量
      • 发送朋友圈
      • 删除朋友圈
      • 点赞/取消赞
      • 评论/追评
      • 评论删除
    • 个人模块
      • 生成二维码
      • 获取个人信息
      • 更新个人信息
      • 查询企业信息
      • 账号退出
      • 个人收藏-分页
      • 个人收藏-添加GIF表情
    • 标签模块
      • 列表分页
      • 个人标签-增删改
      • 客户标签-增删

    回调结构说明

    说明#

    目前支持
    HTTP回调:消息会通过消息订阅接口配置的HTTP回调地址发送。
    回调类型(data[].cmd)
    11016,账号状态变化消息
    20000, API异步消息
    15500,VX系统消息
    15000,VX普通消息

    账号状态变化消息#

    账号状态变化消息头#

    cmd=11016

    账号状态变化消息响应#

    {
        "code": 0,
        "data": [
            {
                "TenantId": 0,
                "guid": "a3318ad6-5544-4a4f-a1bb-2aa667b2ipad",
                "userId": "1688*****804",
                "requestId": "901efcada57ff16a469411b3e7f1b009",
                "customParam": "",
                "cmd": 11016,
                "msgServerId": 0,
                "msgType": 0,
                "msgUniqueIdentifier": "901efcada57ff16a469411b3e7f1b009",
                "senderId": 0,
                "seq": 1759125951405848,
                "timestamp": 1759125951,
                "msgData": {
                    "guid": "a3318ad6-5544-4a4f-a1bb-2aa667b2ipad",
                    "msg": "login ok",
                    "code": 11001, // 账号状态,见下列表
                    "status": 2, // 二维码状态 0和-1 -离线 1-已扫码待确认 2-在线 3-登录失败 4-用户取消登录 10-已扫码确认,待输6位验证码 
                    "serverReboot": false //服务重启维护标记(功能与热修复合并)
                }
            }
        ],
        "msg": "成功"
    }
    msgData.code码说明
    10000网络异常离线
    11001登录成功
    11002注销成功
    11013刷新session失败
    11017其它端顶号
    11022手机端主动退出,取消设备授权
    11023账号环境出现异常,请重新登录使用
    11024登录态已过期,请重新登录
    11025你正在一台新设备上使用企业微信,需通过手机企业微信扫码进行安全验证

    API异步消息#

    API异步消息头#

    cmd=20000

    API异步消息响应#

    {
        "code": 0,
        "data": [
            {
                "TenantId": 0,
                "guid": "a3318ad6-5544-4a4f-a1bb-2aa667b2ipad",
                "userId": "16****1804",
                "requestId": "57a360fd-f920-4b4d-84c0-351ec1c63fe8",
                "customParam": "",
                "cmd": 20000,
                "msgServerId": 0,
                "msgType": 0,
                "msgUniqueIdentifier": "cf3e312fbae0f4f9a20422609a203a66",
                "senderId": 0,
                "seq": 1759127702979498,
                "timestamp": 1759127702,
                "msgData": {
                    "cloudUrl": "https://foo.com/0485.jpg"
                }
            }
        ],
        "msg": "成功"
    }

    系统消息#

    系统消息头#

    cmd=15500

    系统消息响应#

    {
       "data" : [{
          "cmd":15500
          "msgServerId" : 1017723,
          "msgType" : 2131,
          "msgUniqueIdentifier" : "9FcHZl98QZK_AlX",
          "senderId" : 10030,
          "seq" : 9409929,
          "timestamp" : 1682676419
       }],
       "error" : 0,
       "msg" : "成功"
    }

    V2系统消息类型#

    模块msgTypenewMsgType(v2版本)说明
    联系人相关2131CONTACT_EXTERNAL_CHANGE外部联系人信息(备注/描述/手机号)变动或删除通知
    2313CONTACT_EXTERNAL_BLACKLIST外部联系人加入黑名单通知
    2188CONTACT_INTERNAL_CHANGE内部联系人信息(备注/描述/手机号)变动通知
    2357CONTACT_FRIEND_REQUEST_2357好友申请通知
    2132CONTACT_FRIEND_REQUEST_2132好友申请通知
    2104CONTACT_DND_TOP联系人免打扰/置顶通知
    2115CONTACT_MARK联系人标记操作通知
    标签相关2160TAG_CHAT_CHANGE聊天标签变动通知
    2161TAG_CHAT_CONTACT_CHANGE聊天标签中的联系人变动通知
    2185TAG_CORP_ADD_DEL企业标签新增或删除回调通知
    2186TAG_PERSONAL_ADD_DEL个人标签新增或删除回调通知
    群相关1001GROUP_NAME_CHANGE群名变换通知
    1002GROUP_MEMBER_ADD新增群成员通知
    1003GROUP_MEMBER_REMOVE移除群成员通知
    1005GROUP_MEMBER_QUIT群成员自己退群通知
    1006GROUP_CREATE群新增通知
    1011GROUP_OPERATION_TIP操作提示(如聊天窗口灰小字体消息)
    1022GROUP_OWNER_TRANSFER转让群主通知
    1023GROUP_DISMISS群解散通知
    1029GROUP_INVITE_APPLY群成员邀请其他人进群申请
    1043GROUP_ADMIN_CHANGE群管理员变动通知
    2118GROUP_INFO_CHANGE群信息变动通知:群个微成员自己退群通知
    会话消息2055SESSION_CLEAR清空聊天记录通知
    2002SESSION_DELETE删除聊天通知
    40CALL_END(属于15000,VX普通消息)语音、视频通话结束通知:挂断、拒接、超时等
    503或2166CALL_NOTIFY (503) / CALL_NOTIFY_2166 (2166)语音、视频通话通知:发起、接通、未接等
    朋友圈2215MOMENT_CHANGE朋友变动通知
    517MOMENT_PUSH朋友圈推送通知

    外部联系人信息(备注/电话/描述)变动或删除通知#

    @msgType = 2131
    {
        "code": 0,
        "data": [
            {
                "guid": "29348d4d-5ee4-46c4-d458-7ff764959f16",
                "userId": "168885****703525",
                "requestId": "1c9013db6fa072d9a2e79ebbbc2c377e",
                "customParam": "",
                "cmd": 15500,
                "msgServerId": 1001601,
                "msgType": 2131,
                "msgUniqueIdentifier": "GAC_jZSwSYK4nIv",
                "senderId": 10030,
                "seq": 4649391,
                "timestamp": 1759061799,
                "msgData": null
            }
        ],
        "msg": "成功"
    }

    外部联系人加入黑名单通知#

    @msgType = 2313
    {
        "code": 0,
        "data": [
            {
                "guid": "29348d4d-5ee4-46c4-d458-7ff764959f16",
                "userId": "168885****703525",
                "requestId": "4d61e7b3d86c7ee7b1a5cd25ae21d799",
                "customParam": "",
                "cmd": 15500,
                "msgServerId": 0,
                "msgType": 2313,
                "msgUniqueIdentifier": "4d61e7b3d86c7ee7b1a5cd25ae21d799",
                "senderId": 0,
                "seq": 1759062285546080,
                "timestamp": 1759062285,
                "msgData": {
                    "base64RawData": ""
                }
            }
        ],
        "msg": "成功"
    }

    内部联系人信息(备注/描述)变动通知#

    @msgType = 2188
    {
        "code": 0,
        "data": [
            {
                "guid": "29348d4d-5ee4-46c4-d458-7ff764959f16",
                "userId": "168885****703525",
                "requestId": "37b9d5e6db0f99c7549747973026a134",
                "customParam": "",
                "cmd": 15500,
                "msgServerId": 0,
                "msgType": 2188,
                "msgUniqueIdentifier": "37b9d5e6db0f99c7549747973026a134",
                "senderId": 0,
                "seq": 1759062864546227,
                "timestamp": 1759062864,
                "msgData": {
                    "base64RawData": ""
                }
            }
        ],
        "msg": "成功"
    }

    好友申请通知#

    @msgType = 2357
    {
        "code": 0,
        "data": [
            {
                "guid": "29348d4d-5ee4-46c4-d458-7ff764959f16",
                "userId": "168885****703525",
                "requestId": "3088f0f7e621896ba62b193fe608311f",
                "customParam": "",
                "cmd": 15500,
                "msgServerId": 1001679,
                "msgType": 2357,
                "msgUniqueIdentifier": "contact_apply_friend_across_corp_1821945318",
                "senderId": 10030,
                "seq": 4649430,
                "timestamp": 1759063190,
                "msgData": {
                    "applyTime": 1759063191,
                    "contactId": 78813****061361,
                    "contactNickname": "nihao~",
                    "contactType": "微信",
                    "userId": 197032****006843
                }
            }
        ],
        "msg": "成功"
    }

    好友申请通知#

    @msgType = 2132
    {
        "code": 0,
        "data": [
            {
                "guid": "29348d4d-5ee4-46c4-d458-7ff764959f16",
                "userId": "168885****703525",
                "requestId": "3088f0f7e621896ba62b193fe608311f",
                "customParam": "",
                "cmd": 15500,
                "msgServerId": 1001677,
                "msgType": 2132,
                "msgUniqueIdentifier": "1#queue5@21_98_245_170@8#1759063190|603963534",
                "senderId": 10030,
                "seq": 4649429,
                "timestamp": 1759063190,
                "msgData": null
            }
        ],
        "msg": "成功"
    }

    联系人免打扰/置顶通知#

    @msgType = 2104
    {
        "code": 0,
        "data": [
            {
                "guid": "29348d4d-5ee4-46c4-d458-7ff764959f16",
                "userId": "168885****703525",
                "requestId": "bdbebbf12778f5e5518d4ad962ec601b",
                "customParam": "",
                "cmd": 15500,
                "msgServerId": 0,
                "msgType": 2104,
                "msgUniqueIdentifier": "bdbebbf12778f5e5518d4ad962ec601b",
                "senderId": 0,
                "seq": 1759066658546173,
                "timestamp": 1759066658,
                "msgData": {
                    "base64RawData": ""
                }
            }
        ],
        "msg": "成功"
    }

    联系人标记操作通知#

    @msgType = 2115
    {
        "code": 0,
        "data": [
            {
                "guid": "29348d4d-5ee4-46c4-d458-7ff764959f16",
                "userId": "168885****703525",
                "requestId": "4ed8af85726cfc9312129f17fb975580",
                "customParam": "",
                "cmd": 15500,
                "msgServerId": 1001823,
                "msgType": 2115,
                "msgUniqueIdentifier": "QldP57zKTmiicaB",
                "senderId": 10008,
                "seq": 4649501,
                "timestamp": 1759066380,
                "msgData": null
            }
        ],
        "msg": "成功"
    }

    聊天标签变动通知#

    @msgType = 2160
    {
        "code": 0,
        "data": [
            {
                "guid": "29348d4d-5ee4-46c4-d458-7ff764959f16",
                "userId": "168885****703525",
                "requestId": "d9f9a49b83f689153deeeaa2fe9ad39b",
                "customParam": "",
                "cmd": 15500,
                "msgServerId": 0,
                "msgType": 2160,
                "msgUniqueIdentifier": "d9f9a49b83f689153deeeaa2fe9ad39b",
                "senderId": 0,
                "seq": 1759063590545703,
                "timestamp": 1759063590,
                "msgData": {
                    "base64RawData": ""
                }
            }
        ],
        "msg": "成功"
    }

    聊天标签中的联系人变动通知#

    @msgType = 2161
    {
        "code": 0,
        "data": [
            {
                "guid": "29348d4d-5ee4-46c4-d458-7ff764959f16",
                "userId": "168885****703525",
                "requestId": "6e63b099cb77beedbf63a6a8344c1249",
                "customParam": "",
                "cmd": 15500,
                "msgServerId": 0,
                "msgType": 2161,
                "msgUniqueIdentifier": "6e63b099cb77beedbf63a6a8344c1249",
                "senderId": 0,
                "seq": 1759067145546389,
                "timestamp": 1759067145,
                "msgData": {
                    "base64RawData": ""
                }
            }
        ],
        "msg": "成功"
    }

    企业标签新增或删除通知#

    @msgType = 2185
    {
        "code": 0,
        "data": [
            {
                "guid": "29348d4d-5ee4-46c4-d458-7ff764959f16",
                "userId": "168885****703525",
                "requestId": "4e86da4e6cb1399b51d73b7b5ce04d5e",
                "customParam": "",
                "cmd": 15500,
                "msgServerId": 0,
                "msgType": 2185,
                "msgUniqueIdentifier": "4e86da4e6cb1399d73b4d5e",
                "senderId": 0,
                "seq": 1759127100514634,
                "timestamp": 1759127100,
                "msgData": {
                    "base64RawData": ""
                }
            }
        ],
        "msg": "成 功"
    }

    个人标签新增或删除通知#

    @msgType = 2186
    {
        "code": 0,
        "data": [
            {
                "guid": "29348d4d-5ee4-46c4-d458-7ff764959f16",
                "userId": "168885****703525",
                "requestId": "4ae8e01dd86b9fa0db0aaeec83e2658d",
                "customParam": "",
                "cmd": 15500,
                "msgServerId": 0,
                "msgType": 2186,
                "msgUniqueIdentifier": "4ae8e01dd86b9fa0db0aaeec83e2658d",
                "senderId": 0,
                "seq": 1759062104545868,
                "timestamp": 1759062104,
                "msgData": {
                    "base64RawData": ""
                }
            }
        ],
        "msg": "成功"
    }

    群名变更通知#

    @msgType = 1001
    {
        "code": 0,
        "data": [
            {
                "guid": "29348d4d-5ee4-46c4-d458-7ff764959f16",
                "userId": "168885****703525",
                "requestId": "ce6a7f71fe54e031d6dd279a4718a59e",
                "customParam": "",
                "cmd": 15000,
                "base64RawData": "MTExx",
                "fromRoomId": 239655862281126,
                "isRoomNotice": 0,
                "msgData": {
                    "changedMemberList": "MTExx"
                },
                "msgServerId": 1001723,
                "msgType": 1001,
                "msgUniqueIdentifier": "980B862017D3D56CCA29049",
                "receiverId": 0,
                "senderId": 168885****703525,
                "senderName": "",
                "timestamp": 1759064201,
                "seq": 4649451
            }
        ],
        "msg": "成功"
    }

    新增群成员通知#

    @msgType = 1002
    {
        "code": 0,
        "data": [
            {
                "guid": "29348d4d-5ee4-46c4-d458-7ff764959f16",
                "userId": "168885****703525",
                "requestId": "ec91d856e9ef964069edf6c3d7814fa8",
                "customParam": "",
                "cmd": 15000,
                "base64RawData": "MTY4ODg1NTk4OTY0MjQ4Nw==",
                "fromRoomId": 239655862281126,
                "isRoomNotice": 0,
                "msgData": {
                    "changedMemberList": "MTY4ODg1NTk4O0MjQ4Nw=="
                },
                "msgServerId": 1001731,
                "msgType": 1002,
                "msgUniqueIdentifier": "CAMQleLkxgYYCCPydH7AQ==",
                "receiverId": 0,
                "senderId": 168885****703525,
                "senderName": "",
                "timestamp": 1759064340,
                "seq": 4649455
            }
        ],
        "msg": "成功"
    }

    移除群成员通知#

    @msgType = 1003
    {
        "code": 0,
        "data": [
            {
                "guid": "29348d4d-5ee4-46c4-d458-7ff764959f16",
                "userId": "168885****703525",
                "requestId": "a2cf5549a40a49c30c0b646b41dddd32",
                "customParam": "",
                "cmd": 15000,
                "base64RawData": "MTY4ODg1NTk4OTY0MjQ4Nw==",
                "fromRoomId": 239655862281126,
                "isRoomNotice": 0,
                "msgData": {
                    "changedMemberList": "MTY4ODg1NTk4OTY0MNw=="
                },
                "msgServerId": 1001727,
                "msgType": 1003,
                "msgUniqueIdentifier": "CAMQ0uHkxgYYACCklNg==",
                "receiverId": 0,
                "senderId": 168885****703525,
                "senderName": "",
                "timestamp": 1759064273,
                "seq": 4649453
            }
        ],
        "msg": "成功"
    }

    群成员自己退群通知#

    @msgType = 1005
    {
        "code": 0,
        "data": [
            {
                "guid": "29348d4d-5ee4-46c4-d458-7ff764959f16",
                "userId": "168885****703525",
                "requestId": "2e1142644d91dca1348ac4501944b358",
                "customParam": "",
                "cmd": 15000,
                "base64RawData": "",
                "fromRoomId": 239655862281126,
                "isRoomNotice": 0,
                "msgData": {
                    "changedMemberList": ""
                },
                "msgServerId": 1001741,
                "msgType": 1005,
                "msgUniqueIdentifier": "CAMQ6OPkxgYYACD8rNBQ==",
                "receiverId": 0,
                "senderId": 168885****703525,
                "senderName": "",
                "timestamp": 1759064552,
                "seq": 4649460
            }
        ],
        "msg": "成功"
    }

    群新增通知#

    @msgType = 1006
    {
        "code": 0,
        "data": [
            {
                "guid": "29348d4d-5ee4-46c4-d458-7ff764959f16",
                "userId": "168885****703525",
                "requestId": "e5cd23ac9a9efe94e2886b69b8a51881",
                "customParam": "",
                "cmd": 15000,
                "base64RawData": "MTY4ODg1NTk4OTY0MjQ4NzsxNjODjUxzQwOzE2ODg4NTc2MzE2NTE4MDQ=",
                "fromRoomId": 239655862281126,
                "isRoomNotice": 0,
                "msgData": {
                    "changedMemberList": "MTY4ODg1NTk4OTY0MjQ4NzsxNjg4ODxNzQwOzE2ODg4NTc2MzE2NTE4MDQ="
                },
                "msgServerId": 1001717,
                "msgType": 1006,
                "msgUniqueIdentifier": "01C91A68CA77CE2ADE2FA65",
                "receiverId": 0,
                "senderId": 168885****703525,
                "senderName": "",
                "timestamp": 1759064011,
                "seq": 4649448
            }
        ],
        "msg": "成功"
    }

    转让群主通知#

    @msgType = 1022
    {
        "code": 0,
        "data": [
            {
                "guid": "29348d4d-5ee4-46c4-d458-7ff764959f16",
                "userId": "168885****703525",
                "requestId": "799da03e3f6ce387be909d89afd8506c",
                "customParam": "",
                "cmd": 15000,
                "base64RawData": "CiMInLvZs5CAgAMSGOW3sueaIkOS4uuaWsOeahOe+pOS4uw==",
                "fromRoomId": 239655862281126,
                "isRoomNotice": 0,
                "msgData": {
                    "base64RawData": "CiMInLvZs5CAgAMSGOW3sueaIkOS4uuaWsOeahOe+pOS4uw=="
                },
                "msgServerId": 1001735,
                "msgType": 1022,
                "msgUniqueIdentifier": "8CF3D1CDBB1DE9F41767EA8B54DFB4D2",
                "receiverId": 0,
                "senderId": 168885****703525,
                "senderName": "",
                "timestamp": 1759064436,
                "seq": 4649457
            }
        ],
        "msg": "成功"
    }

    群解散通知#

    @msgType = 1023
    {
        "code": 0,
        "data": [
            {
                "guid": "29348d4d-5ee4-46c4-d458-7ff764959f16",
                "userId": "168885****703525",
                "requestId": "83716546c7981e9e9750a05543419e99",
                "customParam": "",
                "cmd": 15000,
                "base64RawData": "CKXD3OKIAD",
                "fromRoomId": 261023134682181,
                "isRoomNotice": 0,
                "msgData": {
                    "base64RawData": "CKXD3OKIAD"
                },
                "msgServerId": 1001757,
                "msgType": 1023,
                "msgUniqueIdentifier": "3A6ED270EF7DBA9E19A63BBEE8B50",
                "receiverId": 0,
                "senderId": 168885****703525,
                "senderName": "",
                "timestamp": 1759064794,
                "seq": 4649468
            }
        ],
        "msg": "成功"
    }

    群管理员变动通知#

    @msgType = 1043
    {
        "code": 0,
        "data": [
            {
                "guid": "29348d4d-5ee4-46c4-d458-7ff764959f16",
                "userId": "168885****703525",
                "requestId": "36c20d59707dc5a42965adab9b062ffc",
                "customParam": "",
                "cmd": 15000,
                "base64RawData": "CKXD3OKRgIADEJy72bOIADGAA=",
                "fromRoomId": 261023134682181,
                "isRoomNotice": 0,
                "msgData": {
                    "base64RawData": "CKXD3OKRgIADEJy72bOIADGAA="
                },
                "msgServerId": 1001749,
                "msgType": 1043,
                "msgUniqueIdentifier": "W_03aLPiSBCJFck",
                "receiverId": 0,
                "senderId": 168885****703525,
                "senderName": "",
                "timestamp": 1759064693,
                "seq": 4649464
            }
        ],
        "msg": "成功"
    }

    清空聊天记录通知#

    @msgType = 2055
    {
        "code": 0,
        "data": [
            {
                "guid": "29348d4d-5ee4-46c4-d458-7ff764959f16",
                "userId": "168885****703525",
                "requestId": "5136bc98b58102fe96ff481ca6535045",
                "customParam": "",
                "cmd": 15000,
                "base64RawData": "CI+U==",
                "fromRoomId": 0,
                "isRoomNotice": 0,
                "msgData": {
                    "base64RawData": "CI+U=="
                },
                "msgServerId": 1002015,
                "msgType": 2055,
                "msgUniqueIdentifier": "CAMQ2frkxgYYpMg0s+M7gE=",
                "receiverId": 168885****651740,
                "senderId": 168885****703525,
                "senderName": "",
                "timestamp": 1759067481,
                "seq": 4649597
            }
        ],
        "msg": "成功"
    }

    删除聊天通知#

    @msgType = 2002
    {
        "code": 0,
        "data": [
            {
                "guid": "29348d4d-5ee4-46c4-d458-7ff764959f16",
                "userId": "168885****703525",
                "requestId": "e5126ebae55db04c445179237baa8229",
                "customParam": "",
                "cmd": 15000,
                "base64RawData": "",
                "fromRoomId": 0,
                "isRoomNotice": 0,
                "msgData": {
                    "base64RawData": ""
                },
                "msgServerId": 1002021,
                "msgType": 2002,
                "msgUniqueIdentifier": "CAMQ+PvkxgYYpcP57/BhQ8=",
                "receiverId": 168885****651740,
                "senderId": 168885****703525,
                "senderName": "",
                "timestamp": 1759067640,
                "seq": 4649600
            }
        ],
        "msg": "成功"
    }

    普通消息#

    普通消息 MQTT Topic#

    系统消息topic: /wework/msg/receive

    普通消息头#

    cmd=15000

    普通消息响应#

    {
      "code": 0,
      "msg": "成功",
      "data": [{
        "guid": "2cc69541-4e71-46e6-9389-65563e0da1c2",
        "cmd":15000,
        "base64RawData": "CAMQ0e+yBA==",
        "fromRoomId": 10791082136095292,
        "isRoomNotice": 0,
        "msgData": null,
        "msgServerId": 1002114,
        "msgType": 2001,
        "msgUniqueIdentifier": "CAQQnLb7rgYY1+C/qomAgAMgk+2roAM=",
        "receiverId": 0,
        "senderId": 1688852365307991,
        "senderName": "",
        "timestamp": 1709103900
      }]
    }

    普通消息类型#

    通过 @msgType 来区分具体的消息类型. @msgType不同, @msgData值也不同
    msgTypenewMsgType(v2版本)说明
    0 or 2TEXT, TEXT_ALT文本
    7 OR 14 OR 101IMAGE, IMAGE_14, IMAGE_101一般图片
    22 OR 23 OR 103VIDEO, VIDEO_23, VIDEO_103一般视频
    20 OR 15 OR 102FILE_20, FILE, FILE_102一般文件
    29 OR 104GIF_29, GIF_104Gif
    20FILE_20大文件(> 20M)
    22VIDEO大视频(> 20M)
    6LOCATION位置
    13LINK链接
    41BUSINESS_CARD名片
    26RED_PACKET红包
    16VOICE语音
    78MINI_PROGRAM小程序
    123MIXED图文混合消息
    141VIDEO_CHANNEL视频号
    146LIVE直播
    213SOLITAIRE接龙
    2001READ_NOTIFY消息已读通知
    2005UNREAD_NOTIFY消息未读通知
    2063REVOKE撤回消息

    文本消息#

    {
      "atList": [
        {
          "userId": "788FFFFFF987664",
          "nickname": "全*X"
        },
        {
          "userId": "168BBBBBB0713881",
          "nickname": "陈*X"
        }
      ],
      "content": "@全*X  aaa @陈*X  bbb"
    }

    企微图片消息#

    @msgType = 14
    {
      "fileAeskey": "63663835383636623339343264346435",
      "fileId": "30680201020461305f0201000204445cc78202030f42410204bf7a587502046437f134042464383364663233352d326538362d346432392d386134312d3033643932303835623266620201000202034004101e3cfce05a05bbfafbc6c80a3444f7a40201010201000400",
      "fileMd5": "1e3cfce05a05bbfafbc6c80a3444f7a4",
      "fileName": "5LyB5Lia5b6u5L+h5oiq5Zu+XzE2ODEzODc4MjgyMTk2LnBuZw==",
      "fileSize": 819,
      "imageHasHd": true
    }

    个微图片消息#

    @msgType = 101
    {
             "fileAeskey" : "01bbda3d34aac6def0f9551979a7055e",
             "fileAuthkey" : "v1_9a250fbfeb25d7839e2df608373d037d2b8e6cc04af8e8eb3eb8bdf55148a704f8311bef995cc94fd279e901f8795ecd32fd7500e10a60d41bb1093b9cfa1e92",
             "fileBigHttpUrl" : "https://imunion.weixin.qq.com/cgi-bin/mmae-bin/tpdownloadmedia?param=v1_9a250fbfeb25d7839e2df608373d037d2b8e6cc04af8e8eb3eb8bdf55148a704de7335ff6b87fa02a75297341f4b53f723cca99e61929bca36385fb490c40d711be3df5688bb34d6500ae587d3bedca1e6722226551f589d3849c8ba89e03d908ab54ab63c3610b6b098e71a14eb2b422b1113a518638437556caa395851dfcc5007d3348c707f295a016bdf9859399ef975faa462b2ccca3e3a3bf5855360014b8dbbeea745f1e21d2378e5fec93000c967940afb736c039258d104e6cd8ce658be635ddf692704915348800a3cb18b31ece7a2347d4f3affbeb43277089589e10fcbd44a6a8108a9bf84d14689d7e91e90699fe2388d507932ad7700c278ab",
             "fileBigSize" : 254,
             "fileMd5" : "a1aeb5166748cb66189c733e9b68f4a9",
             "fileMiddleHttpUrl" : "https://imunion.weixin.qq.com/cgi-bin/mmae-bin/tpdownloadmedia?param=v1_9a250fbfeb25d7839e2df608373d037d2b8e6cc04af8e8eb3eb8bdf55148a704de7335ff6b87fa02a75297341f4b53f723cca99e61929bca36385fb490c40d711be3df5688bb34d6500ae587d3bedca1e6722226551f589d3849c8ba89e03d908ab54ab63c3610b6b098e71a14eb2b422b1113a518638437556caa395851dfcc5007d3348c707f295a016bdf9859399ef975faa462b2ccca3e3a3bf5855360014b8dbbeea745f1e21d2378e5fec93000c967940afb736c039258d104e6cd8ce658be635ddf692704915348800a3cb18b31ece7a2347d4f3affbeb43277089589e10fcbd44a6a8108a9bf84d14689d7e91e90699fe2388d507932ad7700c278ab",
             "fileMiddleSize" : 254,
             "fileName" : "",
             "fileThumbHttpUrl" : "https://imunion.weixin.qq.com/cgi-bin/mmae-bin/tpdownloadmedia?param=v1_9a250fbfeb25d7839e2df608373d037d2b8e6cc04af8e8eb3eb8bdf55148a704be0538b3487a5a0b5a07d22b74a09c2bfc2f458402c83f1bf27df723f8a568ca55c9bc5d23532c326c4c5d4d97e74dbcabde472465c1ea966b9d63c1836ce94c118082ce46210a82c82eb8f606945fa4f5e4ef316140eaa4adc4eaa146e65e86c9a9f31e430761e19f7686211c5628e8c3a0814c336ad97ce6e5f03de0f1745dae8423e77ca259979635923789194fa7bbc092a3577f6e910571f9d237e663767deccaa1d456be5eab661e8ac9a4561c06dc19373b769f08c6bba8061c3f72993090a580e5446fce9a92e8b6ed4d345972b60314d5b132d9e89be5ae87c2976b",
             "fileThumbSize" : 739,
             "imageHasHd" : false
          }

    企微视频消息#

    @msgType = 23
    {
      "coverImageAeskey": "",
      "coverImageId": "3069020102046230600201000204445cc78202030f42410204bf7a587502046437f19e042436313635363664652d356534302d343732652d383636642d663434373639633934353661020100020304de5004104df4e056138311f099819fbcfe14e7a10201040201000400",
      "coverImageMd5": "fe3b08a566af99e7ab2c964464402ee2",
      "coverImageSize": 11284,
      "duration": 5,
      "fileAeskey": "38663530393138623030313335333533",
      "fileId": "3069020102046230600201000204445cc78202030f42410204bf7a587502046437f19e042436313635363664652d356534302d343732652d383636642d663434373639633934353661020100020304de5004104df4e056138311f099819fbcfe14e7a10201040201000400",
      "fileMd5": "4df4e056138311f099819fbcfe14e7a1",
      "fileName": "ZG93bmxvYWRfeG1sX3ZpZC5tcDQ=",
      "fileSize": 319044
    }

    个微视频消息#

    @msgType = 103
    {
      "coverImageHttpUrl": "https://imunion.weixin.qq.com/cgi-bin/mmae-bin/tpdownloadmedia?param=v1_9",
      "coverImageSize": 11284,
      "duration": 5,
      "fileAeskey": "38663530393138623030313335333533",
      "fileAuthkey": "38663530393138623030313335333533",
      "fileHttpUrl": "https://imunion.weixin.qq.com/cgi-bin/mmae-bin/tpdownloadmedia",
      "fileMd5": "4df4e056138311f099819fbcfe14e7a1",
      "fileName": "ZG93bmxvYWRfeG1sX3ZpZC5tcDQ=",
      "fileSize": 319044
    }

    企微文件消息#

    @msgType = 15
    {
      "fileAeskey": "38663530393138623030313335333533",
      "fileId": "38663530393138623030313335333533",
      "fileMd5": "4df4e056138311f099819fbcfe14e7a1",
      "fileName": "ZG93bmxvYWRfeG1sX3ZpZC5tcDQ=",
      "fileNameExt": "excel",
      "fileSize": 319044
    }

    个微文件消息#

    @msgType = 102
    {
      "fileAeskey": "38663530393138623030313335333533",
      "fileAuthkey": "38663530393138623030313335333533",
      "fileHttpUrl": "https://imunion.weixin.qq.com/cgi-bin/mmae-bin/tpdownloadmedia",
      "fileMd5": "4df4e056138311f099819fbcfe14e7a1",
      "fileName": "ZG93bmxvYWRfeG1sX3ZpZC5tcDQ=",
      "fileSize": 319044
    }

    GIF消息#

    企微GIF消息, @msgType = 29
    个微GIF消息, @msgType = 104
    {
      "fileHttpUrl": "https://imunion.weixin.qq.com/cgi-bin/mmae-bin/tpdownloadmedia",
      "fileMd5": "4df4e056138311f099819fbcfe14e7a1",
      "fileName": "ZG93bmxvYWRfeG1sX3ZpZC5tcDQ=",
      "fileSize": 319044
    }

    位置消息#

    @msgType = 6
    {
      "address": "5LqR5Y2X55yB5b63*****5bee55Ge5Li95biC",
      "latitude": 24.085241,
      "longitude": 97.93544,
      "title": "",
      "zoom": 8
    }

    链接消息#

    @msgType = 13
    {
      "desc": "NOaciDnml6UtNOaciDE55pel56aP5Yip5Lqr5LiN5YGc",
      "iconAeskey": "",
      "iconAuthkey": "",
      "iconSize": 0,
      "iconUrl": "https://mmbiz.qpic.cn/mmbiz_jpg/N8l8hBLgLnBhKCwiaj2QQiaDJKa2pgIdlm8pibaSricnKlV4Vecia1q0PxyzEZcibxDUxKSCksCn8FCibKZ5IBnVicczfg/300?wxtype=jpeg&wxfrom=0",
      "linkUrl": "http://mp.weixin.qq.com/s?__biz=MjM5MzMwNTIyNQ==&mid=2889322723&idx=2&sn=473d7af39094956add11035e97edfc55&chksm=8f5a3705b82dbe13d3e2524127312cb1a26ebc452fbd90e8a166192d67451269923e32675518#rd",
      "title": "5YWR56ev5YiG6LWiaVBob25l44CB55u05pKt56aP5Yip5aSn5pS+6YCBLi4uNOaciOmCruaUv+S8muWRmOaXpeeyvuW9qeW8gOWQr++8gQ=="
    }

    名片消息#

    @msgType = 41
    {
      "avatarUrl": "http://wx.qlogo.cn/mmhead/PiajxSqB***w/0",
      "corpId": 0,
      "corpName": "5b6u5L+h",
      "nickname": "eHhx",
      "realName": "",
      "shared_id": "78813*****"
    }

    红包消息#

    @msgType = 26
    {
      "coverUrl1x": "http://dldir1.qq.com/qqcontacts/hongbao1x_20160413.png",
      "coverUrl2x": "http://dldir1.qq.com/qqcontacts/hongbao2x_20160413.png",
      "hongbaoSubtype": 3,
      "hongbaoType": 1,
      "lookWording": "来自*的红包,请进入手机版企业微信查看",
      "orderId": "1800008896202304147042530242005",
      "recvWording": "来自*的红包,请进入手机版企业微信领取",
      "ticket": "CMmt/ciXgIADEvIBQUFSeEh*FQMGN5SDNvcENsc3YlMkZCY05kZUk5byUyRjdJeTYzOXQ1VGclM0QlM0QYAg==",
      "toIdList": [
        "1688*01"
      ],
      "totalAmount": 1,
      "wishingContent": "5oGt5Zac5*Sn5Yip"
    }

    语音消息(语音消息下载默认走企微文件下载文件格式为.silk)#

    @msgType = 16
    {
     "fileAesKey": "7866746C766E6967706173667363786A",
     "fileId": "308183020***002040b80dfe20201000400",
     "fileMd5": "18eee3d1cc8401c059fb2bd075bb1a44",
     "fileSize": 8934,
     "voiceTime": 5
    }

    小程序消息#

    @msgType = 78
    {
      "appid" : "wxbb58*e267a6",
      "coverImageAeskey" : "79736C7*7A687A61796E79",
      "coverImageId" : "306a0201020******000201010201000400",
      "coverImage_md5" : "7d39f52a8f****f0713e039db4",
      "coverImageSize" : 29973,
      "desc" : "5Yi356CB5LmY6L****35Ye66KGM",
      "iconUrl" : "http://mmbiz.qpic.cn/mmbiz_png/8WyShxgibG6r7ULkN1s2B4GKsAVaMu7ibUbnoed9XsF3I72FibRiataPOOSIx9Qh0yOGu2M4oMicRGGQULGCvJF50IQ/640?wx_fmt=png&wxfrom=200",
      "pagepath" : "pages/qrcode/index.html?city_code=**&yktId=**",
      "title" : "5LmY6L2m56CB",
      "username" : "gh_3cf62f4f1d52@app"
    }

    文字图片混合消息#

    @msgType = 123
    [
      {
        "subMsgData" : {
          "fileAeskey" : "333936643*3638653330323865",
          "fileId" : "30680201020461305f0201000204791f56c90*1000400",
          "fileMd5" : "2c5817af1f2b45b9*2f74",
          "fileName" : "5LyB5Lia5b6*1MzkxMzkzLnBuZw==",
          "fileSize" : 1467,
          "imageHasHd" : true
        },
        "subMsgType" : 14
      },
      {
        "subMsgData" : {
          "atList" : null,
          "content" : "NDQ="
        },
        "subMsgType" : 2
      }
    ]

    视频号消息#

    @msgType = 141
    {
      "channelName" : "56S+5Lqk5oKN5*rCPmkJ7nrJE=",
      "channelUrl" : "https://channels.weixin.qq.com/web/pages/feed?eid=export%2FUzFfAgtgekIEAQAAAAAAbGcKSpm5SQAAAAstQy6ubaLX4KHWvLEZgBPEmqNgX0kxabqAzNPgMIIxoXjcO3PYZnnb79Etrr24",
      "coverUrl" : "http://wxapp.tc.qq.com/251/20304/stodownload?encfilekey=oibeqyX228riaCwo9STVsGLIBn9G5YG8Znb7zEwxdcZBiczmey8uf0s0RYcKa5sasQ75PcLrwyIKHzuDPJ3svQ3Uue9SoSQPJq639RqKpWmib*WLkLjxUmN2RAianLzWToEciaDVic2BApomqBPSYQ&finder_expire_time=1682070545&finder_eid=export%2FUzFfAgtgekIEAQAAAAAAbGcKSpm5SQAAAAstQy6ubaLX4KHWvLEZgBPEmqNgX0kxabqAzNPgMIIxoXjcO3PYZnnb79Etrr24",
      "encodeData" : "CAEQACL+GwAE9OmXBAAAAQAAAAAAXdoVrf3L1a0P3JEhOWQgAAAAaeq5SzX7s7sPwaz04zCEwYwyALHFYGIb/l1etP1AtP0Q+cWXZRxa*F19seb6eqleM3L1H1kJczStWQyWdq5ez0ZWYUmKdvSkwrL6qF0VFnRumXxiCJ9ZqNXw*A",
      "headImgUrl" : "http://wx.qlogo.cn/finderhead/ver_1/k9HrnDHS*KdzG60kpz8rklSiarmaHUKuiaibDQo68hUEYPE5EtQsibiaC3R8zOejrs8gDZ0IA/0",
      "username" : "5LiK5a*566r"
    }
    修改于 2026-05-29 08:38:16
    上一页
    开发前必读
    下一页
    客户端用例
    Built with