wxhelper/doc/3.9.5.81.md
2023-08-31 08:44:35 +08:00

26 KiB
Raw Blame History

编译构建

环境: cl.exe目录= c:/cl.exe
ml64.exe目录 =c:/ml64.exe
vcpkg目录 = c:/vcpkg wxhelper目录 = c:/wxhelper


vcpkg  install detours:x64-windows 
vcpkg  install nlohmann-json:x64-windows

cd wxhelper  
mkdir build  
cd build  
cmake -DCMAKE_C_COMPILER=cl.exe  \
-DCMAKE_CXX_COMPILER=cl.exe \
-DCMAKE_ASM_MASM_COMPILER=ml64.exe \
-DCMAKE_BUILD_TYPE=Debug \
-DCMAKE_INSTALL_PREFIX=C:/wxhelper/install/x64-debug \
-DCMAKE_TOOLCHAIN_FILE:FILEPATH=C:/vcpkg/scripts/buildsystems/vcpkg.cmake \
-SC:c:/wxhelper \
-BC:c:/wxhelper/build/x64-debug\
-G Ninja  
cmake --build ..  

如果有错误按错误提示修正即可。

3.9.5.81版本http接口文档文档仅供参考。

简单说明:

所有接口只支持post方法。
全部使用json格式。
格式: http://host:port/api/xxxx
host: 绑定的host
port: 监听的端口
xxxx: 对应的功能路径
返回结构的json格式

 {
   "code": 1,
   "data": {},
   "msg": "success"
}

code 错误码
msg 成功/错误信息
data 接口返回的数据

0.检查微信登录**

接口功能

检查微信是否登录

接口地址

/api/checkLogin

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
返回字段
返回字段 字段类型 说明
code int 返回状态,1 成功, 0失败
result string 成功提示
data string 响应内容
接口示例

入参:

响应:

{
    "code": 1,
    "msg": "success",
    "data":null
}

1.获取登录用户信息**

接口功能

获取登录用户信息

接口地址

/api/userInfo

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
返回字段
返回字段 字段类型 说明
code int 返回状态,1 成功, 0失败
result string 成功提示
data object 响应内容
account string 账号
headImage string 头像
city string 城市
country string 国家
currentDataPath string 当前数据目录,登录的账号目录
dataSavePath string 微信保存目录
mobile string 手机
name string 昵称
province string
wxid string wxid
signature string 个人签名
dbKey string 数据库的SQLCipher的加密key可以使用该key配合decrypt.py解密数据库
接口示例

入参:

响应:

{
    "code": 1,
    "data": {
        "account": "xxx",
        "city": "Zhengzhou",
        "country": "CN",
        "currentDataPath": "C:\\WeChat Files\\wxid_xxx\\",
        "dataSavePath": "C:\\wechatDir\\WeChat Files\\",
        "dbKey": "965715e30e474da09250cb5aa047e3940ffa1c8f767c4263b132bb512933db49",
        "headImage": "https://wx.qlogo.cn/mmhead/ver_1/MiblV0loY0GILewQ4u2121",
        "mobile": "13949175447",
        "name": "xxx",
        "province": "Henan",
        "signature": "xxx",
        "wxid": "wxid_22222"
    },
    "msg": "success"
}

2.发送文本消息**

接口功能

发送文本消息

接口地址

/api/sendTextMsg

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
wxid true string 接收人wxid
msg true string 消息文本内容
返回字段
返回字段 字段类型 说明
code int 返回状态,不为0成功, 0失败
msg string 成功提示
data object null
接口示例

入参:

{
    "wxid": "filehelper",
    "msg": "1112222"
}

响应:

{"code":345686720,"msg":"success","data":null}

3.hook消息**

接口功能

hook接收文本消息图片消息群消息.该接口将hook的消息通过tcp回传给本地的端口。 enableHttp=1时使用urltimeout参数配置服务端的接收地址。请求为postContent-Type 为json。 enableHttp=0时使用ipport的tcp服务回传消息。

接口地址

/api/hookSyncMsg

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
port true string 本地服务端端口,用来接收消息内容
ip true string 服务端ip地址用来接收消息内容可以是任意ip,即tcp客户端连接的服务端的ip
url true string http的请求地址enableHttp=1时不能为空
timeout true string 超时时间单位ms
enableHttp true number 0/1 1.启用http 0.不启用http
返回字段
返回字段 字段类型 说明
code int 返回状态,0成功, 非0失败
data object null
msg string 成功提示
接口示例

入参:

{
    "port": "19099",
    "ip":"127.0.0.1",
    "url":"http://localhost:8080",
    "timeout":"3000",
    "enableHttp":"0"
}

响应:

{"code":0,"msg":"success","data":null}

4.取消hook消息**

接口功能

取消hook消息

接口地址

/api/unhookSyncMsg

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
返回字段
返回字段 字段类型 说明
code int 返回状态,0成功, 非0失败
data object null
msg string 成功提示
接口示例

入参:


响应:

{"code":0,"msg":"success","data":null}

5.好友列表**

接口功能

好友列表

接口地址

/api/getContactList

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
返回字段
返回字段 字段类型 说明
code int 返回状态,0成功, 非0失败
data object 好友信息
customAccount string 自定义账号
encryptName string 昵称
nickname string 昵称
pinyin string 简拼
pinyinAll string 全拼
reserved1 number 未知
reserved2 number 未知
type number 未知
verifyFlag number 未知
wxid string wxid
msg string 成功提示
接口示例

入参:


响应:

{
    "code": 1,
    "data": [
        {
           "customAccount": "",
            "encryptName": "v3_020b3826fd03010000000000e04128fddf4d90000000501ea9a3dba12f95f6b60a0536a1adb6b40fc4086288f46c0b89e6c4eb8062bb1661b4b6fbab708dc4f89d543d7ade135b2be74c14b9cfe3accef377b9@stranger",
            "nickname": "文件传输助手",
            "pinyin": "WJCSZS",
            "pinyinAll": "wenjianchuanshuzhushou",
            "reserved1": 1,
            "reserved2": 1,
            "type": 3,
            "verifyFlag": 0,
            "wxid": "filehelper"
        }
    ].
    "msg": "success"

6.获取数据库信息**

接口功能

获取数据库信息和句柄

接口地址

/api/getDBInfo

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
返回字段
返回字段 字段类型 说明
code int 返回状态,0成功, 非0失败
msg string 返回信息
data array 好友信息
databaseName string 数据库名称
handle number 句柄
tables array 表信息
name string 表名
rootpage string rootpage
sql string ddl语句
tableName string 表名
接口示例

入参:


响应:

{
    "code": 1,
    "data": [
        {
            "databaseName": "MicroMsg.db",
            "handle": 1755003930784,
            "tables": [
                {
                    "name": "Contact",
                    "rootpage": "2",
                    "sql": "CREATE TABLE Contact(UserName TEXT PRIMARY KEY ,Alias TEXT,EncryptUserName TEXT,DelFlag INTEGER DEFAULT 0,Type INTEGER DEFAULT 0,VerifyFlag INTEGER DEFAULT 0,Reserved1 INTEGER DEFAULT 0,Reserved2 INTEGER DEFAULT 0,Reserved3 TEXT,Reserved4 TEXT,Remark TEXT,NickName TEXT,LabelIDList TEXT,DomainList TEXT,ChatRoomType int,PYInitial TEXT,QuanPin TEXT,RemarkPYInitial TEXT,RemarkQuanPin TEXT,BigHeadImgUrl TEXT,SmallHeadImgUrl TEXT,HeadImgMd5 TEXT,ChatRoomNotify INTEGER DEFAULT 0,Reserved5 INTEGER DEFAULT 0,Reserved6 TEXT,Reserved7 TEXT,ExtraBuf BLOB,Reserved8 INTEGER DEFAULT 0,Reserved9 INTEGER DEFAULT 0,Reserved10 TEXT,Reserved11 TEXT)",
                    "tableName": "Contact"
                }
            ]
        }
    ],
    "msg":"success"
}

7.查询数据库**

接口功能

查询数据库

接口地址

/api/execSql

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
dbHandle true number
sql true string 执行的sql
返回字段
返回字段 字段类型 说明
code int 返回状态,0成功, 非0失败
msg string 返回信息
data array sqlite返回的结果
接口示例

入参:

{
    "dbHandle":2006119800400,
    "sql":"select * from MSG where localId =301;"
}

响应:

{
    "code": 1,
    "data": [
        [
            "localId",
            "TalkerId",
            "MsgSvrID",
            "Type",
            "SubType",
            "IsSender",
            "CreateTime",
            "Sequence",
            "StatusEx",
            "FlagEx",
            "Status",
            "MsgServerSeq",
            "MsgSequence",
            "StrTalker",
            "StrContent",
            "DisplayContent",
            "Reserved0",
            "Reserved1",
            "Reserved2",
            "Reserved3",
            "Reserved4",
            "Reserved5",
            "Reserved6",
            "CompressContent",
            "BytesExtra",
            "BytesTrans"
        ],
        [
            "301",
            "1",
            "8824834301214701891",
            "1",
            "0",
            "0",
            "1685401473",
            "1685401473000",
            "0",
            "0",
            "2",
            "1",
            "795781866",
            "wxid_123",
            "testtest",
            "",
            "0",
            "2",
            "",
            "",
            "",
            "",
            "",
            "",
            "CgQIEBAAGo0BCAcSiAE8bXNnc291cmNlPJPHNpZ25hdHVyZT52MV9wd12bTZyRzwvc2lnbmF0dXJPgoJPHRtcF9ub2RlPgoJCTxwsaXNoZXItaWQ+Jmx0OyFbQ0RBVEFbXV0mZ3Q7PC9wdWJsaXNoZXItaWQ+Cgk8L3RtcF9ub2RlPgo8L21zZ3NvdXJjZT4KGiQIAhIgNDE1MDA0NjRhZTRmMjk2NjhjMzY2ZjFkOTdmMjAwNDg=",
            ""
        ]
    ],
    "msg": "success"
}

8.发送文件消息**

接口功能

发送文件消息

接口地址

/api/sendFileMsg

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
wxid true string 接收人wxid
filePath true string 文件绝对路径
返回字段
返回字段 字段类型 说明
code int 返回状态,不为0成功, 0失败
msg string 成功提示
data object null
接口示例

入参:

{
    "wxid": "filehelper",
    "filePath": "c:\\test.zip"
}

响应:

{"code":345686720,"msg":"success","data":null}

9.获取群详情**

接口功能

获取群详情

接口地址

/api/getChatRoomDetailInfo

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
chatRoomId true string 群id
返回字段
返回字段 字段类型 说明
code int 返回状态,1成功, -1失败
msg string 成功提示
data object 群详细内容
chatRoomId string 群id
notice string 公告通知
admin string 群管理
xml string xml信息
接口示例

入参:

{
    "chatRoomId": "12222@chatroom"
}

响应:

{"code":345686720,"msg":"success","data":{
    "chatRoomId":"12222@chatroom",
    "notice":"test",
    "admin":"wxid_122333",
    "xml":"",
}}

10.添加群成员**

接口功能

获取群详情

接口地址

/api/addMemberToChatRoom

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
chatRoomId true string 群id
memberIds true string 成员id多个用,分隔
返回字段
返回字段 字段类型 说明
code int 返回状态,1成功,负数失败
msg string 成功提示
data object null
接口示例

入参:

{
    "chatRoomId":"21363231004@chatroom",
    "memberIds":"wxid_oyb662qhop4422"
}

响应:

{"code":1,"msg":"success","data":null}

11.修改群昵称**

接口功能

修改群昵称

接口地址

/api/modifyNickname

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
chatRoomId true string 群id
wxid true string 自己的wxid
nickName true string 昵称
返回字段
返回字段 字段类型 说明
code int 返回状态,1成功, -1失败
msg string 成功提示
data object null
接口示例

入参:


{
    "chatRoomId":"31004@chatroom",
    "wxid":"wxid_2721221512",
    "nickName":"1221"
}

响应:

{"code":1,"msg":"success","data":null}

12.删除群成员**

接口功能

删除群成员

接口地址

/api/delMemberFromChatRoom

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
chatRoomId true string 群id
memberIds true string 成员id,用,分隔
返回字段
返回字段 字段类型 说明
code int 返回状态,1成功, -1失败
msg string 成功提示
data object null
接口示例

入参:


{
    "chatRoomId":"1234@chatroom",
    "memberIds":"wxid_123"
}

响应:

{"code":1,"msg":"success","data":null}

13.获取群成员**

接口功能

获取群成员

接口地址

/api/getMemberFromChatRoom

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
chatRoomId true string 群id
返回字段
返回字段 字段类型 说明
code int 返回状态,1成功, -1失败
msg string 成功提示
data object null
chatRoomId string 群id
members string 成员id
memberNickname string 成员昵称
admin string 群管理
adminNickname string 管理昵称
接口示例

入参:


{
    "chatRoomId":"1234@chatroom"
}

响应:

{
    "code": 1,
    "data": {
        "admin": "wxid_2222",
        "adminNickname": "123",
        "chatRoomId": "22224@chatroom",
        "memberNickname": "^G123^G^G",
        "members": "wxid_2222^Gwxid_333"
    },
    "msg": "success"
}

14.置顶群消息**

接口功能

置顶群消息,需要群主权限

接口地址

/api/topMsg

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
msgId true string 消息id
返回字段
返回字段 字段类型 说明
code int 返回状态,1成功, -1失败
msg string 成功提示
data object null
接口示例

入参:



{
    "msgId":8005736725060623215
}

响应:

{
    "code": 1,
    "data": null,
    "msg": "success"
}

15.移除置顶群消息**

接口功能

移除置顶群消息,需要群主权限

接口地址

/api/removeTopMsg

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
msgId true string 消息id
chatRoomId true string 群id
返回字段
返回字段 字段类型 说明
code int 返回状态,1成功, -1失败
msg string 成功提示
data object null
接口示例

入参:



{
    "msgId":8005736725060623215,
     "chatRoomId":"12345678@chatroom"
}

响应:

{
    "code": 1,
    "data": null,
    "msg": "success"
}

16.邀请入群**

接口功能

邀请入群40人以上的群需要使用邀请入群

接口地址

/api/InviteMemberToChatRoom

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
memberIds true string wxid用,分隔
chatRoomId true string 群id
返回字段
返回字段 字段类型 说明
code int 返回状态,1成功, -1失败
msg string 成功提示
data object null
接口示例

入参:



{
    "memberIds":"wxid_123,wxid_12341",
     "chatRoomId":"12345678@chatroom"
}

响应:

{
    "code": 1,
    "data": null,
    "msg": "success"
}

17.hook日志**

接口功能

hook微信日志输出在wechat安装目录的logs目录下

接口地址

/api/hookLog

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
返回字段
返回字段 字段类型 说明
code int 返回状态,0成功, -1失败
msg string 成功提示
data object null
接口示例

入参:




响应:

{
    "code": 0,
    "data": null,
    "msg": "success"
}

18.取消hook日志**

接口功能

取消hook日志

接口地址

/api/unhookLog

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
返回字段
返回字段 字段类型 说明
code int 返回状态,0成功, -1失败
msg string 成功提示
data object null
接口示例

入参:



响应:

{
    "code": 0,
    "data": null,
    "msg": "success"
}

19.建群**

接口功能

建群(不建议使用,容易被封,测试期间被封了,无法保证效果)

接口地址

/api/createChatRoom

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
memberIds string 群成员id以,分割
返回字段
返回字段 字段类型 说明
code int 返回状态,0成功, -1失败
msg string 成功提示
data object null
接口示例

入参:



响应:

{
    "code": 1,
    "data": null,
    "msg": "success"
}

20.退群**

接口功能

退群

接口地址

/api/quitChatRoom

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
chatRoomId string 群id
返回字段
返回字段 字段类型 说明
code int 返回状态,大于0成功, -1失败
msg string 成功提示
data object null
接口示例

入参:

{
    "chatRoomId":"123456@chatroom"
}

响应:

{
    "code": 119536579329,
    "data": null,
    "msg": "success"
}

21.转发消息**

接口功能

转发消息

接口地址

/api/forwardMsg

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
wxid string 接收人id
msgId string 消息id
返回字段
返回字段 字段类型 说明
code int 返回状态,1成功, -1失败
msg string 成功提示
data object null
接口示例

入参:

{
    "wxid":"filehelper",
    "msgId":"1233312233123"
}

响应:

{
    "code": 1,
    "data": null,
    "msg": "success"
}

22.朋友圈首页**

接口功能

朋友圈首页,前置条件需先调用hook消息接口成功,具体内容会在hook消息里返回格式如下

{
    "data":[
        {
            "content": "",
            "createTime': 1691125287,
            "senderId': "",
            "snsId': 123,
            "xml':""
        }
    ]
}
接口地址

/api/getSNSFirstPage

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
返回字段
返回字段 字段类型 说明
code int 返回状态,1成功, -1失败
msg string 成功提示
data object null
接口示例

入参:



响应:

{
    "code": 1,
    "data": null,
    "msg": "success"
}

23.朋友圈下一页**

接口功能

朋友圈下一页

接口地址

/api/getSNSNextPage

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
snsId number snsId
返回字段
返回字段 字段类型 说明
code int 返回状态,1成功, -1失败
msg string 成功提示
data object null
接口示例

入参:

{

    "snsid":123
}

响应:

{
    "code": 1,
    "data": null,
    "msg": "success"
}

24.收藏消息**

接口功能

收藏消息

接口地址

/api/addFavFromMsg

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
msgId number 消息id
返回字段
返回字段 字段类型 说明
code int 返回状态,1成功, -1失败
msg string 成功提示
data object null
接口示例

入参:

{

    "msgId":123
}

响应:

{
    "code": 1,
    "data": null,
    "msg": "success"
}

24.收藏图片**

接口功能

收藏图片

接口地址

/api/addFavFromImage

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
wxid string wxid
imagePath string 图片地址
返回字段
返回字段 字段类型 说明
code int 返回状态,1成功, -1失败
msg string 成功提示
data object null
接口示例

入参:

{

    "wxid":"wxid_12333",
    "imagePath":"C:\\test\\test.png"
}

响应:

{
    "code": 1,
    "data": null,
    "msg": "success"
}

25.发送@消息**

接口功能

发送@消息

接口地址

/api/sendAtText

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
wxids string wxid字符串多个用,分隔,发送所有人传值"notify@all"
chatRoomId string 群id
msg string 消息内容
返回字段
返回字段 字段类型 说明
code int 返回状态,大于0成功, -1失败
msg string 成功提示
data object null
接口示例

入参:

{

    "wxids":"notify@all",
    "chatRoomId":"123@chatroom",
    "msg":"你们好啊"
    
}

响应:

{
    "code": 67316444768,
    "data": null,
    "msg": "success"
}

26.获取群成员信息**

接口功能

获取群成员基础信息

接口地址

/api/getContactProfile

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
wxid string wxid
返回字段
返回字段 字段类型 说明
code int 返回状态,大于0成功, -1失败
msg string 成功提示
data object null
account string 账号
headImage string 头像
nickname string 昵称
v3 string v3
wxid string wxid
接口示例

入参:


{
    "wxid":"wxid_123"
}

响应:

{
    "code": 1,
    "data": {
        "account": "account",
        "headImage": "https://wx.qlogo.cn/mmhead/ver_1/0",
        "nickname": "test",
        "v3": "wxid_123",
        "wxid": "wxid_123"
    },
    "msg": "success"
}