企微协议 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
    个微接口
    个微接口

    常见问题 QA

    常见问题#

    Q: 会话ID/conversation_id 是什么?如何获取
    A: 会话ID由 S:或R: + 用户ID或群聊ID 组成,例如 S:788xxxxx S:1688xxxxx R:10xxxxx。私聊前缀为 S: 群聊前缀为 R:。用户 ID 可以通过同步联系人、获取客户群列表(自己是群主)或者接收消息里面获取。
    Q: 如何发送图片、视频、文件等资源?又如何下载?
    A: 部署私有化云存储,调用 C2C文件上传 会有对应的发送参数,下载就调用 C2C文件下载 传参对应的回调参数便能下载到CDN。
    Q: 不同 file_id 格式的下载接口?
    https://wework.qpic.cn 开头的可以直接访问
    30 开头的用 C2C文件下载
    其他 https:// 的使用 微信文件下载
    *开头的需要用 大文件下载
    Q: file_type 区别?
    图片:1 (回调 is_hd=true)
    图片:2 (默认均用2)
    小程序封面:3
    视频:4
    文件、语音:5
    Q: 如何发送小程序?参数怎么传?点开小程序是空白的或点开出错?
    A: 接口地址,参数可以自己接收一个小程序消息,从消息回调里面拿,封面图可以自行上传替换,所有参数都不能漏。
    Q: 发送的图片或文件空白、或点开无法查看?
    A: 上传参数有问题,URL需要确保能访问,图片上传的file type 为 2,文件、语音为 5.
    Q: 参数的 seq 是什么?如何传参?
    A: 序号,首次传0或传空,下一页传返回值的seq,seq要保存起来。
    Q: 回调没有变动详情?
    A: 根据回调事件调用增量同步群信息 / 同步联系人去获取变动内容。
    Q: 如何获取自己非群主的群列表?
    A: 需要根据消息回调中的roomid,去调用批量获取群详细信息自行存起来。
    Q: 消息里的appinfo是什么?
    A: 消息的全局唯一ID,撤回消息可以通过这个找出撤回的消息。
    Q: 关于消息回调的 id, seq, appinfo 分别是什么?
    A: id是用户维度下的唯一id。seq 是消息的序号,也是用户下唯一。appinfo 是全局的唯一 id,引用消息会用到。
    Q: 同一条消息有多条回调?
    A: 多条回调是含义不一样的,例如消息已读,撤回等等,可以只处理 refer_id 为 0 的消息。
    Q: 消息回调里的 asid 是什么?
    A: asid 是微信客服的消息ID,可以通过 S:788;asid 的方式,发送微信客服消息给用户。
    Q: 语音如何下载播放?
    A: C2C文件下载,file type = 5,文件为silk格式,可以通过silk-v3-decoder转成mp3。
    Q: 接口提示“cloud 相关接口已关闭,请使用私有化CDN版本”?
    A: 调接口地址错误,这类接口是调用自己的私有化服务的IP。
    Q: 调用私有化CDN接口报错,提示“not enough values to unpack (expected 2, got 1)”?
    A: CDN 配置有问题,请检查配置,阿里云配置需要加上协议头。
    修改于 2025-12-23 06:50:58
    上一页
    回调
    下一页
    升级实例
    Built with