WeChat API 个人微信号API/微信协议/独家接口/PC hook
适配所有类型个人微信号及版本
支持傻瓜式二次开发
WeQuick 接口规范
商务合作请加微信：DiscoveryUpup
正常使用软件不会导致封号。
杀毒软件会对软件的正常运行构成影响，导致各种问题，请在使用前关闭杀毒软件。
注意事项
指令发出的方式有两种
- 通过 send_msg 轮询接口发出
- 通过 receive_msg 接口 return 发出
接口所用编码均为utf-8编码
服务端发出的指令格式应该是一个json数组，示例：
[{"sendId":"","api":"sendTextMessage","option":{"wxid":"","text":""}}]receive_msg
一.监听微信内部发生的各种事件,并主动向回调接口发送这些事件的详细信息. 这些事件的种类有:
登录登出
- 上报登陆二维码(reportQrCodeMessage)
- 上报当前登录微信详细信息(reportLoginUser)
- 上报退出登录事件(reportLogout)
好友相关
- 上报普通好友列表(reportContacts)
- 上报企业好友列表(reportImContacts)
- 上报公众号列表(reportPublics)
- 上报单个普通好友信息(reportSingleContact)
- 上报任意普通微信反查详细信息(reportUpdateContact)
- 上报联系人新增通知(reportContactAdd)
- 上报联系人删除通知(reportContactDel)
群相关
- 上报普通群列表(reportChatRooms)
- 上报企业群列表(reportImRooms)
- 上报单个普通群成员信息(reportSingleChatRoomMembers)
- 上报单个企业群成员信息(reportSingleImRoomMembers)
- 上报通过二维码进群返回状态(reportAcceptQrCodeChatRoom)
- 上报群成员新增通知(reportChatRoomMemberAdd)
- 上报群成员删除通知(reportChatRoomMemberDel)
- 上报检测到的新群通知(reportNewChatRoom)
- 上报退群或被踢通知(reportChatRoomQuit)
消息相关
- 上报文本消息(reportTextMessage)
- 上报图片消息(reportPicMessage)
- 上报文件消息(reportFileMessage)
- 上报视频消息(reportVideoMessage)
- 上报语音消息(reportVoiceMessage)
- 上报GIF表情消息(reportGifMessage)
- 上报个人名片消息(reportCardMessage)
- 上报位置消息(reportLocationMessage)
- 上报链接消息(网页或群邀请)(reportLinkMessage)
- 上报小程序消息(reportMiniMessage)
- 上报转账消息(reportTransferMessage)
- 上报无痕清理僵尸粉消息(reportZombieCheckMessage)
- 上报解密图片消息(reportDecryptPicMessage)
- 上报二维码付款消息(reportQrCodeWcPay)
- 上报收藏列表(reportFavitems)
- 上报系统消息(reportSystemMessage)
- 上报其他消息(reportOtherMessage)
- 上报其他接收应用未知消息(reportOtherAppMessage)
请求相关
- 上报新的加好友请求(reportFriendAddRequest)
- 上报加好友指令返回状态(reportAddFriendMessage)
- 上报通过手机号/微信号/QQ号查询任意微信号信息(reportSearchContact)
其他
- 上报数据库查询结果(reportSqlData)
- 上报扫描二维码结果(reportScanQrcodePic)
- 上报当前聊天对象改变(reportTalkerChange)
- 上报语音翻译结果(reportTransVoice)
- 上报URL访问状态(reportCheckUrlStatus)
send_msg
二. 执行回调接口下发的指令: 这些指令包括:
登录登出
- 打开微信(openWeChat)
- 获取二维码(getLoginQrCode)
- 获取当前登录微信详细信息(getLoginUser)
- 退出微信(logout)
好友相关
- 获取普通好友列表(getContacts)
- 获取企业好友列表(getImContacts)
- 获取公众号列表(getPublics)
- 获取单个普通好友信息(getSingleContact)
- 任意普通微信反查详细信息(updateContact)
- 添加好友(addFriend)
- 删除好友/取消关注公众号(delFriend)
- 修改好友备注(updateRemark)
- 接收加好友请求(acceptFriend)
- 接收好友转账(acceptBankTransfer)
- 退还好友转账(refuseFriendWcpay)
- 自动同意加好友申请(autoAcceptFriend)
- 自动同意好友转帐(autoAcceptWcpay)
- 自动加名片(autoAcceptCard)
- 单向加好友(acceptOnewayFriend)
- 通过手机号/微信号/QQ号查询任意微信号信息(searchContact)
- 添加通过任意手机号/微信号/QQ号查询的联系人(addSearchContact)
群相关
- 获取普通群列表(getChatRooms)
- 获取企业群列表(getImRooms)
- 获取单个普通群成员信息(getSingleChatRoomMembers)
- 获取单个企业群成员信息(getSingleImRoomMembers)
- 网络更新普通群成员信息(updateChatRoom)
- 发送40人以下群邀请(sendChatroomLow)
- 发送40人以上群邀请(sendChatroomHigh)
- 接受群邀请(acceptChatroomInvite)
- 踢群成员(delChatRoomMembers)
- 修改群名称(updateChatRoomName)
- 修改群公告(sendChatRoomNotice)
- 修改我在本群的昵称(updateChatRoomDisplayName)
- 是否显示群昵称(showDisplayName)
- 创建群聊(createChatRoom)
- 退出并删除群(quitDelChatRoom)
- 自动接受群邀请(autoAcceptChatRoom)
- 通过二维码进群(acceptQrcodeChatRoom)
- 保存到/移出通讯录(saveRoomToContact)
消息相关
- (腾讯已不支持)任意消息转发(transAnyMessage)
- 发送文本消息(sendTextMessage)
- 发送群内@文本消息(sendAtTextMessage)
- 发送图片(sendPicMessage)
- 发送文件(sendFileMessage)
- 发送视频(sendVideoMessage)
- 发送GIF表情(sendGifMessage)
- 发送链接消息(sendLinkMessage)
- 发送名片(sendCardMessage)
- 发送小程序(sendMiniMessage)
- 发送收藏(sendFavorite)
- 发送xml消息(sendXmlMessage)
- 发送名片xml消息(sendCardXmlMessage)
请求相关
- 关注公众号(addPublic)
- 获取收藏列表(getFavorites)
- 收藏指定消息(addFavoriteFrom)
- 语音翻译(transVoice)
- 无痕清粉(zombieCheck)
- 解密图片(decryptPic)
- 获取未读消息数量(unreadMsgCountChange)
- 清理微信聊天记录(clearChatHistory)
其他
- 识别二维码(scanQrcodePic)
- 开启/关闭消息免打扰(modRecvNotify)
- 置顶/取消置顶聊天(chatSessionTop)
- 打开内置浏览器(openBrowser)
- 开启/关闭防撤回功能(disableRevoke)
- 检测URL在微信中是否有效(checkUrlStatus)
- 查询微信数据库(getSqlData)
- 关闭进程(closeProcess)
receive_msg
参数说明
| 数据格式中的参数 |
参数的含义 |
| action |
上报的名称 |
| cwxid |
当前登录微信账号的微信 ID |
| data |
上报的数据 |
数据格式
{
"action" : "",
"cwxid" : "",
"data" : {}
}send_msg 任务下发到DLL的响应
{
"action":"",
"cwxid":"",
"data":{"errorReason":"","sendId":"","sendResult":""},
}01. 上报登陆二维码(reportQrCodeMessage)
参数说明
| data中的参数 |
参数说明 |
| file |
二维码图片的保存地址 |
| base64 |
二维码图片的 base64 格式 |
{
"data":{
"action":"reportQrCodeMessage",
"cwxid":"null",
"data":{
"file":"",
"base64":""
}
}
}02. 上报当前登录微信详细信息(reportLoginUser)
参数说明
| data中的参数 |
参数说明 |
| wxid |
微信id |
| nick |
微信昵称 |
| headPic |
头像的url地址 |
| phone |
手机号 |
| unreadmsg |
未读消息数量 |
| wxdir |
该账号微信缓存文件夹 |
{
"data":{
"action":"reportLoginUser",
"cwxid":"xxxxxx",
"data":{
"wxid": "wxid",
"nick": "xxxxx",
"headPic":"xxxxx",
"phone" :"xxxx",
"unreadmsg":"http://xxxxxxxx",
"wxdir" : 0
}
}
}03. 上报退出登录事件(reportLogout)
{
"data":{
"action":"reportLogout",
"cwxid":"xxxxxx",
"data":{}
}
}04. 上报普通好友列表(reportContacts)
参数说明
| data中的参数 |
参数说明 |
| wxid |
微信id |
| alias |
微信号(有可能为空) |
| nick |
微信昵称 |
| remark |
好友备注 |
| headPic |
头像的url地址 |
| sex |
性别:1男，2女,0(未知) |
| country |
祖国(可能为空) |
| province |
省份(可能为空) |
| city |
城市(可能为空) |
{
"data":{
"action":"reportContacts",
"cwxid":"xxxxxx",
"data":{
"friendList":[
{
"wxid": "wxid_xxxx",
"alias": "xxxxx",
"nick":"xxxxx",
"remark" :"xxxx",
"headPic":"http://xxxxxxxx",
"sex" : 1,
"country":"xxx",
"province":"xxxx",
"city":"xxxxx"
}
]
}
}
}05. 上报企业好友列表(reportImContacts)
参数说明
| data中的参数 |
参数说明 |
| wxid |
微信id |
| nick |
微信昵称 |
| remark |
好友备注 |
| headPic |
头像的url地址 |
{
"data":{
"action":"reportImContacts",
"cwxid":"xxxxxx",
"data":{
"friendList":[
{
"wxid": "wxid_xxxx",
"nick":"xxxxx",
"remark" :"xxxx",
"headPic":"http://xxxxxxxx"
}
]
}
}
}06. 上报公众号列表(reportPublics)
参数说明
| data中的参数 |
参数说明 |
| wxid |
某些公众号也可能以wxid_ 开头 |
| nick |
公众号名称 |
| headPic |
公众号头像的url地址 |
{
"data":{
"action" : "reportPublics",
"cwxid" : "xxxxxx",
"data" : {
"publicList": [
{
"wxid": "wxid",
"nick":"xxxxx",
"headPic":"http://xxxxxxxx"
}
]
}
}
}07. 上报单个普通好友信息(reportSingleContact)
参数说明
| data中的参数 |
参数的含义 |
| wxid |
微信id |
| alias |
微信号(有可能为空) |
| nick |
微信昵称 |
| remark |
好友备注 |
| headPic |
头像的url地址 |
| sex |
性别:1男，2女,0(未知) |
| country |
祖国(可能为空) |
| province |
省份(可能为空) |
| city |
城市(可能为空) |
{
"data":{
"action":"reportSingleContact",
"cwxid" : "xxxxx",
"data" : {
"wxid": "wxid_xxxx",
"alias": "xxxxx",
"nick":"xxxxx",
"remark" :"xxxx",
"headPic":"http://xxxxxxxx",
"sex" : 1,
"country":"xxx",
"province":"xxxx",
"city":"xxxxx"
}
}
}08. 上报任意普通微信反查详细信息(reportUpdateContact)
参数说明
| data中的参数 |
参数的含义 |
| wxid |
微信id |
| alias |
微信号(有可能为空) |
| nick |
微信昵称 |
| remark |
好友备注 |
| headPic |
高清头像的url地址 |
| smallPic |
小头像的url地址 |
| sex |
性别:1男，2女,0(未知) |
| country |
祖国(可能为空) |
| province |
省份(可能为空) |
| city |
城市(可能为空) |
| signature |
朋友圈个性签名 |
| snspic |
朋友圈背景图片 |
| scene |
来源类型 |
| status |
是否成功 1成功,0失败 |
| v1 |
用户v1 |
| v2 |
用户v2 |
| scene的值 |
参数的含义 |
| 6 |
好友验证, 加之前加过的人 |
| 14 |
添加群好友 |
| 15 |
通过查询添加 |
| 17 |
通过名片添加，需要传v1值 |
{
"data":{
"action":"reportUpdateContact",
"cwxid" : "xxxxx",
"data" : {
"wxid": "xxx",
"alias": "",
"nick": "xxxx",
"remark": "",
"headPic": "http://wx.qlogo.cn/xxxxxxx",
"smallPic": "http://wx.qlogo.cn/xxxxxx",
"sex": 1,
"country": "",
"province": "",
"city": "",
"signature": "",
"snspic": "http://szmmsns.qpic.cn/xxxxxx",
"scene": 6,
"status": 1,
"v1": "",
"v2": ""
}
}
}09. 上报联系人新增通知(reportContactAdd)
参数说明
| data中的参数 |
参数的含义 |
| wxid |
微信id |
| alias |
微信号(有可能为空) |
| nick |
微信昵称 |
| remark |
好友备注 |
| headPic |
头像的url地址 |
| sex |
性别:1男，2女,0(未知) |
| country |
祖国(可能为空) |
| province |
省份(可能为空) |
| city |
城市(可能为空) |
{
"data":{
"action":"reportContactAdd",
"cwxid" : "xxxxx",
"data" : {
"wxid": "xxx",
"alias": "",
"nick": "xxxx",
"remark": "",
"headPic": "http://wx.qlogo.cn/xxxxxxx",
"sex": 1,
"country": "",
"province": "",
"city": ""
}
}
}10. 上报联系人删除通知(reportContactDel)
参数说明
{
"data":{
"action":"reportContactDel",
"cwxid" : "xxxxx",
"data" : {
"wxid":"xxxx",
}
}
}11. 上报普通群列表(reportChatRooms)
参数说明
| data中的参数 |
参数的含义 |
| wxid |
群的微信ID |
| nick |
群昵称 |
| isowner |
是否为群主 |
| owner |
群主的wxid |
| headPic |
群头像 |
| roomCount |
群成员数量 |
| userLists |
当前群的成员wxid的列表 |
{
"data":{
"action":"reportChatRooms",
"cwxid" : "xxxxx",
"data" : {
"groupList":[
{
"wxid": "xxxxx@chatroom",
"nick":"xxxxx",
"isowner": 0,
"owner": "xxxx",
"headPic":"http://xxxxxxxx",
"roomCount" :"5",
"userLists":["xxx","xxx"]
}
]
}
}
}12. 上报企业群列表(reportImRooms)
参数说明
| data中的参数 |
参数的含义 |
| wxid |
群的微信 ID |
| owner |
群主 ID |
| nick |
群昵称 |
| headPic |
群头像 |
| roomCount |
群成员数量 |
| userLists中的参数 |
参数的含义 |
| wxid |
微信 ID |
| username |
微信号(有可能为空) |
| nick |
昵称 |
| headPic |
头像 |
| sex |
性别:1男，2女,0未知 |
| country |
祖国(可能为空) |
| province |
省份(可能为空) |
| city |
城市(可能为空) |
{
"data":{
"action":"reportImRooms",
"cwxid" : "xxxxx",
"data" : {
"groupList":[
{
"wxid": "xxxxx@chatroom",
"nick":"xxxxx",
"isowner": 0,
"owner": "xxxx",
"headPic":"http://xxxxxxxx",
"roomCount" :"5",
"userLists":["xxx","xxx"]
}
]
}
}
}13. 上报单个普通群成员信息(reportSingleChatRoomMembers)
参数说明
| data中的参数 |
参数的含义 |
| wxid |
群的微信 ID |
| roomCount |
群成员数量 |
| userLists中的参数 |
参数的含义 |
| wxid |
微信ID |
| alias |
微信号(有可能为空) |
| nick |
昵称 |
| displayname |
群昵称 |
| remark |
好友备注 |
| headPic |
头像 |
| sex |
性别:1男，2女,0未知 |
| country |
祖国(可能为空) |
| province |
省份(可能为空) |
| city |
城市(可能为空) |
{
"data":{
"action":"reportSingleChatRoomMembers",
"cwxid" : "xxxxx",
"data" : {
"wxid":"xxx@chatroom",
"roomCount":"",
"userLists":[
{
"wxid":"",
"alias":"",
"nick":"",
"displayname":"",
"remark":"",
"headPic":"",
"sex":"2",
"country":"xxx",
"province":"xxx",
"city":"xxx"
}
]
}
}
}14. 上报单个企业群成员信息(reportSingleImRoomMembers)
参数说明
| data中的参数 |
参数的含义 |
| wxid |
群微信ID |
| owner |
群主 ID |
| nick |
群名 |
| headPic |
群头像 |
| roomCount |
群成员数量 |
| userLists中的参数 |
参数的含义 |
| wxid |
微信 ID |
| nick |
昵称 |
| headPic |
头像 |
| remark |
备注 |
{
"data":{
"action":"reportSingleImRoomMembers",
"cwxid" : "xxxxx",
"data" : {
"wxid":"xxx@chatroom",
"owner":"xxxxx",
"nick":"",
"headPic":"",
"roomCount":"",
"userLists":[
{
"wxid":"",
"nick":"",
"headPic":"",
"sex":"2",
"country":"xxx",
"province":"xxx",
"city":"xxx"
}
]
}
}
}15. 上报通过二维码进群返回状态(reportAcceptQrCodeChatRoom)
参数说明
| data中的参数 |
参数的含义 |
| url |
二维码图片链接 |
| status |
执行状态，0成功， 1该群已开启进群验证， 2二维码已过期 |
{
"data":{
"action":"reportAcceptQrCodeChatRoom",
"cwxid" : "xxxxx",
"data" : {
"url": "http:///xxxxx",
"status":"0"
}
}
}16. 上报群成员新增通知(reportChatRoomMemberAdd)
参数说明
| data中的参数 |
参数的含义 |
| wxid |
群微信 ID |
| nick |
群昵称 |
| isowner |
是否为群主 |
| owner |
群主 ID |
| headPic |
群头像 |
| roomCount |
群成员数量 |
| userLists中的参数 |
参数的含义 |
| wxid |
微信 ID |
| nick |
昵称 |
| inviteBy |
邀请人微信ID |
{
"data":{
"action":"reportChatRoomMemberAdd",
"cwxid" : "xxxxx",
"data" : {
"wxid":"xxx@chatroom",
"nick":"",
"headPic":"",
"isowner": "",
"owner":"xxxxx",
"roomCount":"",
"userLists":[
{
"wxid":"",
"nick":"",
"inviteBy":""
}
]
}
}
}17. 上报群成员删除通知(reportChatRoomMemberDel)
参数说明
| data中的参数 |
参数的含义 |
| wxid |
群的微信 ID |
| nick |
群昵称 |
| headPic |
群头像 |
| isowner |
是否为群主 |
| owner |
群主 ID |
| roomCount |
群成员数量 |
| userLists中的参数 |
参数的含义 |
| wxid |
微信 ID |
| nick |
昵称 |
{
"data":{
"action":"reportChatRoomMemberDel",
"cwxid" : "xxxxx",
"data" : {
"wxid":"xxx@chatroom",
"nick":"",
"headPic":"",
"isowner":"xxxxx",
"owner":"xxxxx",
"roomCount":"",
"userLists":[
{
"wxid":"",
"nick":""
}
]
}
}
}18. 上报检测到的新群通知(reportNewChatRoom)
参数说明
| data中的参数 |
参数的含义 |
| wxid |
群的微信 ID |
| nick |
群昵称 |
| headPic |
群头像 |
| isowner |
是否为群主 |
| owner |
群主 ID |
| roomCount |
群成员数量 |
| userLists中的参数 |
参数的含义 |
| wxid |
微信ID |
| nick |
昵称 |
{
"data":{
"action":"reportNewChatRoom",
"cwxid" : "xxxxx",
"data" : {
"wxid":"xxx@chatroom",
"nick":"",
"headPic":"",
"isowner":"xxxxx",
"owner":"xxxxx",
"roomCount":"",
"userLists":[
{
"wxid":"",
"nick":""
}
]
}
}
}19. 上报退群或被踢通知(reportChatRoomQuit)
参数说明
| data中的参数 |
参数的含义 |
| roomWxid |
群的微信ID |
{
"data":{
"action":"reportChatRoomQuit",
"cwxid" : "xxxxx",
"data" : {
"roomWxid":"xxx@chatroom",
}
}
}20. 上报文本消息(reportTextMessage)
参数说明
| data中的参数 |
参数的含义 |
| msgType |
消息类型标记 |
| myMsg |
是否是本人发出的消息，1为是，0为不是 |
| ispc |
是否由PC端发出，1为是，0为不是 |
| msgid |
消息ID，可用于转发 |
| roomWxid |
聊天消息发生在哪个群(如果是私聊则为空) |
| wxidFrom |
消息发送者的wxid 如果是自己发的消息这里的wxid就是自己的微信号 |
| wxidTo |
消息的接收者的wxid 如果发往群的消息,这个值就是群的wxid 如果是别人私聊给自己的消息,这里就是自己的微信号 |
| message |
消息内容，纯文本格式 |
| atlist |
群内发送消息@用户列表 |
| timestamp |
消息时间戳 |
{
"data":{
"action":"reportTextMessage",
"cwxid":"",
"data":{
"msgType": 1,
"myMsg" : "0",
"ispc" : "0",
"msgid" : "2970283551233214898",
"roomWxid":"xxx@chatroom",
"wxidFrom" : "wxid_sadkwqlXXX",
"wxidTo" :"wxid_sadkwqlkq",
"message" : "XXXX",
"atlist" : ["wxid_1fd41f9u22", "wxid_1fd41f9"],
"timestamp":1597736976
}
}
}21. 上报图片消息(reportPicMessage)
参数说明
| data中的参数 |
参数的含义 |
| msgType |
消息类型标记 |
| myMsg |
是否是本人发出的消息，1为是，0为不是 |
| ispc |
是否由PC端发出，1为是，0为不是 |
| msgid |
消息ID，可用于转发 |
| roomWxid |
聊天消息发生在哪个群(如果是私聊则为空) |
| wxidFrom |
消息发送者的wxid 如果是自己发的消息这里的wxid就是自己的微信号 |
| wxidTo |
消息的接收者的wxid 如果发往群的消息,这个值就是群的wxid 如果是别人私聊给自己的消息,这里就是自己的微信号 |
| image |
图片本地路径 |
| imagethumb |
缩略图本地路径 |
| timestamp |
消息时间戳 |
| xmlmsg |
微信原始的xml信息 |
{
"data":{
"action":"reportPicMessage",
"cwxid":"xxxxx",
"data":{
"msgType": 3,
"myMsg" : "0",
"ispc" : "0",
"msgid" : "12314324243",
"roomWxid": "xxxxxxxx@chatroom",
"wxidFrom": "wxid_xxxxxx",
"wxidTo": "wxid_xxxxx",
"image" : "XXXX",
"imagethumb" : "XXXX",
"timestamp" : "XXXX",
"xmlmsg" : ""
}
}
}22. 上报文件消息(reportFileMessage)
参数说明
| data中的参数 |
参数的含义 |
| msgType |
消息类型标记 |
| myMsg |
是否是本人发出的消息，1为是，0为不是 |
| ispc |
是否由PC端发出，1为是，0为不是 |
| msgid |
消息ID，可用于转发 |
| roomWxid |
聊天消息发生在哪个群(如果是私聊则为空) |
| wxidFrom |
消息发送者的wxid 如果是自己发的消息这里的wxid就是自己的微信号 |
| wxidTo |
消息的接收者的wxid 如果发往群的消息,这个值就是群的wxid 如果是别人私聊给自己的消息,这里就是自己的微信号 |
| fileIndex |
文件下载后的本地路径 |
| timestamp |
消息时间戳 |
| xmlmsg |
微信原始的 xml 信息 |
{
"data":{
"action":"reportFileMessage",
"cwxid":"xxxxx",
"data":{
"msgType": "4906",
"myMsg" : "0",
"ispc" : "0",
"msgid" : "12314324243",
"roomWxid": "xxxxxxxx@chatroom",
"wxidFrom": "wxid_xxxxxx",
"wxidTo": "wxid_xxxxx",
"fileIndex":"",
"timestamp" : "XXXX",
"xmlmsg": "xxxxxxx"
}
}
}23. 上报视频消息(reportVideoMessage)
参数说明
| data中的参数 |
参数的含义 |
| msgType |
消息类型标记 |
| myMsg |
是否是本人发出的消息，1为是，0为不是 |
| ispc |
是否由PC端发出，1为是，0为不是 |
| msgid |
消息ID，可用于转发 |
| roomWxid |
聊天消息发生在哪个群(如果是私聊则为空) |
| wxidFrom |
消息发送者的wxid 如果是自己发的消息这里的wxid就是自己的微信号 |
| wxidTo |
消息的接收者的wxid 如果发往群的消息,这个值就是群的wxid 如果是别人私聊给自己的消息,这里就是自己的微信号 |
| coverIndex |
视频文件封面图片的本地路径 |
| videoIndex |
视频文件下载后的本地路径 |
| timestamp |
消息时间戳 |
| xmlmsg |
微信原始的 xml 信息 |
{
"data":{
"action":"reportVideoMessage",
"cwxid":"wxid_qg0saisth0r222",
"data":{
"msgType": 43,
"myMsg" : "0",
"ispc" : "0",
"msgid" : "12314324243",
"roomWxid": "xxxxxxxx@chatroom",
"wxidFrom": "wxid_xxxxxx",
"wxidTo": "wxid_xxxxx",
"coverIndex":"",
"videoIndex":"",
"timestamp":"",
"xmlmsg": "xxxxxxx"
}
}
}24. 上报语音消息(reportVoiceMessage)
参数说明
| data中的参数 |
参数的含义 |
| msgType |
消息类型标记 |
| myMsg |
是否是本人发出的消息，1为是，0为不是 |
| ispc |
是否由PC端发出，1为是，0为不是 |
| msgid |
消息ID，可用于转发 |
| roomWxid |
聊天消息发生在哪个群(如果是私聊则为空) |
| wxidFrom |
消息发送者的wxid 如果是自己发的消息这里的wxid就是自己的微信号 |
| wxidTo |
消息的接收者的wxid 如果发往群的消息,这个值就是群的wxid 如果是别人私聊给自己的消息,这里就是自己的微信号 |
| voiceIndex |
语音文件下载后的本地路径 |
| mp3Index |
语音转换后的本地路径 |
| timestamp |
消息时间戳 |
| xmlmsg |
微信原始的 xml 信息 |
{
"data":{
"action":"reportVoiceMessage",
"cwxid":"wxid_qg0saisth0r222",
"data":{
"msgType": 34,
"myMsg" : "0",
"ispc" : "0",
"msgid" : "12314324243",
"roomWxid": "xxxxxxxx@chatroom",
"wxidFrom": "wxid_xxxxxx",
"wxidTo": "wxid_xxxxx",
"voiceIndex" : "XXXX",
"mp3Index" : "XXXX",
"timestamp":"",
"xmlmsg": "xxxxxxx"
}
}
}25. 上报GIF表情消息(reportGifMessage)
参数说明
| data中的参数 |
参数的含义 |
| msgType |
消息类型标记 |
| myMsg |
是否是本人发出的消息，1为是，0为不是 |
| ispc |
是否由PC端发出，1为是，0为不是 |
| msgid |
消息ID，可用于转发 |
| roomWxid |
聊天消息发生在哪个群(如果是私聊则为空) |
| wxidFrom |
消息发送者的wxid 如果是自己发的消息这里的wxid就是自己的微信号 |
| wxidTo |
消息的接收者的wxid 如果发往群的消息,这个值就是群的wxid 如果是别人私聊给自己的消息,这里就是自己的微信号 |
| timestamp |
消息时间戳 |
| xmlmsg |
微信原始的 xml 信息 |
{
"data":{
"action":"reportGifMessage",
"cwxid":"wxid_qg0saisth0r222",
"data":{
"msg_type":47,
"myMsg" : "0",
"ispc" : "0",
"msgid" : "12314324243",
"roomWxid": "xxxxxxxx@chatroom",
"wxidFrom": "wxid_xxxxxx",
"wxidTo": "xxxxxxxxx",
"xmlmsg": "xxxxxxx",
"timestamp" : ""
}
}
}26. 上报个人名片消息(reportCardMessage)
参数说明
| data中的参数 |
参数的含义 |
| msgType |
消息类型标记 |
| myMsg |
是否是本人发出的消息，1为是，0为不是 |
| ispc |
是否由PC端发出，1为是，0为不是 |
| msgid |
消息ID，可用于转发 |
| roomWxid |
聊天消息发生在哪个群(如果是私聊则为空) |
| wxidFrom |
消息发送者的wxid 如果是自己发的消息这里的wxid就是自己的微信号 |
| wxidTo |
消息的接收者的wxid 如果发往群的消息,这个值就是群的wxid 如果是别人私聊给自己的消息,这里就是自己的微信号 |
| timestamp |
消息时间戳 |
| xmlmsg |
微信原始的 xml 信息 |
{
"data":{
"action":"reportCardMessage",
"cwxid":"wxid_qg0saisth0r222",
"data":{
"msgType": 42,
"myMsg" : "0",
"ispc" : "0",
"msgid" : "12314324243",
"roomWxid" : "",
"wxidFrom" : "",
"wxidTo" :"wxid_sadkwqlkq",
"xmlmsg": "xxxxxxx",
"timestamp" : ""
}
}
}27. 上报位置消息(reportLocationMessage)
参数说明
| data中的参数 |
参数的含义 |
| msgType |
消息类型标记 |
| myMsg |
是否是本人发出的消息，1为是，0为不是 |
| ispc |
是否由PC端发出，1为是，0为不是 |
| msgid |
消息ID，可用于转发 |
| roomWxid |
聊天消息发生在哪个群(如果是私聊则为空) |
| wxidFrom |
消息发送者的wxid 如果是自己发的消息这里的wxid就是自己的微信号 |
| wxidTo |
消息的接收者的wxid 如果发往群的消息,这个值就是群的wxid 如果是别人私聊给自己的消息,这里就是自己的微信号 |
| timestamp |
消息时间戳 |
| xmlmsg |
微信原始的 xml 信息 |
{
"data":{
"action":"reportCardMessage",
"cwxid":"wxid_qg0saisth0r222",
"data":{
"msgType": 48,
"myMsg" : "0",
"ispc" : "0",
"msgid" : "12314324243",
"roomWxid" : "",
"wxidFrom" : "",
"wxidTo" :"wxid_sadkwqlkq",
"xmlmsg": "xxxxxxx",
"timestamp" : ""
}
}
}28. 上报链接消息(网页或群邀请)(reportLinkMessage)
参数说明
| data中的参数 |
参数的含义 |
| msgType |
消息类型标记 |
| myMsg |
是否是本人发出的消息，1为是，0为不是 |
| ispc |
是否由PC端发出，1为是，0为不是 |
| msgid |
消息ID，可用于转发 |
| roomWxid |
聊天消息发生在哪个群(如果是私聊则为空) |
| wxidFrom |
消息发送者的wxid 如果是自己发的消息这里的wxid就是自己的微信号 |
| wxidTo |
消息的接收者的wxid 如果发往群的消息,这个值就是群的wxid 如果是别人私聊给自己的消息,这里就是自己的微信号 |
| timestamp |
消息时间戳 |
| xmlmsg |
微信原始的 xml 信息 |
{
"data":{
"action":"reportLinkMessage",
"cwxid":"xxxxx",
"data":{
"msgType": 4905,
"myMsg" : "0",
"ispc" : "0",
"msgid" : "12314324243",
"roomWxid" : "",
"wxidFrom" : "",
"wxidTo" :"wxid_sadkwqlkq",
"xmlmsg": "xxxxxxx",
"timestamp" : ""
}
}
}29. 上报小程序消息(reportMiniMessage)
参数说明
| data中的参数 |
参数的含义 |
| msgType |
消息类型标记 |
| myMsg |
是否是本人发出的消息，1为是，0为不是 |
| ispc |
是否由PC端发出，1为是，0为不是 |
| msgid |
消息ID，可用于转发 |
| roomWxid |
聊天消息发生在哪个群(如果是私聊则为空) |
| wxidFrom |
消息发送者的wxid 如果是自己发的消息这里的wxid就是自己的微信号 |
| wxidTo |
消息的接收者的wxid 如果发往群的消息,这个值就是群的wxid 如果是别人私聊给自己的消息,这里就是自己的微信号 |
| timestamp |
消息时间戳 |
| xmlmsg |
微信原始的 xml 信息 |
{
"data":{
"action":"reportMiniMessage",
"cwxid":"xxxxx",
"data":{
"msgType": 4933,
"myMsg" : "0",
"ispc" : "0",
"msgid" : "12314324243",
"roomWxid" : "",
"wxidFrom" : "",
"wxidTo" :"wxid_sadkwqlkq",
"xmlmsg": "xxxxxxx",
"timestamp" : ""
}
}
}30. 上报转账消息(reportTransferMessage)
参数说明
| data中的参数 |
参数的含义 |
| msgType |
消息类型标记 |
| myMsg |
是否是本人发出的消息，1为是，0为不是 |
| ispc |
是否由PC端发出，1为是，0为不是 |
| msgid |
消息ID，可用于转发 |
| wxidFrom |
消息发送者的wxid 如果是自己发的消息这里的wxid就是自己的微信号 |
| wxidTo |
消息的接收者的wxid 如果发往群的消息,这个值就是群的wxid 如果是别人私聊给自己的消息,这里就是自己的微信号 |
| timestamp |
消息时间戳 |
| xmlmsg |
微信原始的 xml 信息 |
| xml中的参数 |
参数的含义 |
| paysubtype |
这笔账单的状态，1:发起转账(包括我转账给他人，他人转账给我)；3:确认收账(包括我确认收账，他人确认收账);4:退还转账(包括我退还转账，他人退还转账给我) |
| paymemo |
这笔账单的备注 |
| feedesc |
这笔账单的金额 |
| transferid |
转账的ID |
{
"data":{
"action":"reportTransferMessage",
"cwxid":"xxxxx",
"data":{
"msgType": "4920",
"myMsg" : "0",
"ispc" : "0",
"msgid" : "12314324243",
"wxidFrom" : "",
"wxidTo" :"wxid_sadkwqlkq",
"xmlmsg": "xxxxxxx",
"timestamp" : ""
}
}
}31. 上报无痕清理僵尸粉消息(reportZombieCheckMessage)
参数说明
| data中的参数 |
参数的含义 |
| wxid |
被检测得微信ID |
| status |
检测状态 |
| status状态参数 |
参数的含义 |
| 0 |
非僵尸粉 |
| 1 |
僵尸粉(对方把我拉黑了) |
| 2 |
僵尸粉(对方把我删除了) |
| 3 |
僵尸粉(未知原因,对方微信号被腾讯注销等) |
{
"data":{
"action":"reportTransferMessage",
"cwxid":"wxid_qg0saisth0r222",
"data":{
"wxid": "wxid_xxxxx",
"status" : "0"
}
}
}32. 上报解密图片消息(reportDecryptPicMessage)
参数说明
| data中的参数 |
参数的含义 |
| srcfile |
待解密文件dat格式 |
| tarfile |
解密后的jpg图片 |
| status |
1为解密成功，0为失败 |
{
"data":{
"action":"reportDecryptPicMessage",
"cwxid":"xxxxx",
"data":{
"srcfile": "c:\\test.dat",
"tarfile" : "c:\\out.jpg",
"status": "1"
}
}
}33. 上报二维码付款消息(reportQrCodeWcPay)
参数说明
| data中的参数 |
参数的含义 |
| wxid |
付款者的微信ID |
| nick |
付款者的昵称 |
| fee |
支付金额 ( 单位分) |
| feetype |
支付类型 |
| orderno |
订单号 |
| timestamp |
消息时间戳 |
{
"data":{
"action":"reportQrCodeWcPay",
"cwxid":"xxxxx",
"data":{
"wxid" : "xxxxx",
"nick" : "XXXX",
"fee": "",
"feetype": "",
"orderno": "",
"timestamp": ""
}
}
}34. 上报收藏列表(reportFavitems)
参数说明
| data中的参数 |
参数的含义 |
| items |
收藏列表 |
| status |
获取状态 |
{
"data":{
"action":"reportFavitems",
"cwxid":"xxxxx",
"data":{
"items": [{
"fromUser" : "",
"localId": "",
"roomMember": "",
"title" : "",
"type": "",
"updateTime": "",
"xml": ""
}],
"status": 1
}
}
}35. 上报系统消息(reportSystemMessage)
参数说明
| data中的参数 |
参数的含义 |
| msgType |
消息类型标记 |
| myMsg |
是否是本人发出的消息，1为是，0为不是 |
| ispc |
是否由PC端发出，1为是，0为不是 |
| msgid |
消息ID，可用于转发 |
| roomWxid |
聊天消息发生在哪个群(如果是私聊则为空) |
| wxidFrom |
消息发送者的wxid |
| wxidTo |
消息的接收者的wxid |
| message |
系统消息 |
| timestamp |
消息时间戳 |
{
"data":{
"action":"reportSystemMessage",
"cwxid":"wxid_qg0saisth0r222",
"data":{
"msgType": "10000",
"myMsg" : "0",
"ispc" : "0",
"msgid" : "1231413213123",
"roomWxid": "",
"wxidFrom": "wxid_xxxxxx",
"wxidTo": "wxid_xxxxx",
"message": "",
"timestamp": "12312313123"
}
}
}
相关系统消息示例:
1.有红包出没时:"发出红包，请在手机上查看"
2.发消息-被对方拉黑之后,message 为"消息已发出，但被对方拒收了"
3.修改群名称后:xxxxx修改群名为xxxxxxx
4.群主已恢复默认进群方式。
5.群主已启用"群聊邀请确认"，群成员需群主确认才能邀请朋友进群。
6.你已成为新群主
7.xxxxxx已成为新群主
8.你邀请xxxx加入了群聊
9.xxxx邀请xxxx加入了群聊
10.xxxxx通过扫描你分享的二维码加入群聊
11.xxxxx通过扫描xxxxxx分享的二维码加入群聊
36. 上报其他消息(reportOtherMessage)
参数说明
| data中的参数 |
参数的含义 |
| msgType |
消息类型标记 |
| myMsg |
是否是本人发出的消息，1为是，0为不是 |
| ispc |
是否由PC端发出，1为是，0为不是 |
| msgid |
消息ID，可用于转发 |
| roomWxid |
聊天消息发生在哪个群(如果是私聊则为空) |
| wxidFrom |
消息发送者的wxid |
| wxidTo |
消息的接收者的wxid |
| message |
系统消息 |
| timestamp |
消息时间戳 |
{
"data":{
"action":"reportOtherMessage",
"cwxid":"xxxxx",
"data":{
"msgType": "x",
"myMsg" : "0",
"ispc" : "0",
"msgid" : "1231413213123",
"roomWxid": "",
"wxidFrom": "wxid_xxxxxx",
"wxidTo": "wxid_xxxxx",
"message": "",
"timestamp": "12312313123"
}
}
}37. 上报其他接收应用未知消息(reportOtherAppMessage)
参数说明
| data中的参数 |
参数的含义 |
| msgType |
消息类型标记 |
| myMsg |
是否是本人发出的消息，1为是，0为不是 |
| ispc |
是否由PC端发出，1为是，0为不是 |
| msgid |
消息ID，可用于转发 |
| roomWxid |
聊天消息发生在哪个群(如果是私聊则为空) |
| wxidFrom |
消息发送者的wxid |
| wxidTo |
消息的接收者的wxid |
| message |
系统消息 |
| timestamp |
消息时间戳 |
{
"data":{
"action":"reportTransferMessage",
"cwxid":"wxid_qg0saisth0r222",
"data":{
"msgType": "49x",
"myMsg" : "0",
"ispc" : "0",
"msgid" : "1231413213123",
"roomWxid": "",
"wxidFrom": "wxid_xxxxxx",
"wxidTo": "wxid_xxxxx",
"message": "",
"timestamp": "12312313123"
}
}
}38. 上报新的加好友请求(reportFriendAddRequest)
个别参数说明，未给出的则参考其他接口的说明
| data中的参数 |
参数的含义 |
| msgType |
消息类型标记 |
| ispc |
是否由PC端发出，1为是，0为不是 |
| msgid |
消息ID，可用于转发 |
| roomWxid |
聊天消息发生在哪个群(如果是私聊则为空) |
| wxidFrom |
消息发送者的wxid |
| wxidTo |
消息的接收者的wxid |
| xmlmsg |
加好友请求xml数据 |
| timestamp |
消息时间戳 |
相关说明:
xmlmsg包含v1,v2信息，使用v1,v2可以直接调用同意好友请求接口来同意添加好友
{
"data":{
"action":"reportFriendAddRequest",
"cwxid":"xxxxx",
"data" : {
"msgType": 37,
"ispc" : "0",
"msgid" : "1231413213123",
"roomWxid": "",
"wxidFrom": "wxid_xxxxxx",
"wxidTo": "wxid_xxxxx",
"xmlmsg": "",
"timestamp": "12312313123"
}
}
}39. 上报加好友指令返回状态(reportAddFriendMessage)
个别参数说明，未给出的则参考其他接口的说明
| data中的参数 |
参数的含义 |
| wxid |
添加的微信ID |
| status |
状态 |
| status状态参数 |
参数的含义 |
| 0 |
成功 |
| 1 |
失败，由于对方的隐私设置 |
| 2 |
失败, 操作频繁 |
| 3 |
失败, 获取V2数据失败 |
| -x |
失败, 未知错误码 |
{
"data":{
"action":"reportAddFriendMessage",
"cwxid":"xxxxx",
"data" : {
"wxid":"",
"status":0
}
}
}40. 上报通过手机号/微信号/QQ号查询任意微信号信息(reportSearchContact)
参数说明
| data中的参数 |
参数的含义 |
| wxid |
查询到的微信ID |
| alias |
微信号(有可能为空) |
| nick |
微信昵称 |
| headPic |
高清头像的url地址 |
| smallPic |
小头像的url地址 |
| sex |
性别:1男，2女,0(未知) |
| country |
祖国(可能为空) |
| province |
省份(可能为空) |
| city |
城市(可能为空) |
| search |
查询内容 |
| signature |
朋友圈个性签名 |
| status |
是否成功 1成功,0失败 |
| isFriend |
是否好友 |
| v1 |
用户v1 |
| v2 |
用户v2 |
{
"data":{
"action":"reportSearchContact",
"cwxid":"xxxxx",
"data" : {
"wxid":"",
"alias":"",
"nick":"",
"headPic":"",
"smallPic":"",
"sex":"2",
"country":"xxx",
"province":"xxx",
"city":"xxx",
"search":"xxx",
"signature":"xxx",
"status":"xxx",
"isFriend":"xxx",
"v1":"xxxxxx",
"v2":"xxxxxxx"
}
}
}41. 上报数据库查询结果(reportSqlData)
参数说明
| data中的参数 |
参数的含义 |
| result |
查询结果 |
| extend |
指令附加标记，可空 |
{
"data":{
"action":"reportSqlData",
"cwxid":"xxxxx",
"data" : {
"result":"",
"extend":"search_test"
}
}
}42. 上报扫描二维码结果(reportScanQrcodePic)
参数说明
| data中的参数 |
参数的含义 |
| pic |
二维码图片地址 |
| content |
二维码内容 |
| type |
二维码类型 |
| status |
扫描结果状态，1成功，0失败 |
{
"data":{
"action":"reportScanQrcodePic",
"cwxid":"xxxxx",
"data" : {
"pic":"",
"content":"",
"type":"",
"status":""
}
}
}43. 上报当前聊天对象改变(reportTalkerChange)
参数说明
| data中的参数 |
参数的含义 |
| user |
当前对象 |
| type |
当前对象类型，1为好友，2为群，3为公众号 |
| status |
状态 |
| user中的参数 |
参数的含义 |
| wxid |
当前对象微信ID |
| nick |
当前对象昵称 |
| headPic |
当前对象头像 |
| isowner |
是否为群主 |
| owner |
群主微信ID |
| roomcount |
群成员个数 |
{
"data":{
"action":"reportTalkerChange",
"cwxid":"xxxxx",
"data" : {
"user": {
"wxid":"",
"nick":"",
"headPic":"",
"isowner":"",
"owner":"",
"roomcount":""
},
"type":"",
"status":""
}
}
}44. 上报语音翻译结果(reportTransVoice)
参数说明
| data中的参数 |
参数的含义 |
| msgType |
消息类型标记 |
| msgid |
消息ID，可用于转发 |
| roomWxid |
聊天消息发生在哪个群(如果是私聊则为空) |
| wxidFrom |
消息发送者的wxid |
| wxidTo |
消息的接收者的wxid |
| text |
翻译后的文本 |
| status |
状态 |
{
"data":{
"action":"reportTransVoice",
"cwxid":"xxxxx",
"data" : {
"msgType": "",
"msgId": "",
"roomWxid": "",
"wxidFrom": "",
"wxidTo": "",
"text": "",
"status": ""
}
}
}45. 上报URL访问状态(reportCheckUrlStatus)
参数说明
| data中的参数 |
参数的含义 |
| url |
待测试url |
| realUrl |
真实url |
| status |
访问状态，0可以访问，负值不能访问 |
{
"data":{
"action":"reportCheckUrlStatus",
"cwxid":"xxxxx",
"data" : {
"url": "",
"realUrl": "",
"status": ""
}
}
}46. 上报上传客户端文件到服务端结果(resUploadFile)
参数说明
| data中的参数 |
参数的含义 |
| sendResult |
服务端接收文件的返回值 |
{
"data":{
"action":"resUploadFile",
"cwxid":"xxxxx",
"data" : {
"errorReason": "",
"sendId": "8859663",
"sendResult": ""
}
}
}send_msg
数据格式
{
"api" : "",
"sendId":"",
"option" : {}
}01. 打开微信(openWeChat)
{
"api" : "openWeChat",
"sendId":"",
"option" : {}
}02. 获取二维码(getLoginQrCode)
{
"api" : "getLoginQrCode",
"sendId":"",
"option" : {}
}03. 获取当前登录微信详细信息(getLoginUser)
{
"api" : "getLoginUser",
"sendId":"",
"option" : {}
}04. 退出微信(logout)
{
"api" : "logout",
"sendId":"",
"option" : {}
}05. 获取普通好友列表(getContacts)
{
"api" : "getContacts",
"sendId":"",
"option" : {}
}06. 获取企业好友列表(getImContacts)
{
"api" : "getImContacts",
"sendId":"",
"option" : {}
}07. 获取公众号列表(getPublics)
{
"api" : "getPublics",
"sendId":"",
"option" : {}
}08. 获取单个普通好友信息(getSingleContact)
参数说明
| option中的参数 |
参数的含义 |
| wxid |
微信id |
{
"api" : "getSingleContact",
"sendId":"",
"option" : {
"wxid":"xxxxx"
}
}09. 任意普通微信反查详细信息(updateContact)
参数说明
| option中的参数 |
参数的含义 |
| wxid |
微信id |
{
"api" : "updateContact",
"sendId":"",
"option" : {
"wxid":"xxxxx"
}
}10. 添加好友(addFriend)
参数说明
| option中的参数 |
参数的含义 |
| wxid |
要添加的微信id |
| remark |
打招呼消息 |
| scene |
来源类型 |
| roomWxid |
来自哪个群，可空 |
| scene的值 |
参数的含义 |
| 6 |
好友验证, 加之前加过的人 |
| 14 |
添加群好友 |
| 15 |
通过查询添加 |
| 17 |
通过名片添加，需要传v1值 |
{
"api" : "addFriend",
"sendId":"",
"option" : {
"wxid": "",
"remark": "",
"scene": "",
"roomWxid": ""
}
}11. 删除好友/取消关注公众号(delFriend)
参数说明
| option中的参数 |
参数的含义 |
| wxid |
微信id |
{
"api" : "delFriend",
"sendId":"",
"option" : {
"wxid":"xxxxx"
}
}12.
参数说明
| option中的参数 |
参数的含义 |
| wxid |
需要修改备注的好友的微信id |
| remark |
好友备注 |
{
"api" : "updateRemark",
"sendId":"",
"option" : {
"wxid":"",
"remark":""
}
}13. 接收加好友请求(acceptFriend)
参数说明
| option中的参数 |
参数的含义 |
| v1 |
对方V1 |
| v2 |
对方V2 |
| scene |
好友来源，接收到的加好友请求XML信息中有 |
| scene的值 |
参数的含义 |
| 6 |
好友验证, 加之前加过的人 |
| 14 |
添加群好友 |
| 15 |
通过查询添加 |
| 17 |
通过名片添加，需要传v1值 |
{
"api" : "acceptFriend",
"sendId":"",
"option" : {
"v1":"",
"v2":"",
"scene":""
}
}14. 接收好友转账(acceptBankTransfer)
参数说明
| option中的参数 |
参数的含义 |
| transferid |
收哪一笔转账(收到转账xml信息 中的 transferid) |
{
"api":"acceptBankTransfer",
"sendId":"",
"option":{
"transferid":""
}
}15. 退还好友转账(refuseFriendWcpay)
参数说明
| option中的参数 |
参数的含义 |
| transferid |
退还哪一笔转账(收到转账xml信息 中的 transferid) |
{
"api":"refuseFriendWcpay",
"sendId":"",
"option":{
"transferid":""
}
}16. 自动同意加好友申请(autoAcceptFriend)
参数说明
| option中的参数 |
参数的含义 |
| auto |
0是取消自动，1自动 |
{
"api":"autoAcceptFriend",
"sendId":"",
"option":{
"auto":1
}
}17. 自动同意好友转帐(autoAcceptWcpay)
参数说明
| option中的参数 |
参数的含义 |
| auto |
0是取消自动，1自动 |
{
"api":"autoAcceptWcpay",
"sendId":"",
"option":{
"auto":1
}
}18. 自动加名片(autoAcceptCard)
参数说明
| option中的参数 |
参数的含义 |
| auto |
0是取消自动，1自动 |
{
"api":"autoAcceptCard",
"sendId":"",
"option":{
"auto":1
}
}19. 单向加好友(acceptOnewayFriend)
参数说明
| option中的参数 |
参数的含义 |
| wxid |
要添加的微信id |
注意:
当设置成添加时不需要验证，有好友添加，还需要再次确认添加
{
"api":"acceptOnewayFriend",
"sendId":"",
"option":{
"wxid":""
}
}20. 通过手机号/微信号/QQ号查询任意微信号信息(searchContact)
参数说明
| option中的参数 |
参数的含义 |
| search |
要查询的手机号/微信号/QQ号 |
{
"api":"searchContact",
"sendId":"",
"option":{
"search":""
}
}21. 添加通过任意手机号/微信号/QQ号查询的联系人(addSearchContact)
参数说明
| option中的参数 |
参数的含义 |
| v1 |
对方V1 |
| v2 |
对方V2 |
| remark |
加好友申请语 |
| scene |
好友来源，接收到的加好友请求XML信息中有 |
| scene的值 |
参数的含义 |
| 6 |
好友验证, 加之前加过的人 |
| 14 |
添加群好友 |
| 15 |
通过查询添加 |
| 17 |
通过名片添加，需要传v1值 |
{
"api":"addSearchContact",
"sendId":"",
"option":{
"v1":"",
"v2":"",
"remark":"",
"scene":15
}
}22. 获取普通群列表(getChatRooms)
参数说明
{
"api" : "getChatRooms",
"sendId":"",
"option" : { }
}23. 获取企业群列表(getImRooms)
参数说明
{
"api" : "getImRooms",
"sendId":"",
"option" : { }
}24. 获取单个普通群成员信息(getSingleChatRoomMembers)
参数说明
| option中的参数 |
参数的含义 |
| roomWxid |
群的微信id |
{
"api" : "getSingleChatRoomMembers",
"sendId":"",
"option" : {
"roomWxid":""
}
}25. 获取单个企业群成员信息(getSingleImRoomMembers)
参数说明
| option中的参数 |
参数的含义 |
| roomWxid |
群的微信id |
{
"api" : "getSingleImRoomMembers",
"sendId":"",
"option" : {
"roomWxid":""
}
}26. 网络更新普通群成员信息(updateChatRoom)
参数说明
| option中的参数 |
参数的含义 |
| roomWxid |
群的微信id |
{
"api" : "updateChatRoom",
"sendId":"",
"option" : {
"roomWxid":""
}
}27. 发送40人以下群邀请(sendChatroomLow)
参数说明
| option中的参数 |
参数的含义 |
| roomWxid |
群的微信id |
| wxidList |
要邀请的微信id |
注意:
人数少于40人的群，调用该接口，不需要好友同意即可直接拉入群
{
"api" : "sendChatroomLow",
"sendId":"",
"option" : {
"roomWxid":"",
"wxidList":["", ""]
}
}28. 发送40人以上群邀请(sendChatroomHigh)
参数说明
| option中的参数 |
参数的含义 |
| roomWxid |
群的微信id |
| wxidList |
要邀请的微信id |
注意:
对于人多的群，调用该接口，需要好友同意
{
"api" : "sendChatroomHigh",
"sendId":"",
"option" : {
"roomWxid":"",
"wxidList":["", ""]
}
}29. 接受群邀请(acceptChatroomInvite)
参数说明
| option中的参数 |
参数的含义 |
| wxid |
好友的微信id |
| inviteurl |
好友发来的入群链接的地址 (该值从上报的入群链接消息的url字段中获取) |
{
"api":"acceptChatroomInvite",
"sendId":"",
"option":{
"wxid":"",
"inviteurl":"https://support...."
}
}30. 踢群成员(delChatRoomMembers)
参数说明
| option中的参数 |
参数的含义 |
| roomWxid |
群的微信id |
| wxidList |
要邀请的微信id |
注意:
当前微信必须有踢人权限
{
"api":"delChatRoomMembers",
"sendId":"",
"option":{
"roomWxid":"",
"wxidList":["", ""]
}
}31. 修改群名称(updateChatRoomName)
参数说明
| option中的参数 |
参数的含义 |
| roomWxid |
群的微信id |
| name |
要修改成的群名 |
{
"api":"updateChatRoomName",
"sendId":"",
"option":{
"roomWxid":"",
"name":""
}
}32. 修改群公告(sendChatRoomNotice)
参数说明
| option中的参数 |
参数的含义 |
| roomWxid |
群的微信id |
| notice |
群公告内容 |
{
"api":"sendChatRoomNotice",
"sendId":"",
"option":{
"roomWxid":"",
"notice":""
}
}33. 修改我在本群的昵称(updateChatRoomDisplayName)
参数说明
| option中的参数 |
参数的含义 |
| roomWxid |
群的微信id |
| nick |
我在本群的昵称 |
{
"api" : "updateChatRoomDisplayName",
"sendId":"",
"option" : {
"roomWxid":"",
"nick":""
}
}34. 是否显示群昵称(showDisplayName)
参数说明
| option中的参数 |
参数的含义 |
| roomWxid |
群的微信id |
| code |
0不显示，1显示 |
{
"api":"showDisplayName",
"sendId":"",
"option":{
"roomWxid":"",
"code":1
}
}35. 创建群聊(createChatRoom)
参数说明
| option中的参数 |
参数的含义 |
| wxidLists |
要添加群聊的人员的微信id(由于群聊必须至少3个人, 因此必须包含至少2个好友的wxid) |
{
"api":"createChatRoom",
"sendId":"",
"option":{
"wxidLists":""
}
}36. 退出并删除群(quitDelChatRoom)
参数说明
| option中的参数 |
参数的含义 |
| roomWxid |
群的微信id |
{
"api":"quitDelChatRoom",
"sendId":"",
"option":{
"roomWxid":""
}
}37. 自动接受群邀请(autoAcceptChatRoom)
参数说明
| option中的参数 |
参数的含义 |
| auto |
0是取消自动，1自动 |
{
"api":"autoAcceptChatRoom",
"sendId":"",
"option":{
"auto":1
}
}38. 通过二维码进群(acceptQrcodeChatRoom)
参数说明
| option中的参数 |
参数的含义 |
| url |
二维码地址 |
{
"api":"acceptQrcodeChatRoom",
"sendId":"",
"option":{
"url":""
}
}39. 保存到/移出通讯录(saveRoomToContact)
参数说明
| option中的参数 |
参数的含义 |
| roomWxid |
群的微信id |
| code |
0移出通讯录，1保存到通讯录 |
{
"api":"saveRoomToContact",
"sendId":"",
"option":{
"roomWxid":"",
"code":1
}
}40. （腾讯已失效）任意消息转发(transAnyMessage)
参数说明
| option中的参数 |
参数的含义 |
| wxid |
要发送的对象的微信id |
| msgid |
消息id |
{
"api" : "transAnyMessage",
"sendId":"",
"option" : {
"wxid":"",
"msgid":""
}
}41. 发送文本消息(sendTextMessage)
参数说明
| option中的参数 |
参数的含义 |
| wxid |
要发送的对象的微信id |
| text |
消息文本 |
{
"api" : "sendTextMessage",
"sendId":"",
"option" : {
"wxid":"",
"text":"",
}
}42. 发送群内@文本消息(sendAtTextMessage)
参数说明
| option中的参数 |
参数的含义 |
| wxid |
要发送的对象的微信id |
| text |
消息文本 |
| atlist |
@人的wxid |
注意:
文本消息text的内容中设置占位符{$@},代表被@群成员，占位符的数量必须和atlist中的微信号数量相等。
{
"api" : "sendAtTextMessage",
"sendId":"",
"option" : {
"wxid":"",
"text":"你好{$@},你好{$@},哈哈哈",
"atlist":["wxid_xxx","wxid_xxx"]
}
}43. 发送图片(sendPicMessage)
参数说明
| option中的参数 |
参数的含义 |
| wxid |
要发送的对象的微信id |
| imgPath |
图片地址(客户端所在主机的本地图片地址) |
注意:
在线图片需要调用接口下载到本地，再发出
{
"api" : "sendPicMessage",
"sendId":"",
"option" : {
"wxid":"",
"imgPath":""
}
}44. 发送文件(sendFileMessage)
参数说明
| option中的参数 |
参数的含义 |
| wxid |
要发送的对象的微信id |
| filePath |
文件地址(客户端所在主机的本地文件地址) |
注意:
在线文件需要调用接口下载到本地，再发出
{
"api" : "sendFileMessage",
"sendId":"",
"option" : {
"wxid":"",
"filePath":""
}
}45. 发送视频(sendVideoMessage)
参数说明
| option中的参数 |
参数的含义 |
| wxid |
要发送的对象的微信id |
| videoPath |
视频地址(客户端所在主机的本地视频文件地址) |
注意:
在线视频需要调用接口下载到本地，再发出
{
"api" : "sendVideoMessage",
"sendId":"",
"option" : {
"wxid":"",
"videoPath":""
}
}46. 发送GIF表情(sendGifMessage)
参数说明
| option中的参数 |
参数的含义 |
| wxid |
要发送的对象的微信id |
| gifPath |
本地gif图片地址 |
{
"api" : "sendGifMessage",
"sendId":"",
"option" : {
"wxid":"",
"gifPath":""
}
}47. 发送链接消息(sendLinkMessage)
参数说明
| option中的参数 |
参数的含义 |
| wxid |
要发送的对象的微信id |
| title |
标题 |
| url |
url链接 |
| desc |
描述 |
| pic |
在线图片url链接 |
{
"api" : "sendLinkMessage",
"sendId":"",
"option" : {
"wxid":"",
"title":"标题",
"url":"url链接",
"desc":"描述",
"pic":"图片url链接"
}
}48. 发送名片(sendCardMessage)
参数说明
| option中的参数 |
参数的含义 |
| wxid |
要发送的对象的微信id |
| wxidCard |
要发送的名片的微信id |
{
"api" : "sendCardMessage",
"sendId":"",
"option" : {
"wxid":"",
"wxidCard":""
}
}49. 发送小程序(sendMiniMessage)
参数说明
| option中的参数 |
参数的含义 |
| wxid |
要发送的对象的微信id |
| msgid |
小程序的消息id |
{
"api" : "sendMiniMessage",
"sendId":"",
"option" : {
"wxid":"",
"msgid":""
}
}50. 发送收藏(sendFavorite)
参数说明
| option中的参数 |
参数的含义 |
| wxid |
要发送的对象的微信id |
| localId |
从获取收藏列表处，获取localId |
{
"api" : "sendFavorite",
"sendId":"",
"option" : {
"wxid":"",
"localId":""
}
}51. 发送xml消息(sendXmlMessage)
参数说明
| option中的参数 |
参数的含义 |
| wxid |
要发送的对象的微信id |
| xml |
要发送的xml数据 |
{
"api" : "sendXmlMessage",
"sendId":"",
"option" : {
"wxid":"",
"xml":""
}
}52. 发送名片xml消息(sendCardXmlMessage)
参数说明
| option中的参数 |
参数的含义 |
| wxid |
要发送的对象的微信id |
| xml |
要发送的名片的xml数据 |
{
"api" : "sendCardXmlMessage",
"sendId":"",
"option" : {
"wxid":"",
"xml":""
}
}53. 关注公众号(addPublic)
参数说明
| option中的参数 |
参数的含义 |
| wxid |
要发送的对象的微信id |
| scene |
添加来源，可空 |
{
"api" : "addPublic",
"sendId":"",
"option" : {
"wxid":"",
"scene":""
}
}54. 获取收藏列表(getFavorites)
参数说明
{
"api" : "getFavorites",
"sendId":"",
"option" : { }
}55. 收藏指定消息(addFavoriteFrom)
参数说明
| option中的参数 |
参数的含义 |
| wxid |
要发送的对象的微信id |
| msgid |
要收藏的消息的消息id |
{
"api" : "addFavoriteFrom",
"sendId":"",
"option" : {
"wxid":"",
"msgid":""
}
}56. 语音翻译(transVoice)
参数说明
| option中的参数 |
参数的含义 |
| wxid |
要发送的对象的微信id |
| msgid |
要翻译的语音消息的消息id |
{
"api" : "transVoice",
"sendId":"",
"option" : {
"wxid":"",
"msgid":""
}
}57. 无痕清粉(zombieCheck)
参数说明
| option中的参数 |
参数的含义 |
| wxid |
待检测的微信id |
{
"api" : "zombieCheck",
"sendId":"",
"option" : {
"wxid":""
}
}58. 解密图片(decryptPic)
参数说明
| option中的参数 |
参数的含义 |
| srcfile |
微信加密图片dat路径 |
| tarfile |
指定解密后的jpg图片路径 |
{
"api" : "decryptPic",
"sendId":"",
"option" : {
"srcfile":"",
"tarfile":""
}
}59. 获取未读消息数量(unreadMsgCountChange)
参数说明
{
"api" : "unreadMsgCountChange",
"sendId":"",
"option" : { }
}60. 清理微信聊天记录(clearChatHistory)
参数说明
{
"api" : "clearChatHistory",
"sendId":"",
"option" : { }
}61. 识别二维码(scanQrcodePic)
参数说明
| option中的参数 |
参数的含义 |
| pic |
要识别的本地二维码文件路径 |
{
"api" : "scanQrcodePic",
"sendId":"",
"option" : {
"pic":""
}
}62. 开启/关闭消息免打扰(modRecvNotify)
参数说明
| option中的参数 |
参数的含义 |
| wxid |
微信id |
| code |
0是关闭，1开启 |
{
"api" : "modRecvNotify",
"sendId":"",
"option" : {
"wxid":"",
"code":""
}
}63. 置顶/取消置顶聊天(chatSessionTop)
参数说明
| option中的参数 |
参数的含义 |
| wxid |
微信id |
| code |
0是取消置顶，1置顶 |
{
"api" : "chatSessionTop",
"sendId":"",
"option" : {
"wxid":"",
"code":""
}
}64. 打开内置浏览器(openBrowser)
参数说明
| option中的参数 |
参数的含义 |
| url |
要打开的网页链接 |
{
"api" : "openBrowser",
"sendId":"",
"option" : {
"url":""
}
}65. 开启/关闭防撤回功能(disableRevoke)
参数说明
| option中的参数 |
参数的含义 |
| code |
1是开启防撤回，0是关闭 |
{
"api" : "disableRevoke",
"sendId":"",
"option" : {
"code":""
}
}66. 检测URL在微信中是否有效(checkUrlStatus)
参数说明
| option中的参数 |
参数的含义 |
| url |
要检测的网页链接 |
{
"api" : "checkUrlStatus",
"sendId":"",
"option" : {
"url":""
}
}67. 查询微信数据库(getSqlData)
参数说明
| option中的参数 |
参数的含义 |
| sql |
数据库查询语句 |
| db |
数据库id |
| extend |
查询语句标记字段 |
| 相关查询 |
sql语句 |
数据库 |
| 查询企业好友 |
select UserName,NickName,SmallHeadImgUrl,Remark from OpenIMContact where UserName like '%openim' and Type%2=1 |
db:7 |
| 查询全部企业群 |
select UserName,NickName,SmallHeadImgUrl from OpenIMContact where UserName like '%@im.chatroom' and Type !=0 |
db:7 |
| 查询企业群群主 |
select RoomName,Owner from OpenIMChatroomData |
db:7 |
| 查询企业群成员微信ID |
select RoomName,UserName from OpenIMChatroomMember |
db:7 |
| 查询单个企业微信群信息 |
select UserName,NickName,SmallHeadImgUrl from OpenIMContact where UserName='12321321@im.chatroom' |
db:7 |
| 查询企业群中的企业微信用户信息 |
select UserName,NickName,SmallHeadImgUrl from OpenIMContact where UserName in ('wxid0','wxid1') |
db:7 |
| 查询企业群中的非企业微信用户信息 |
select UserName,Alias,NickName,Remark from Contact where UserName in ('wxid0','wxid1') |
db:1 |
| 查询企业群中的非企业微信用户头像信息 |
select usrName,smallHeadImgUrl from ContactHeadImgUrl where usrName in ('wxid0','wxid1') |
db:1 |
| db示例 |
参数的含义 |
数据库 |
| 1 |
好友和群信息数据库 |
MicroMsg.db |
| 2 |
头像数据库 |
Misc.db |
| 3 |
多媒体数据库 |
Media.db |
| 4 |
聊天相关数据库 |
ChatMsg.db |
| 5 |
收藏相关数据库 |
Favorite.db |
| 6 |
消息相关数据库 |
MSG.db |
| 7 |
企业相关数据库 |
OpenIMContact.db |
{
"api" : "getSqlData",
"sendId":"",
"option" : {
"sql":"",
"db":1,
"extend":"test"
}
}68. 关闭进程(closeProcess)
参数说明
| option中的参数 |
参数的含义 |
| pid |
进程id(send_msg 接口中收到的 pid) |
{
"api":"closeProcess",
"sendId":"",
"option":{
"pid":""
}
}69. 把客户端所在PC的资料上传到指定服务器(uploadFile)
参数说明
| option中的参数 |
参数的含义 |
| cwxid |
当前登陆微信ID |
| filepath |
本地文件地址（如：C:/work/demo.md） |
| url |
文件上传的地址（如：http://xxx/upload） |
注意:
接受上传文件的服务器要自己搭建
{
"api":"uploadFile",
"sendId":"",
"option":{
"cwxid":"xxxx",
"filepath":"",
"url":""
}
}70. 下载资料到客户端所在PC(downloadFile)
参数说明
{
"api":"downloadFile",
"sendId":"",
"option":{
"cwxid":"xxxxx",
"url":""
}
}商务合作请加微信：DiscoveryUpup
