# 微信协议 API

## Docs
- [接入必读](https://doc.wekeapi.com/%E6%8E%A5%E5%85%A5%E5%BF%85%E8%AF%BB-8850138m0.md): 
- [使用流程](https://doc.wekeapi.com/%E4%BD%BF%E7%94%A8%E6%B5%81%E7%A8%8B-8850197m0.md): 
- [最佳实践](https://doc.wekeapi.com/%E6%9C%80%E4%BD%B3%E5%AE%9E%E8%B7%B5-8851174m0.md): 
- [消息回调](https://doc.wekeapi.com/%E6%B6%88%E6%81%AF%E5%9B%9E%E8%B0%83-8942455m0.md): 
- API参考 > 登录 [登录模块参考](https://doc.wekeapi.com/%E7%99%BB%E5%BD%95%E6%A8%A1%E5%9D%97%E5%8F%82%E8%80%83-8859316m0.md): 

## API Docs
- API参考 > 登录 [获取登录二维码](https://doc.wekeapi.com/%E8%8E%B7%E5%8F%96%E7%99%BB%E5%BD%95%E4%BA%8C%E7%BB%B4%E7%A0%81-463143124e0.md): - 绑定微信账号的第一步，调用此接口获取登录二维码；将获取的二维码展示给用户，由用户使用手机微信扫码登录
- API参考 > 登录 [检测扫码结果](https://doc.wekeapi.com/%E6%A3%80%E6%B5%8B%E6%89%AB%E7%A0%81%E7%BB%93%E6%9E%9C-463143121e0.md): - 获取登录二维码后，定时调用本接口检测用户扫码登录结果，推荐定时时间间隔5秒
- API参考 > 登录 [检查在线状态](https://doc.wekeapi.com/%E6%A3%80%E6%9F%A5%E5%9C%A8%E7%BA%BF%E7%8A%B6%E6%80%81-463143122e0.md): - 调用本接口可以检查账号在线状态，返回的在线状态：1-在线，-1-离线，0-未登录
- API参考 > 登录 [快捷登录](https://doc.wekeapi.com/%E5%BF%AB%E6%8D%B7%E7%99%BB%E5%BD%95-463143123e0.md): - 账号在手机端、或通过 API 主动退出登录，再次登录时可调用此接口，不用扫码，只需在手机弹出页面上点击确认登录
- API参考 > 登录 [退出登录](https://doc.wekeapi.com/%E9%80%80%E5%87%BA%E7%99%BB%E5%BD%95-463143125e0.md): 主动退出登录状态
- API参考 > 通讯录 [获取通讯录列表](https://doc.wekeapi.com/%E8%8E%B7%E5%8F%96%E9%80%9A%E8%AE%AF%E5%BD%95%E5%88%97%E8%A1%A8-463143103e0.md): - 获取微信通讯录列表，包括好友、微信群和关注的公众号，只返回ID
- API参考 > 通讯录 [获取联系人/群/公众号简要信息](https://doc.wekeapi.com/%E8%8E%B7%E5%8F%96%E8%81%94%E7%B3%BB%E4%BA%BA%E7%BE%A4%E5%85%AC%E4%BC%97%E5%8F%B7%E7%AE%80%E8%A6%81%E4%BF%A1%E6%81%AF-463143105e0.md): - 批量获取联系人/群/公众号的简要信息
- API参考 > 通讯录 [获取联系人/群/公众号详细信息](https://doc.wekeapi.com/%E8%8E%B7%E5%8F%96%E8%81%94%E7%B3%BB%E4%BA%BA%E7%BE%A4%E5%85%AC%E4%BC%97%E5%8F%B7%E8%AF%A6%E7%BB%86%E4%BF%A1%E6%81%AF-463143106e0.md): 批量获取联系人/群/公众号详细信息
- API参考 > 通讯录 [搜索联系人](https://doc.wekeapi.com/%E6%90%9C%E7%B4%A2%E8%81%94%E7%B3%BB%E4%BA%BA-463143109e0.md): 搜索微信联系人；搜索结果可在“添加好友”接口中使用；搜索的联系人如果已经是好友，响应结果中的V3则为好友的wxid
- API参考 > 通讯录 [添加好友](https://doc.wekeapi.com/%E6%B7%BB%E5%8A%A0%E5%A5%BD%E5%8F%8B-463143099e0.md): - 主动添加好友；好友添加成功后，会通过回调消息推送一条包含V3的消息，可用于判断好友是否添加成功
- API参考 > 通讯录 [同意添加好友](https://doc.wekeapi.com/%E5%90%8C%E6%84%8F%E6%B7%BB%E5%8A%A0%E5%A5%BD%E5%8F%8B-463143116e0.md): 同意好友添加申请；好友发送添加申请后，会收到一条回调消息，从回调中获取请求参数
- API参考 > 通讯录 [设置好友仅聊天](https://doc.wekeapi.com/%E8%AE%BE%E7%BD%AE%E5%A5%BD%E5%8F%8B%E4%BB%85%E8%81%8A%E5%A4%A9-463143111e0.md): 设置好友是否仅聊天
- API参考 > 通讯录 [设置好友备注](https://doc.wekeapi.com/%E8%AE%BE%E7%BD%AE%E5%A5%BD%E5%8F%8B%E5%A4%87%E6%B3%A8-463143112e0.md): 设置好友备注信息
- API参考 > 通讯录 [删除好友](https://doc.wekeapi.com/%E5%88%A0%E9%99%A4%E5%A5%BD%E5%8F%8B-463143101e0.md): 删除好友
- API参考 > 通讯录 [获取企微好友列表](https://doc.wekeapi.com/%E8%8E%B7%E5%8F%96%E4%BC%81%E5%BE%AE%E5%A5%BD%E5%8F%8B%E5%88%97%E8%A1%A8-463143104e0.md): 获取企微好友列表
- API参考 > 通讯录 [获取企微好友信息](https://doc.wekeapi.com/%E8%8E%B7%E5%8F%96%E4%BC%81%E5%BE%AE%E5%A5%BD%E5%8F%8B%E4%BF%A1%E6%81%AF-463143108e0.md): 批量获取企微好友信息
- API参考 > 通讯录 [搜索企微联系人](https://doc.wekeapi.com/%E6%90%9C%E7%B4%A2%E4%BC%81%E5%BE%AE%E8%81%94%E7%B3%BB%E4%BA%BA-463143110e0.md): 搜索企微微信联系人；搜索结果可在“添加企微联系人”接口中使用
- API参考 > 通讯录 [添加企微好友](https://doc.wekeapi.com/%E6%B7%BB%E5%8A%A0%E4%BC%81%E5%BE%AE%E5%A5%BD%E5%8F%8B-463143100e0.md): - 申请添加企微联系人为好友
- API参考 > 通讯录 [设置企微好友设置备注](https://doc.wekeapi.com/%E8%AE%BE%E7%BD%AE%E4%BC%81%E5%BE%AE%E5%A5%BD%E5%8F%8B%E8%AE%BE%E7%BD%AE%E5%A4%87%E6%B3%A8-463143113e0.md): 设置企微好友的备注信息
- API参考 > 通讯录 [删除企微好友](https://doc.wekeapi.com/%E5%88%A0%E9%99%A4%E4%BC%81%E5%BE%AE%E5%A5%BD%E5%8F%8B-463143102e0.md): 删除企微好友
- API参考 > 通讯录 [获取手机通讯录好友](https://doc.wekeapi.com/%E8%8E%B7%E5%8F%96%E6%89%8B%E6%9C%BA%E9%80%9A%E8%AE%AF%E5%BD%95%E5%A5%BD%E5%8F%8B-463143107e0.md): 获取手机通讯录里的微信好友
- API参考 > 通讯录 [上传手机通讯录](https://doc.wekeapi.com/%E4%B8%8A%E4%BC%A0%E6%89%8B%E6%9C%BA%E9%80%9A%E8%AE%AF%E5%BD%95-463143115e0.md): - 上传手机通讯录
- API参考 > 通讯录 [更新通讯录列表](https://doc.wekeapi.com/%E6%9B%B4%E6%96%B0%E9%80%9A%E8%AE%AF%E5%BD%95%E5%88%97%E8%A1%A8-463143114e0.md): - 本接口会启动微信通讯录的同步，并更新本地缓存；相当于强制更新微信通讯录到平台
- API参考 > 群聊 [创建微信群](https://doc.wekeapi.com/%E5%88%9B%E5%BB%BA%E5%BE%AE%E4%BF%A1%E7%BE%A4-463143079e0.md): 创建新的微信群
- API参考 > 群聊 [获取群成员列表](https://doc.wekeapi.com/%E8%8E%B7%E5%8F%96%E7%BE%A4%E6%88%90%E5%91%98%E5%88%97%E8%A1%A8-463143085e0.md): 获取群成员列表
- API参考 > 群聊 [获取群成员详情](https://doc.wekeapi.com/%E8%8E%B7%E5%8F%96%E7%BE%A4%E6%88%90%E5%91%98%E8%AF%A6%E6%83%85-463143084e0.md): 获取群成员详情；此接口仅支持获取群内微信成员详情；企微成员可直接调用通讯录模块的”获取企微好友信息“接口进行获取
- API参考 > 群聊 [邀请成员进群](https://doc.wekeapi.com/%E9%82%80%E8%AF%B7%E6%88%90%E5%91%98%E8%BF%9B%E7%BE%A4-463143087e0.md): 邀请微信好友加入群聊
- API参考 > 群聊 [添加成员进群](https://doc.wekeapi.com/%E6%B7%BB%E5%8A%A0%E6%88%90%E5%91%98%E8%BF%9B%E7%BE%A4-463143075e0.md): 添加微信好友加入群聊
- API参考 > 群聊 [获取群二维码](https://doc.wekeapi.com/%E8%8E%B7%E5%8F%96%E7%BE%A4%E4%BA%8C%E7%BB%B4%E7%A0%81-463143086e0.md): 获取群二维码
- API参考 > 群聊 [扫码进群](https://doc.wekeapi.com/%E6%89%AB%E7%A0%81%E8%BF%9B%E7%BE%A4-463143088e0.md): 扫二维码进群
- API参考 > 群聊 [同意进群](https://doc.wekeapi.com/%E5%90%8C%E6%84%8F%E8%BF%9B%E7%BE%A4-463143077e0.md): 同意加入群聊
- API参考 > 群聊 [同意邀请进群申请](https://doc.wekeapi.com/%E5%90%8C%E6%84%8F%E9%82%80%E8%AF%B7%E8%BF%9B%E7%BE%A4%E7%94%B3%E8%AF%B7-463143078e0.md): 开启群聊邀请确认后，群主或群管理员同意群成员邀请其他成员进群的申请。必须是群主或群管理员才能操作
- API参考 > 群聊 [添加群成员为好友](https://doc.wekeapi.com/%E6%B7%BB%E5%8A%A0%E7%BE%A4%E6%88%90%E5%91%98%E4%B8%BA%E5%A5%BD%E5%8F%8B-463143076e0.md): 添加群成员为好友
- API参考 > 群聊 [转让群主](https://doc.wekeapi.com/%E8%BD%AC%E8%AE%A9%E7%BE%A4%E4%B8%BB-463143098e0.md): 将群主管理权转让给其他群成员，只有群主有权限操作
- API参考 > 群聊 [添加管理员](https://doc.wekeapi.com/%E6%B7%BB%E5%8A%A0%E7%AE%A1%E7%90%86%E5%91%98-463143074e0.md): 添加群管理员，只有群主有权限操作
- API参考 > 群聊 [移除管理员](https://doc.wekeapi.com/%E7%A7%BB%E9%99%A4%E7%AE%A1%E7%90%86%E5%91%98-463143080e0.md): 移除群管理员，只有群主有权限操作
- API参考 > 群聊 [设置群公告](https://doc.wekeapi.com/%E8%AE%BE%E7%BD%AE%E7%BE%A4%E5%85%AC%E5%91%8A-463143096e0.md): 设置群公告
- API参考 > 群聊 [获取群公告](https://doc.wekeapi.com/%E8%8E%B7%E5%8F%96%E7%BE%A4%E5%85%AC%E5%91%8A-463143083e0.md): 获取群公告
- API参考 > 群聊 [设置群聊邀请确认](https://doc.wekeapi.com/%E8%AE%BE%E7%BD%AE%E7%BE%A4%E8%81%8A%E9%82%80%E8%AF%B7%E7%A1%AE%E8%AE%A4-463143097e0.md): 开启/关闭群聊邀请确认
- API参考 > 群聊 [修改群名称](https://doc.wekeapi.com/%E4%BF%AE%E6%94%B9%E7%BE%A4%E5%90%8D%E7%A7%B0-463143089e0.md): 修改群名称
- API参考 > 群聊 [修改群备注](https://doc.wekeapi.com/%E4%BF%AE%E6%94%B9%E7%BE%A4%E5%A4%87%E6%B3%A8-463143090e0.md): 修改群备注
- API参考 > 群聊 [修改群内昵称](https://doc.wekeapi.com/%E4%BF%AE%E6%94%B9%E7%BE%A4%E5%86%85%E6%98%B5%E7%A7%B0-463143091e0.md): 修改我在群内的昵称
- API参考 > 群聊 [群拍一拍](https://doc.wekeapi.com/%E7%BE%A4%E6%8B%8D%E4%B8%80%E6%8B%8D-463143095e0.md): 群拍一拍；请求发出后对方会在5秒后收到
- API参考 > 群聊 [移除群成员](https://doc.wekeapi.com/%E7%A7%BB%E9%99%A4%E7%BE%A4%E6%88%90%E5%91%98-463143081e0.md): 将成员移出群，必须是群主或群管理员才能操作
- API参考 > 群聊 [解散群聊](https://doc.wekeapi.com/%E8%A7%A3%E6%95%A3%E7%BE%A4%E8%81%8A-463143082e0.md): 解散群聊，只有群主有权限操作
- API参考 > 群聊 [退出群聊](https://doc.wekeapi.com/%E9%80%80%E5%87%BA%E7%BE%A4%E8%81%8A-463143092e0.md): 退出群聊
- API参考 > 群聊 [保存群到通讯录](https://doc.wekeapi.com/%E4%BF%9D%E5%AD%98%E7%BE%A4%E5%88%B0%E9%80%9A%E8%AE%AF%E5%BD%95-463143094e0.md): 保存群到通讯录
- API参考 > 群聊 [从通讯录移除群](https://doc.wekeapi.com/%E4%BB%8E%E9%80%9A%E8%AE%AF%E5%BD%95%E7%A7%BB%E9%99%A4%E7%BE%A4-463143093e0.md): 从通讯录移除群
- API参考 > 标签 [获取标签列表](https://doc.wekeapi.com/%E8%8E%B7%E5%8F%96%E6%A0%87%E7%AD%BE%E5%88%97%E8%A1%A8-463143119e0.md): 获取微信标签列表；手机上增删标签不会自动同步到平台，如果在手机上加了新标签，请主动调用此接口进行同步
- API参考 > 标签 [添加标签](https://doc.wekeapi.com/%E6%B7%BB%E5%8A%A0%E6%A0%87%E7%AD%BE-463143117e0.md): 添加微信标签
- API参考 > 标签 [删除标签](https://doc.wekeapi.com/%E5%88%A0%E9%99%A4%E6%A0%87%E7%AD%BE-463143118e0.md): 删除微信标签
- API参考 > 标签 [修改好友标签](https://doc.wekeapi.com/%E4%BF%AE%E6%94%B9%E5%A5%BD%E5%8F%8B%E6%A0%87%E7%AD%BE-463143120e0.md): 修改好友的微信标签；修改时，请将所有微信标签放在请求里一起提交
- API参考 > 消息 [发送文本](https://doc.wekeapi.com/%E5%8F%91%E9%80%81%E6%96%87%E6%9C%AC-463143149e0.md): 给好友或群聊发送文本消息
- API参考 > 消息 [发送语音](https://doc.wekeapi.com/%E5%8F%91%E9%80%81%E8%AF%AD%E9%9F%B3-463143151e0.md): 发送语音消息
- API参考 > 消息 [发送图片](https://doc.wekeapi.com/%E5%8F%91%E9%80%81%E5%9B%BE%E7%89%87-463143145e0.md): - 发送图片消息，支持传入图片数据和图片URL两种方式
- API参考 > 消息 [转发图片](https://doc.wekeapi.com/%E8%BD%AC%E5%8F%91%E5%9B%BE%E7%89%87-463143134e0.md): 使用发送图片后的响应转发图片
- API参考 > 消息 [转发图片消息](https://doc.wekeapi.com/%E8%BD%AC%E5%8F%91%E5%9B%BE%E7%89%87%E6%B6%88%E6%81%AF-463143135e0.md): 使用接收图片消息中的xml转发图片消息
- API参考 > 消息 [发送视频](https://doc.wekeapi.com/%E5%8F%91%E9%80%81%E8%A7%86%E9%A2%91-463143150e0.md): - 发送视频消息，支持传入视频数据和视频URL两种方式
- API参考 > 消息 [转发视频](https://doc.wekeapi.com/%E8%BD%AC%E5%8F%91%E8%A7%86%E9%A2%91-463143139e0.md): 使用发送视频后的响应转发视频
- API参考 > 消息 [转发视频消息](https://doc.wekeapi.com/%E8%BD%AC%E5%8F%91%E8%A7%86%E9%A2%91%E6%B6%88%E6%81%AF-463143140e0.md): 使用接收视频消息中的xml转发视频消息
- API参考 > 消息 [发送文件](https://doc.wekeapi.com/%E5%8F%91%E9%80%81%E6%96%87%E4%BB%B6-463143144e0.md): - 发送视频消息，支持传入文件数据和文件URL两种方式
- API参考 > 消息 [转发文件](https://doc.wekeapi.com/%E8%BD%AC%E5%8F%91%E6%96%87%E4%BB%B6-463143132e0.md): 使用发送文件后的响应转发文件消息
- API参考 > 消息 [转发文件消息](https://doc.wekeapi.com/%E8%BD%AC%E5%8F%91%E6%96%87%E4%BB%B6%E6%B6%88%E6%81%AF-463143133e0.md): 使用接收文件消息中的xml转发文件消息
- API参考 > 消息 [发送链接](https://doc.wekeapi.com/%E5%8F%91%E9%80%81%E9%93%BE%E6%8E%A5-466037239e0.md): - 提供链接的标题、描述、链接地址和缩略图，发送链接消息
- API参考 > 消息 [转发链接](https://doc.wekeapi.com/%E8%BD%AC%E5%8F%91%E9%93%BE%E6%8E%A5-463143136e0.md): 使用发送链接后的响应转发链接消息
- API参考 > 消息 [转发链接消息](https://doc.wekeapi.com/%E8%BD%AC%E5%8F%91%E9%93%BE%E6%8E%A5%E6%B6%88%E6%81%AF-463143137e0.md): 使用接收链接消息中的xml转发链接消息
- API参考 > 消息 [发送小程序消息](https://doc.wekeapi.com/%E5%8F%91%E9%80%81%E5%B0%8F%E7%A8%8B%E5%BA%8F%E6%B6%88%E6%81%AF-463143147e0.md): 发送小程序消息；先将该小程序消息发送给自己，然后使用接收消息中的xml信息发送该小程序
- API参考 > 消息 [转发小程序消息](https://doc.wekeapi.com/%E8%BD%AC%E5%8F%91%E5%B0%8F%E7%A8%8B%E5%BA%8F%E6%B6%88%E6%81%AF-463143138e0.md): 使用接收到的小程序消息中的xml信息转发该小程序
- API参考 > 消息 [发送Emoji](https://doc.wekeapi.com/%E5%8F%91%E9%80%81emoji-463143143e0.md): 发送Emoji消息
- API参考 > 消息 [发送名片](https://doc.wekeapi.com/%E5%8F%91%E9%80%81%E5%90%8D%E7%89%87-463143148e0.md): 发送名片消息
- API参考 > 消息 [发送AppMsg消息](https://doc.wekeapi.com/%E5%8F%91%E9%80%81appmsg%E6%B6%88%E6%81%AF-463143142e0.md): - 可用于发送所有包含节点的消息，如视频号、聊天记录、音乐分享等；使用消息中xml进行发送
- API参考 > 消息 [撤回消息](https://doc.wekeapi.com/%E6%92%A4%E5%9B%9E%E6%B6%88%E6%81%AF-463143141e0.md): 撤回已发送的消息
- API参考 > 消息 [下载语音](https://doc.wekeapi.com/%E4%B8%8B%E8%BD%BD%E8%AF%AD%E9%9F%B3-463143131e0.md): - 使用接收语音消息中的xml下载语音文件
- API参考 > 消息 [下载图片](https://doc.wekeapi.com/%E4%B8%8B%E8%BD%BD%E5%9B%BE%E7%89%87-463143129e0.md): - 使用接收图片消息中的xml下载原图、常规图或缩略图
- API参考 > 消息 [下载视频](https://doc.wekeapi.com/%E4%B8%8B%E8%BD%BD%E8%A7%86%E9%A2%91-463143130e0.md): - 使用接收视频消息中的xml下载原视频、常规视频或缩略图
- API参考 > 消息 [下载文件](https://doc.wekeapi.com/%E4%B8%8B%E8%BD%BD%E6%96%87%E4%BB%B6-463143128e0.md): 使用接收文件消息中的xml下载文件（xml中type=6的消息，文件发送完成）
- API参考 > 消息 [下载Emoji](https://doc.wekeapi.com/%E4%B8%8B%E8%BD%BDemoji-463143127e0.md): 使用接收Emoji（表情动画）消息中的xml下载Emoji
- API参考 > 消息 [CDN下载](https://doc.wekeapi.com/cdn%E4%B8%8B%E8%BD%BD-463143126e0.md): - 如果没有回调消息的xml，但是有CDN返回的FileId、AesKey和文件大小，可以使用本接口下载
- API参考 > 代理 [获取设备代理信息](https://doc.wekeapi.com/%E8%8E%B7%E5%8F%96%E8%AE%BE%E5%A4%87%E4%BB%A3%E7%90%86%E4%BF%A1%E6%81%AF-463143152e0.md): 获取某个设备当前代理信息
- API参考 > 代理 [设置设备代理信息](https://doc.wekeapi.com/%E8%AE%BE%E7%BD%AE%E8%AE%BE%E5%A4%87%E4%BB%A3%E7%90%86%E4%BF%A1%E6%81%AF-463143153e0.md): - 设置某个设备的代理；代理与之前不同，相当于修改代理
- API参考 > 代理 [检查城市是否有代理](https://doc.wekeapi.com/%E6%A3%80%E6%9F%A5%E5%9F%8E%E5%B8%82%E6%98%AF%E5%90%A6%E6%9C%89%E4%BB%A3%E7%90%86-464625255e0.md): 检查某个城市当前是否有可用代理