企微协议 SAAS
个微接口
个微接口
    • 必读文档(问问题前先看完这里)
    • 枚举类
    • 回调
    • 常见问题 QA
    • 客户端
      • 升级实例
        POST
      • 恢复实例
        POST
      • 停止实例
        POST
      • 设置实例通知地址
        POST
      • 设置实例桥接ID
        POST
      • 设置实例代理
        POST
    • 登录
      • 获取登录二维码
        POST
      • 检查登录二维码
        POST
      • 推送手机确认登录通知
        POST
      • 登录验证码
        POST
      • 自动登录
        POST
      • 扫码登录[无需调用]
        POST
      • 保持登录[无需调用]
        POST
    • 用户
      • 获取当前帐号信息
        POST
      • 获取当前帐号公司信息
        POST
      • 登出
        POST
      • 获取二维码名片 (新)
        POST
      • 获取二维码名片
        POST
      • 获取绑定的微信信息
        POST
    • 消息
      • 接收消息
      • 发送文本消息
        POST
      • 发送群@消息
        POST
      • 发送语音消息
        POST
      • 发送位置消息
        POST
      • 发送图片消息
        POST
      • 发送文件消息
        POST
      • 发送视频消息
        POST
      • 发送大视频消息
        POST
      • 发送Gif消息
        POST
      • 发送Gif消息
        POST
      • 发送名片
        POST
      • 发送链接
        POST
      • 发送小程序
        POST
      • 发送视频号
        POST
      • 获取语音消息翻译id
        POST
      • 获取语音消息翻译结果
        POST
      • 确认企微内部消息已读
        POST
      • 撤回消息
        POST
      • 标记会话已读
        POST
      • 发送聊天合集(合并转发)
        POST
      • 发送视频号直播
        POST
      • 发送引用消息
        POST
      • 发送微信小店商品信息
        POST
    • 联系人
      • 同步联系人
      • 同步申请好友列表
      • 批量获取用户信息
      • 批量获取公司信息
      • 更新联系人
      • 搜索微信/企微用户
      • 添加搜索的微信用户
      • 添加搜索的企微用户
      • 添加名片为联系人
      • 通过二维码名片添加微信用户
      • 添加被对方的删除联系人
      • 同意联系人申请
      • 删除联系人
      • 通过二维码获取联系人
      • 操作黑名单
    • 群聊
      • 获取客户群列表(自己是群主)
      • 批量获取群详细信息
      • 批量获取群成员详细信息
      • 增量同步群信息
      • 创建外部群
      • 创建内部群
      • 创建空的外部群
      • 修改群名称
      • 邀请/添加群成员
      • 移除群成员
      • 修改群公告
      • 转让群主
      • 添加群管理员
      • 移除群管理员
      • 开启/关闭群邀请确认
      • 退出群
      • 解散群
      • 添加群联系人
      • 通过群邀请链接进群
      • 修改群内昵称
      • 修改群备注
      • 获取群二维码
      • 开启/关闭禁止互相添加为联系人、禁止修改群名接口
      • 设置群自动回复
    • 云存储
      • 本目录必读
      • 视频预览图片上传
    • 开放平台
      • 开放平台说明
    • 私有化云存储
      • 私有化云存储
      • 大文件下载
      • C2C文件下载
      • 大文件上传
      • C2C文件上传
      • 微信文件下载
    • 标签
      • 同步获取标签列表
      • 创建标签
      • 批量为成员添加标签
      • 删除标签
      • 修改标签
      • 为成员添加多个标签
    • 朋友圈
      • 获取发布的朋友圈记录
      • 设置朋友圈封面
      • 设置朋友圈签名
      • 发布朋友圈
      • 删除朋友圈
      • 点赞
      • 评论
      • 获取指定朋友圈详情
      • 删除评论
      • 确认朋友圈任务
    • 同步
      • 推送同步消息
      • 同步联系人数据
      • 同步消息
    • CDN
      • 获取私有化云存储文件
      • 获取CDN信息
      • 获取bigcdn上传信息appid和authkey
      • 获取bigcdn下载信息url和auth_cookie
      • C2C转企微ID
    • 数据模型
      • Schemas
        • AcceptInviteUrlModel
        • main.BaseRequest
        • AddCardContactModel
        • main.CloudBigDownloadRequest
        • AddDeletedContactModel
        • main.CloudBigUploadRequest
        • AddRoomContactModel
        • main.CloudC2cDownloadRequest
        • AddImageModel
        • main.CloudC2cUploadRequest
        • AddSearchWxContactModel
        • main.CloudWxDownloadRequest
        • AddSearchWxWorkContactModel
        • main.CommonResponse
        • AgreeContactModel
        • ApplyVoiceToTextModel
        • ArchNodeModel
        • BatchGetCorpInfoModel
        • ApplyRoomTemplatesToRoomsModel
        • BatchGetRoomDetailModel
        • AutoLoginModel
        • BatchGetRoomMemberDetailModel
        • BatchGetUserInfoModel
        • BatchInsertContactLabelModel
        • ChangeRoomMasterModel
        • ChatIdToRoomIdModel
        • CheckLoginQRCodeModel
        • BigDownloadModel
        • ClientBridgeModel
        • BigUploadModel
        • ConfirmMsgModel
        • C2CDownloadModel
        • CreateClientModel
        • C2CUploadModel
        • CreateEmptyOuterRoomModel
        • CreateInnerRoomModel
        • CreateLabelModel
        • CheckCanSendGroupMsgModel
        • CreateOuterRoomModel
        • CreateRoomWelcomeModel
        • ClientModel
        • CheckOAuthModel
        • DeleteContactModel
        • ClientProxyModel
        • DeleteLabelModel
        • DismissRoomModel
        • ConfirmGroupSendForCustomerModel
        • GetAntiSpamListModel
        • GetArchNodeDataModel
        • ConfirmSendSnsTaskModel
        • GetBlackListModel
        • GetCorpInfoModel
        • GetLoginQRCodeModel
        • GetProfileModel
        • CreateSessionTagModel
        • GetRoomListModel
        • DelSessionTagModel
        • GetRoomQRCodeModel
        • GetRoomWelcomeListModel
        • GetSnsRecordListModel
        • DeleteSnsCommentModel
        • HTTPValidationError
        • DeleteSnsModel
        • InviteRoomMemberModel
        • LogoutModel
        • ManualLoginModel
        • ModifyRoomInviteStatusModel
        • GetAttachmentItemModel
        • ModifyRoomNameGuardModel
        • GetBannerListModel
        • FinderProductMessage
        • ModifyRoomNameModel
        • ModifyRoomNoticeModel
        • GetClientStatusModel
        • OpenIdToVidModel
        • GetClientVersionModel
        • OprRoomBlackListModel
        • GetContactByQrcodeModel
        • OprRoomWhiteListModel
        • PostSnsModel
        • GetRoomTopMsgModel
        • GetBindWxInfo
        • QueryVoiceToTextModel
        • GetPersonBannerListModel
        • QuitRoomModel
        • GetSessionInTagListModel
        • RemoveRoomMemberModel
        • GetSessionListModel
        • ReportUnReadModel
        • GetSessionTagListModel
        • GetGroupMsgDetailModel
        • RestoreClientModel
        • GetSnsDetailModel
        • RevokeMsgModel
        • RoomAddAdminModel
        • RoomIdToChatIdModel
        • RoomRemoveAdminModel
        • SearchContactModel
        • SendFeedVideoModel
        • ModSessionInTagModel
        • SendFileModel
        • ModSessionTagModel
        • GetSessionConfigModel
        • GetRoomTemplatesModel
        • SendGifModel
        • ModifyColleagueInfoModel
        • InsertContactLabelsModel
        • SendImageModel
        • ModifyInRoomNicknameModel
        • SendLinkModel
        • ModifyLabelModel
        • LabelInfoModel
        • SendLocationModel
        • SendPersonalCardModel
        • SendRoomAtModel
        • SendTextModel
        • SendVideoModel
        • ModifyRoomRemarkModel
        • SendVoiceModel
        • SendWeAppModel
        • SetAntiSpamRuleModel
        • SetRoomWelcomeModel
        • SetSnsCoverModel
        • PushLoginUrlModel
        • SetSnsSignModel
        • StopClientModel
        • SyncApplyContactModel
        • SyncArchModel
        • RemoveRoomTopMsgModel
        • ModifyRoomAdminFlagModel
        • SyncContactModel
        • ModifyRoomAutoReplyModel
        • SyncLabelListModel
        • SyncMsgModel
        • SyncMultiDataModel
        • PushSyncMsgModel
        • UpdateCdnRuleModel
        • UpdateContactModel
        • ValidationError
        • VidToOpenIdModel
        • OprContactBlackListModel
        • BigDownloadModel
        • BigUploadModel
        • SendForwardMsgModel
        • C2CDownloadModel
        • C2CUploadModel
        • SendGifUrlModel
        • WxDownloadModel
        • SendGroupMsgModel
        • NotifyUrlModel
        • QueryGroupMsgRoomListModel
        • BigDownloadModel
        • QueryGroupMsgSendConfirmListModel
        • BigUploadModel
        • SendFeedLiveModel
        • C2CDownloadModel
        • C2CUploadModel
        • WxDownloadModel
        • NotifyUrlModel
        • SetRoomTopMsgModel
        • RoomConfirmAddMemberModel
        • SetSessionModel
        • SendBigVideoModel
        • SnsCommentModel
        • SnsLikeModel
        • SendFinderProductMsgModel
        • SetNotifyMsgFlagModel
        • SyncRoomInfoModel
        • VerifyLoginQRCodeModel
        • WxDownloadModel
        • SyncColleagueInfoModel
        • UpdateClientModel
        • VidToExternalUserIdModel
        • ShopInfo
        • SyncGroupMsgSendStatusModel
        • UploadVideoPreviewImageModel
    个微接口
    个微接口

    回调

    设置回调#

    调用 设置实例通知地址 接口

    11002 二维码变化#

    {
        "guid": "xxx",
        "notify_type": 11002,
        "data": {
            "status": 2,
            "vid": 16888,
            "nickname": "xxx",
            "avatar": "https://wework.qpic.cn/wwpic/272167_xhmhygOzS1WxnuS_1661671810/0",
            "logo": "https://p.qlogo.cn/bizmail/aX7ic9VdupfOHhPqTaxLloE2B1fePxuic5A8qN2fDRq7KibYXr6JpPD0A/0",
            "corp_id": 197032
        }
    }

    11003 登录#

    {
        "guid": "xxx",
        "notify_type": 11003,
        "data": {
            "user_id": "16888",
            "name": "xxx",
            "real_name": "xxx",
            "corp_id": "1970",
            "gender": 1,
            "party_id": "16888",
            "avatar": "https://wework.qpic.cn/wwpic/272167_xhmhygOzS1WxnuS_1661671810/0",
            "corp_short_name": "xx",
            "corp_full_name": "xxx"
        }
    }

    11004 退出登录#

    {
        "guid": "xxx",
        "notify_type": 11004,
        "data": {
            "error_code": -1,
            "error_message": "用户主动注销"
        }
    }

    11010 新消息#

    {
        "guid": "xxx",
        "notify_type": 11010,
        "data": {
            "seq": "7272646",
            "id": "1067188",
            "appinfo": "CAUQu+WWsAYYzKLu+vKDwOAXIMzQh6QF",
            "sender": "16888",
            "receiver": "788",
            "roomid": "0",
            "sendtime": 1711649467,
            "sender_name": "小助手",
            "content_type": 2,
            "referid": "0",
            "flag": 16777216,
            "content": "缓存没找到",
            "at_list": [],
            "quote_content": "",
            "quote_appinfo": "",
            "send_flag": 1,
            "msg_type": 2
        }
    }

    11011 其他设备登录#

    {
        "guid": "xxx",
        "notify_type": 11011,
        "data": {}
    }

    2166 视频/语音电话#

    type
    1 视频
    2 语音
    {
        "guid": "fbaeeed9-71b4-362a-af79-1950573d4fcc",
        "notify_type": 2166,
        "data": {
            "type": 2,
            "msgid": "7382112495471995302",
            "timestamp": 1718782003,
            "inviteMsg": {
                "roomid": "1231026317",
                "roomkey": "0",
                "memlist": [
                    {
                        "xid": "7881303217905494",
                        "name": "SGFuc29u",
                        "headUrl": "aHR0cDovL3d4LnFsb2dvLmNuL21taGVhZC9TSWJ6alVPU0NoNEtuNHk3dWJidWdFbllYYk9HYXpyQkg3QmE0bmZCV2JXbFBITkhMdll3MlNkMmg2Um9hVFZZWjY3Q1AzMUlRQXMvMA==",
                        "openid": "o9cq80yRrRMiTvVrd_7KJteMtc5w@im.wechat"
                    }
                ],
                "inviteId": "7881303217905494",
                "inviteType": 0,
                "actType": 1,
                "sdkBuff": ""
            }
        }
    }
    修改于 2025-08-18 08:38:59
    上一页
    枚举类
    下一页
    常见问题 QA
    Built with