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

    接入必读

    wekeapi 提供微信协议 API 接口能力,开发者可以通过 API 调用,完成常见微信操作,如消息收发、好友管理、群管理、标签管理等。
    您可以基于 wekeapi 提供的基础能力,开发自己的业务系统,如私域营销、社群运营、智能客服等,也可以结合 AI Agent、OpenClaw 类工具开发 AI数字员工等 AI应用。

    使用要求#

    1.
    为了您的账号安全、降低使用风险,接入本平台的账号必须是经过实名认证、且近期无违规及使用异常的账号。
    2.
    请在遵守微信平台运营规范及相关法律法规的基础上使用本平台。

    微信使用的一些概念#

    微信号
    原始微信号(wxid):注册微信时,如果设置了个性化微信号,原始微信号就是个性化微信号;如果未设置,会自动生成一个格式为 wx_xxxx 的原始微信号
    别名(alias):在注册微信后,如果手动修改过微信号,新修改的微信号会作为别名属性
    微信中显示的微信号:如果有别名,显示的是别名;没有别名,显示的是原始微信号
    好友微信名
    通讯录好友会有微信名(nickname)和备注(remark)两个属性;微信名是好友自己的微信昵称,备注是你在微信里给好友设置的备注
    你的微信里显示的好友备注名,如果你手动设置过备注,显示的就是这个备注;如果没设置过,显示的则是好友的微信名
    群成员微信昵称
    在微信群里,如果群成员是你的好友,你看到的是好友微信名;如果群成员不是你的好友,看到的会是他的群昵称
    群成员的群昵称,如果他设置了“我在群里的昵称”,显示的就是这个昵称;如果没有设置,显示的是他的微信名

    响应格式#

    API 接口统一返回JSON格式响应:
    {
        code: 0,
        message: "响应信息",
        data: {}
    }
    接口调用成功,code 值为 0;code 不为 0 时,从 message 取具体错误信息。

    错误信息#

    常见错误排查#

    CodeMessage说明
    -10认证失败检查 AccessToken 是否正确,AppId 是否属于该 AccessToken
    -11参数错误接口传参未通过校验,检查参数是否符合要求
    -12调用超限接口调用频次过高,超过系统限制(目前仅对发送类接口做限制)
    -21账号已登录调用登录相关接口时,账号已登录
    -22账号未登录调用要求账号登录的接口时,账号未登录
    -33无对应资源接收消息后下载图片或视频时,无对应规格的资源(对方可能没有发原图,或视频没有压缩常规视频等情况)
    -43通讯录同步进行中获取通讯录列表或强制更新通讯录时,后台正在进行通讯录同步
    -51网络连接异常调用接口或更换代理时网络不通,检查代理的连通性

    完整错误列表#

    CodeMessage
    -10认证失败
    -11参数错误
    -12调用超限
    -13Base64参数解码错误
    -14xml参数解析错误
    -15xml参数数据不完整
    -16代理格式错误
    -20账号限额已用完
    -21账号已登录
    -22账号未登录
    -23账号未在线
    -24登录失败
    -30不支持的格式
    -31大小超过限制
    -32时长超过限制
    -33无对应资源
    -40操作过于频繁
    -41二维码已过期
    -42群聊邀请已过期
    -43通讯录同步进行中
    -50服务异常
    -51网络连接异常
    -52后端接口返回错误

    调用频率#

    1.
    当前,为保障您的使用安全,平台仅对发送类接口的调用时间间隔做了限制;两次发送间隔需在1秒以上,间隔小于1秒的请求会调用失败。
    2.
    其他接口也请保持正常调用频率;平台会对调用频率进行监控,必要时会对调用频率不合理的账号采取封禁措施。

    私有化部署#

    本服务支持私有化部署,如有需要请联系客服进行对接。

    联系方式#

    📌
    +v weke_820528
    修改于 2026-06-03 02:23:55
    下一页
    使用流程
    Built with