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

    必读文档（问问题前先看完这里）

    💯 理论上任何功能都能实现，只要你需要，市面上最全的企微底层接口，很多SCRM或技术服务商都是基于此接口二次开发封装产品。此版本非完整版，私有化部署才有完整版。

    联系#

    +v hansonskr
    登录前3天，不要做群发、发朋友圈、主加好友。
    提示风控、环境异常等原因导致退出登录，都是属于正常现象，登录久了设备就会转成常用设备，就不会退出登录。

    原理#

    扫码（托管）登录系统，登录后便能以登录者身份调用接口收发消息。

    调用方式#

    此文档所有接口调用需根据 https://juhexbot.feishu.cn/docx/Vh6Qd2HwGoAdoaxvaovcmJGWnnh 操作。

    登录流程#

    参考文档：https://juhexbot.feishu.cn/docx/Os5IdN0tvonNYSxVKlmc8gTTnZb
    登录完设置实例通知地址

    调用频率#

    当一分钟内调用次数超过100次，将限制调用接口，半小时后解封。
    为了你的账号安全，请合理调用接口。

    概念说明#

    实例#

    创建实例相当于创建了一个虚拟机器，一个实例只登录一个号，如需登录其他账号请重新创建实例，不用的实例可以删除。

    登录#

    原则上扫码确认后即可登录，无需调用 manual_login 和 keep_login

    云存储#

    云存储可以把文件直接上传到阿里云或腾讯云，开发者无需二次开发这部分

    ID 说明#

    微信的外部联系人开头为 788
    企微用户的开头为 168（无论是自己企业还是他人企业）
    外部群一般为 10 开头
    这里的ID不会因为不同用户、不同企业改变而改变，都是固定值
    发送消息的 conversation_id 为
    私聊 S:788xxxxx
    群聊 R:10xxxxxxxx
    群ID开头要有 R:
    联系人ID开头要有 S:
    否则会报错
    conversation_id 可以通过同步联系人、获取客户群列表或者消息回调里面获取。

    开放平台#

    📌
    此不支持打通开放平台，需要够买私有化版本才提供
    开放平台部分的文档可以跟自建应用的外部联系人ID打通

    file id#

    file id 为资源参数，可以通过调用上传接口获取。或者通过消息回调获取。

    seq#

    seq为序号，首次不传，下一页传返回值里返回的seq

    file_type#

    图片：1 （回调 is_hd=true）
    图片：2
    小程序封面：3
    视频：4
    文件、语音：5

    消息#

    referid#

    referid 为0 证明是原消息，不为0 时 referID 等于消息 ID，证明消息有过变动（例如该消息为某条消息的 已读、撤回 等附属消息）。

    CDN#

    下载#

    file_id（某些场景字段名可能为URL）#

    https://wework.qpic.cn 开头的可以直接访问
    30 开头的需要使用 C2C 接口下载
    其他 https:// 的使用微信CDN下载
    *开头的需要用 big CDN下载

    上传#

    消息使用 C2C 上传
    朋友圈资源使用 BIG CDN
    修改于 2025-08-06 03:49:31
    下一页
    枚举类
    Built with