Files
wechatWeb/_docs/API接口清单-按模块.md
张成 c3aab075d9 1
2026-03-27 14:09:49 +08:00

299 lines
17 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# API 接口清单(按模块)
> 接口总数:**193**
## 套餐统计
| 套餐 | 接口数 |
|---|---:|
| 初级版 | 68 |
| 高级版 | 79 |
| 定制版 | 37 |
| 白标/OEM | 9 |
---
## 1. 登录9 个接口)
| # | 方法 | 接口路径 | 说明 | 套餐 |
|---:|---|---|---|---|
| 1 | `POST` | `/login/A16Login` | 数据登录 | 定制版 |
| 2 | `GET` | `/login/CheckLoginStatus` | 检测扫码状态 | 初级版 |
| 3 | `POST` | `/login/DeviceLogin` | 62账号密码登录 | 定制版 |
| 4 | `POST` | `/login/GetLoginQrCodeNewDirect` | 获取登录二维码-直登(异地IP必须用代理! socks5://username:password@ipv4:port) | 初级版 |
| 5 | `GET` | `/login/GetLoginStatus` | 获取在线状态 | 初级版 |
| 6 | `GET` | `/login/LogOut` | 退出登录 | 初级版 |
| 7 | `POST` | `/login/VerifyCode` | 验证码验证(输入iPad登录验证码) | 定制版 |
| 8 | `POST` | `/login/VerifyCodeSlide` | 过mac滑块验证 | 定制版 |
| 9 | `POST` | `/login/WakeUpLogin` | 唤醒登录(只限扫码登录) | 初级版 |
## 2. 用户26 个接口)
| # | 方法 | 接口路径 | 说明 | 套餐 |
|---:|---|---|---|---|
| 1 | `POST` | `/user/ChangePwd` | 更改密码 | 高级版 |
| 2 | `GET` | `/user/GetAdminKeyword` | 获取管理员关键词配置 | 初级版 |
| 3 | `GET` | `/user/GetInviteKeyword` | 获取关键词邀请入群配置 | 初级版 |
| 4 | `GET` | `/user/GetKeywordReply` | 获取关键词自动回复配置 | 初级版 |
| 5 | `GET` | `/user/GetKickKeyword` | 获取踢人关键词配置 | 初级版 |
| 6 | `POST` | `/user/GetMyQrCode` | 获取我的二维码 | 初级版 |
| 7 | `GET` | `/user/GetProfile` | 获取个人资料信息 | 初级版 |
| 8 | `GET` | `/user/GetWelcome` | 获取欢迎词配置 | 初级版 |
| 9 | `POST` | `/user/ModifyRemark` | 修改备注 | 初级版 |
| 10 | `POST` | `/user/ModifyUserInfo` | 修改资料 | 定制版 |
| 11 | `POST` | `/user/ResetGender` | 重置性别 | 定制版 |
| 12 | `POST` | `/user/SetAdminKeyword` | 设置管理员关键词配置 | 初级版 |
| 13 | `POST` | `/user/SetFunctionSwitch` | 设置添加我的方式 | 高级版 |
| 14 | `POST` | `/user/SetInviteKeyword` | 设置关键词邀请入群配置 | 初级版 |
| 15 | `POST` | `/user/SetKeywordReply` | 设置关键词自动回复 | 初级版 |
| 16 | `POST` | `/user/SetKickKeyword` | 设置踢人关键词配置 | 初级版 |
| 17 | `POST` | `/user/SetNickName` | 设置昵称 | 初级版 |
| 18 | `POST` | `/user/SetProxy` | 修改Socks5代理 socks5://username:password@ipv4: | 定制版 |
| 19 | `POST` | `/user/SetSendPat` | 设置拍一拍名称 | 定制版 |
| 20 | `POST` | `/user/SetSexDq` | 修改性别 | 定制版 |
| 21 | `POST` | `/user/SetSignature` | 修改签名 | 初级版 |
| 22 | `POST` | `/user/SetWechat` | 设置微信号 | 定制版 |
| 23 | `POST` | `/user/SetWelcome` | 设置欢迎词配置 | 初级版 |
| 24 | `POST` | `/user/UpdateAutoPass` | 修改加好友需要验证属性 | 定制版 |
| 25 | `POST` | `/user/UpdateNickName` | 修改名称 | 初级版 |
| 26 | `POST` | `/user/UploadHeadImage` | 上传头像 | 初级版 |
## 3. 标签5 个接口)
| # | 方法 | 接口路径 | 说明 | 套餐 |
|---:|---|---|---|---|
| 1 | `POST` | `/label/AddContactLabel` | 添加列表 | 初级版 |
| 2 | `POST` | `/label/DelContactLabel` | 删除标签 | 初级版 |
| 3 | `GET` | `/label/GetContactLabelList` | 获取标签列表 | 初级版 |
| 4 | `POST` | `/label/GetWXFriendListByLabel` | 获取标签下所有好友 | 初级版 |
| 5 | `POST` | `/label/ModifyLabel` | 修改标签 | 初级版 |
## 4. 消息24 个接口)
| # | 方法 | 接口路径 | 说明 | 套餐 |
|---:|---|---|---|---|
| 1 | `POST` | `/message/AddMessageMgr` | 添加要发送的文本消息进入管理器 | 高级版 |
| 2 | `POST` | `/message/CdnUploadVideo` | 上传视频 | 高级版 |
| 3 | `POST` | `/message/DownloadEmojiGif` | 下载表情 | 高级版 |
| 4 | `POST` | `/message/ForwardEmoji` | 转发表情,包含动图 | 初级版 |
| 5 | `POST` | `/message/ForwardImageMessage` | 转发图片 | 初级版 |
| 6 | `POST` | `/message/ForwardVideoMessage` | 转发视频 | 初级版 |
| 7 | `POST` | `/message/GetMsgBigImg` | 获取图片(高清图片下载) | 高级版 |
| 8 | `POST` | `/message/GetMsgVideo` | 获取视频(视频数据下载) | 高级版 |
| 9 | `POST` | `/message/GetMsgVoice` | 下载语音消息 | 高级版 |
| 10 | `POST` | `/message/GroupMassMsgImage` | 群发图片 | 高级版 |
| 11 | `POST` | `/message/GroupMassMsgText` | 群发接口 | 高级版 |
| 12 | `POST` | `/message/HttpSyncMsg` | 同步消息, HTTP-轮询方式 | 初级版 |
| 13 | `POST` | `/message/NewSyncHistoryMessage` | 同步历史消息 | 高级版 |
| 14 | `POST` | `/message/RevokeMsg` | 撤销消息 | 初级版 |
| 15 | `POST` | `/message/RevokeMsgNew` | 撤回消息New | 初级版 |
| 16 | `POST` | `/message/SendAppMessage` | 发送App消息 | 高级版 |
| 17 | `POST` | `/message/SendCdnDownload` | 下载 请求 | 高级版 |
| 18 | `POST` | `/message/SendEmojiMessage` | 发送表情 | 高级版 |
| 19 | `POST` | `/message/SendImageMessage` | 发送图片消息 | 初级版 |
| 20 | `POST` | `/message/SendImageNewMessage` | 发送图片消息New | 高级版 |
| 21 | `POST` | `/message/SendTextMessage` | 发送文本消息 | 初级版 |
| 22 | `POST` | `/message/SendVoice` | 发送语音 | 初级版 |
| 23 | `POST` | `/message/ShareCardMessage` | 分享名片消息 | 高级版 |
| 24 | `POST` | `/message/UploadImageToCDN` | 纯CDN图片上传接口 | 高级版 |
## 5. 消息回调4 个接口)
| # | 方法 | 接口路径 | 说明 | 套餐 |
|---:|---|---|---|---|
| 1 | `GET` | `/message/DeleteCallback` | 删除消息回调配置 | 高级版 |
| 2 | `GET` | `/message/GetCallback` | 获取消息回调配置 | 高级版 |
| 3 | `POST` | `/message/SetCallback` | 设置消息回调 | 高级版 |
| 4 | `GET` | `/message/TestCallback` | 测试消息回调配置 | 高级版 |
## 6. 群管理20 个接口)
| # | 方法 | 接口路径 | 说明 | 套餐 |
|---:|---|---|---|---|
| 1 | `POST` | `/group/AddChatRoomMembers` | 添加群成员 | 初级版 |
| 2 | `POST` | `/group/AddChatroomAdmin` | 添加群管理员 | 高级版 |
| 3 | `POST` | `/group/CreateChatRoom` | 创建群请求 | 初级版 |
| 4 | `POST` | `/group/DelChatroomAdmin` | 删除群管理员 | 高级版 |
| 5 | `POST` | `/group/GetChatRoomInfo` | 获取群详情 | 初级版 |
| 6 | `POST` | `/group/GetChatroomMemberDetail` | 获取群成员详细 | 初级版 |
| 7 | `POST` | `/group/GetChatroomQrCode` | 获取群二维码 | 初级版 |
| 8 | `POST` | `/group/InviteChatroomMembers` | 邀请群成员 | 初级版 |
| 9 | `POST` | `/group/MoveToContract` | 获取群聊 | 高级版 |
| 10 | `POST` | `/group/QuitChatroom` | 退出群聊 | 初级版 |
| 11 | `POST` | `/group/ScanIntoUrlGroup` | 扫码入群 | 高级版 |
| 12 | `POST` | `/group/SendDelDelChatRoomMember` | 删除群成员 | 高级版 |
| 13 | `POST` | `/group/SendPat` | 群拍一拍功能 | 高级版 |
| 14 | `POST` | `/group/SendTransferGroupOwner` | 转让群 | 高级版 |
| 15 | `POST` | `/group/SetChatroomAccessVerify` | 设置群聊邀请开关 | 高级版 |
| 16 | `POST` | `/group/SetChatroomAnnouncement` | 设置群公告 | 初级版 |
| 17 | `POST` | `/group/SetChatroomName` | 设置群昵称 | 初级版 |
| 18 | `POST` | `/group/SetGetChatRoomInfoDetail` | 获取群公告 | 高级版 |
| 19 | `POST` | `/group/SetGroupNickname` | 设置我在本群的昵称 | 初级版 |
| 20 | `POST` | `/group/ToJoinGroup` | 同意入群 | 初级版 |
## 7. 朋友圈16 个接口)
| # | 方法 | 接口路径 | 说明 | 套餐 |
|---:|---|---|---|---|
| 1 | `POST` | `/sns/CdnSnsVideoUpload` | 上传CDN朋友圈视频 | 高级版 |
| 2 | `POST` | `/sns/DownloadMedia` | 下载朋友圈视频 | 高级版 |
| 3 | `POST` | `/sns/GetCollectCircle` | 获取收藏朋友圈详情 | 高级版 |
| 4 | `POST` | `/sns/GetSnsSync` | 同步朋友圈 | 初级版 |
| 5 | `POST` | `/sns/SendFavItemCircle` | 转发收藏朋友圈 | 高级版 |
| 6 | `POST` | `/sns/SendFriendCircle` | 发送朋友圈 | 初级版 |
| 7 | `POST` | `/sns/SendFriendCircleByXMl` | 发送朋友圈XML结构 | 初级版 |
| 8 | `POST` | `/sns/SendOneIdCircle` | 一键转发朋友圈 | 高级版 |
| 9 | `POST` | `/sns/SendSnsComment` | 点赞评论 | 初级版 |
| 10 | `POST` | `/sns/SendSnsObjectDetailById` | 获取指定id朋友圈 | 初级版 |
| 11 | `POST` | `/sns/SendSnsObjectOp` | 朋友圈操作 | 高级版 |
| 12 | `POST` | `/sns/SendSnsTimeLine` | 获取朋友圈主页 | 初级版 |
| 13 | `POST` | `/sns/SendSnsUserPage` | 获取指定人朋友圈 | 初级版 |
| 14 | `POST` | `/sns/SetBackgroundImage` | 设置朋友圈背景图片 | 初级版 |
| 15 | `POST` | `/sns/SetFriendCircleDays` | 设置朋友圈可见天数 | 初级版 |
| 16 | `POST` | `/sns/UploadFriendCircleImage` | 上传图片信息 | 初级版 |
## 8. 收藏4 个接口)
| # | 方法 | 接口路径 | 说明 | 套餐 |
|---:|---|---|---|---|
| 1 | `POST` | `/favor/BatchDelFavItem` | 删除收藏 | 高级版 |
| 2 | `GET` | `/favor/FavSync` | 同步收藏 | 高级版 |
| 3 | `POST` | `/favor/GetFavItemId` | 获取收藏详细 | 高级版 |
| 4 | `POST` | `/favor/GetFavList` | 获取收藏list | 高级版 |
## 9. 支付9 个接口)
| # | 方法 | 接口路径 | 说明 | 套餐 |
|---:|---|---|---|---|
| 1 | `POST` | `/pay/Collectmoney` | 确定收款 | 高级版 |
| 2 | `POST` | `/pay/ConfirmPreTransfer` | 确认转账(客户端版本过低会无法转账) | 高级版 |
| 3 | `POST` | `/pay/CreatePreTransfer` | 创建转账 | 高级版 |
| 4 | `POST` | `/pay/GeneratePayQCode` | 生成自定义收款二维码 | 高级版 |
| 5 | `POST` | `/pay/GetBandCardList` | 获取银行卡信息 | 高级版 |
| 6 | `POST` | `/pay/GetRedEnvelopesDetail` | 查看红包详情 | 高级版 |
| 7 | `POST` | `/pay/GetRedPacketList` | 查看红包领取列表 | 高级版 |
| 8 | `POST` | `/pay/OpenRedEnvelopes` | 拆红包 | 高级版 |
| 9 | `POST` | `/pay/WXCreateRedPacket` | 创建红包 | 高级版 |
## 10. 公众号/小程序13 个接口)
| # | 方法 | 接口路径 | 说明 | 套餐 |
|---:|---|---|---|---|
| 1 | `POST` | `/applet/AuthMpLogin` | 授权公众号登录 | 高级版 |
| 2 | `POST` | `/applet/FollowGH` | 关注公众号 | 高级版 |
| 3 | `POST` | `/applet/GetA8Key` | 授权链接 | 高级版 |
| 4 | `POST` | `/applet/GetAppMsgExt` | 阅读公众号文章 | 高级版 |
| 5 | `POST` | `/applet/GetAppMsgExtLike` | 点赞公众号文章 | 高级版 |
| 6 | `POST` | `/applet/GetAppMsgReadCount` | 获取公众号文章阅读数 | 高级版 |
| 7 | `POST` | `/applet/GetMpA8Key` | 授权链接 | 高级版 |
| 8 | `POST` | `/applet/GetMpHistoryMessage` | 获取公众号历史消息 | 高级版 |
| 9 | `POST` | `/applet/JSOperateWxData` | 小程序云函数操作 | 高级版 |
| 10 | `POST` | `/applet/JsLogin` | 授权小程序(返回授权后的code) | 高级版 |
| 11 | `POST` | `/applet/QRConnectAuthorize` | 二维码授权请求 | 高级版 |
| 12 | `POST` | `/applet/QRConnectAuthorizeConfirm` | 二维码授权确认 | 高级版 |
| 13 | `POST` | `/applet/SdkOauthAuthorize` | 应用授权 | 高级版 |
## 11. 企业微信22 个接口)
| # | 方法 | 接口路径 | 说明 | 套餐 |
|---:|---|---|---|---|
| 1 | `POST` | `/qy/QWAcceptChatRoom` | 同意进企业群 | 定制版 |
| 2 | `POST` | `/qy/QWAddChatRoomMember` | 直接拉朋友进企业群 | 定制版 |
| 3 | `POST` | `/qy/QWAdminAcceptJoinChatRoomSet` | 设定企业群管理审核进群 | 定制版 |
| 4 | `POST` | `/qy/QWApplyAddContact` | 向企业微信打招呼 | 定制版 |
| 5 | `POST` | `/qy/QWAppointChatRoomAdmin` | 增加企业管理员 | 定制版 |
| 6 | `POST` | `/qy/QWChatRoomAnnounce` | 发布企业群公告 | 定制版 |
| 7 | `POST` | `/qy/QWChatRoomTransferOwner` | 转让企业群 | 定制版 |
| 8 | `POST` | `/qy/QWContact` | 提取企业 wx 详情 | 定制版 |
| 9 | `POST` | `/qy/QWCreateChatRoom` | 创建企业群 | 定制版 |
| 10 | `POST` | `/qy/QWDelChatRoom` | 删除企业群 | 定制版 |
| 11 | `POST` | `/qy/QWDelChatRoomAdmin` | 移除群管理员 | 定制版 |
| 12 | `POST` | `/qy/QWDelChatRoomMember` | 删除企业群成员 | 定制版 |
| 13 | `POST` | `/qy/QWGetChatRoomMember` | 提取企业群全部成员 | 定制版 |
| 14 | `POST` | `/qy/QWGetChatRoomQR` | 提取企业群二维码 | 定制版 |
| 15 | `POST` | `/qy/QWGetChatroomInfo` | 提取企业群名称公告设定等信息 | 定制版 |
| 16 | `POST` | `/qy/QWInviteChatRoomMember` | 发送群邀请链接 | 定制版 |
| 17 | `POST` | `/qy/QWModChatRoomMemberNick` | 修改成员在群中呢称 | 定制版 |
| 18 | `POST` | `/qy/QWModChatRoomName` | 修改企业群名称 | 定制版 |
| 19 | `POST` | `/qy/QWRemark` | 备注企业 wxid | 定制版 |
| 20 | `POST` | `/qy/QWSearchContact` | 搜手机或企业对外名片链接提取验证 | 定制版 |
| 21 | `POST` | `/qy/QWSyncChatRoom` | 提取全部企业微信群- | 定制版 |
| 22 | `POST` | `/qy/QWSyncContact` | 提取全部的企业通讯录 | 定制版 |
## 12. 视频号4 个接口)
| # | 方法 | 接口路径 | 说明 | 套餐 |
|---:|---|---|---|---|
| 1 | `POST` | `/finder/ChannelsLogin` | 视频号助手扫码登录 | 高级版 |
| 2 | `POST` | `/finder/FinderFollow` | 关注取消 | 高级版 |
| 3 | `POST` | `/finder/FinderSearch` | 视频号搜索 | 高级版 |
| 4 | `POST` | `/finder/FinderUserPrepare` | 视频号中心 | 高级版 |
## 13. 设备4 个接口)
| # | 方法 | 接口路径 | 说明 | 套餐 |
|---:|---|---|---|---|
| 1 | `POST` | `/equipment/DelSafeDevice` | 删除安全设备 | 初级版 |
| 2 | `GET` | `/equipment/GetBoundHardDevice` | 获取硬件设备情况 | 初级版 |
| 3 | `GET` | `/equipment/GetOnlineInfo` | 获取在线设备信息 | 初级版 |
| 4 | `POST` | `/equipment/GetSafetyInfo` | 获取安全设备列表 | 初级版 |
## 14. 微信小店4 个接口)
| # | 方法 | 接口路径 | 说明 | 套餐 |
|---:|---|---|---|---|
| 1 | `POST` | `/shop/ExtDeviceLoginConfirmGet` | | 定制版 |
| 2 | `POST` | `/shop/ExtDeviceLoginConfirmOk` | | 定制版 |
| 3 | `POST` | `/shop/ScanQrcodeEventReport` | | 定制版 |
| 4 | `POST` | `/shop/ShopLoginConfirm` | 微信小店确认登录 | 定制版 |
## 15. 其他8 个接口)
| # | 方法 | 接口路径 | 说明 | 套餐 |
|---:|---|---|---|---|
| 1 | `POST` | `/other/GetPeopleNearby` | 查看附近的人 | 高级版 |
| 2 | `GET` | `/other/GetProjectFullPath` | 获取项目完整路径 | 高级版 |
| 3 | `POST` | `/other/GetRedisSyncMsg` | 获取缓存在redis中的消息 | 高级版 |
| 4 | `POST` | `/other/GetUserRankLikeCount` | 获取步数排行数据列表 | 高级版 |
| 5 | `POST` | `/other/QWImageDownload` | 企微图片下载 | 高级版 |
| 6 | `POST` | `/other/UpdateCmdStatus` | 更新指令状态, key 为指令 idValue 为指令状态 0|1ValueStr 为字符串值 | 高级版 |
| 7 | `POST` | `/other/UpdateStepNumber` | 修改步数 | 高级版 |
| 8 | `POST` | `/other/UploadAppAttach` | 上传文件 | 高级版 |
## 16. 同步消息1 个接口)
| # | 方法 | 接口路径 | 说明 | 套餐 |
|---:|---|---|---|---|
| 1 | `GET` | `/ws/GetSyncMsg` | 如果 "key" 有效,则调用 WebSocketHandler 进行后续处理。 | 高级版 |
## 17. 管理/授权9 个接口)
| # | 方法 | 接口路径 | 说明 | 套餐 |
|---:|---|---|---|---|
| 1 | `POST` | `/admin/DelayAuthKey` | 授权码延期 | 白标/OEM |
| 2 | `POST` | `/admin/DeleteAuthKey` | 删除授权码 | 白标/OEM |
| 3 | `POST` | `/admin/DisableAuthKey` | 禁用授权码 | 白标/OEM |
| 4 | `POST` | `/admin/GenAuthKey1` | 生成授权码(新设备) | 白标/OEM |
| 5 | `GET` | `/admin/GenAuthKey2` | 生成授权码(新设备) | 白标/OEM |
| 6 | `POST` | `/admin/GenAuthKey3` | 生成授权码(1-日 7-周 30-月 90-季 180-半年 365-年 30000-永久)此key不使用无过期时间 | 白标/OEM |
| 7 | `GET` | `/admin/GetActiveLicenseKeys` | 查询所有激活状态的卡密 | 白标/OEM |
| 8 | `GET` | `/admin/GetProxyMappingList` | 获取代理映射列表 | 白标/OEM |
| 9 | `GET` | `/admin/HttpSyncLicenseKey` | 同步卡密激活状态, HTTP-轮询方式 | 白标/OEM |
## 18. 好友11 个接口)
| # | 方法 | 接口路径 | 说明 | 套餐 |
|---:|---|---|---|---|
| 1 | `POST` | `/friend/AgreeAdd` | 同意好友请求 | 初级版 |
| 2 | `POST` | `/friend/DelContact` | 删除好友 | 初级版 |
| 3 | `POST` | `/friend/GetContactDetailsList` | 获取联系人详情 | 初级版 |
| 4 | `POST` | `/friend/GetContactList` | 获取全部联系人 | 初级版 |
| 5 | `POST` | `/friend/GetFriendRelation` | 获取好友关系 | 初级版 |
| 6 | `GET` | `/friend/GetGHList` | 获取关注的公众号列表 | 高级版 |
| 7 | `GET` | `/friend/GetMFriend` | 获取手机通讯录好友 | 高级版 |
| 8 | `GET` | `/friend/GroupList` | 获取保存的群聊列表 | 高级版 |
| 9 | `POST` | `/friend/SearchContact` | 搜索联系人 | 初级版 |
| 10 | `POST` | `/friend/UploadMContact` | 上传手机通讯录好友 | 高级版 |
| 11 | `POST` | `/friend/VerifyUser` | 验证好友/添加好友 | 初级版 |