wechat/wxhelper
5
0
Fork 0
mirror of https://github.com/ttttupup/wxhelper.git synced 2024-11-05 18:09:24 +08:00
Code Issues Packages Projects Releases Wiki Activity
5e04ddfcd2
wxhelper/doc/3.9.2.26.md

2010 lines
41 KiB
Markdown
Raw Normal View History

feat: 3.9.2.26发送文本，图片，文件
2023-05-11 00:04:46 +08:00
## 3.9.2.26版本，预览功能没有的接口，不能使用，文档仅供参考。
#### 功能预览：
feat: 部分偏移更新
2023-05-13 17:25:08 +08:00
0.检查是否登录
1.获取登录微信信息
feat: 3.9.2.26发送文本，图片，文件
2023-05-11 00:04:46 +08:00
2.发送文本
3.9.2.26部分功能
2023-05-23 12:01:43 +08:00
3.发送@文本
feat: 3.9.2.26发送文本，图片，文件
2023-05-11 00:04:46 +08:00
5.发送图片
6.发送文件
feat: 部分偏移更新
2023-05-13 17:25:08 +08:00
9.hook消息
10.取消hook消息
3.9.2.26部分功能
2023-05-23 12:01:43 +08:00
19.通过手机或qq查找微信
20.通过wxid添加好友
23.通过好友申请
feat: 部分偏移更新
2023-05-13 17:25:08 +08:00
25.获取群成员
26.获取群成员昵称
27.删除群成员
28.增加群成员
31.修改群昵称
32.获取数据库句柄
3.9.2.26部分功能
2023-05-23 12:01:43 +08:00
34.查询数据库
feat: 完善3.9.2.26已有的功能
2023-05-25 15:30:27 +08:00
35.hook日志
36.关闭hook日志
3.9.2.26部分功能
2023-05-23 12:01:43 +08:00
40.转发消息
44.退出登录
feat: 完善3.9.2.26已有的功能
2023-05-25 15:30:27 +08:00
46.联系人列表
47.获取群详情
48.获取解密图片
49.图片提取文字ocr
50.拍一拍
51.群消息置顶消息
52.群消息取消置顶
53.朋友圈首页
54.朋友圈下一页
55.获取联系人或者群名称
56.获取消息附件(图片，视频，文件)
feat: 根据502647092提供的偏移，新增登录二维码
2023-05-25 22:10:03 +08:00
57.获取消息语音文件
feat: 新增邀请入群
2023-05-27 00:18:11 +08:00
58.登录二维码
59.邀请入群
feat: 获取群成员详情
2023-05-27 11:27:39 +08:00
60.获取群/群成员详情
feat: 发送公众号文章消息
2023-05-31 14:58:07 +08:00
61.撤回消息
62.发送公众号消息
doc: update
2023-06-01 08:46:18 +08:00
63.转发公众号消息
feat: 发送小程序 close issue #158
2023-06-01 21:13:45 +08:00
64.发送小程序
feat: 头像
2023-06-02 14:28:25 +08:00
65.退款
66.下载头像
feat: 新增邀请入群
2023-05-27 00:18:11 +08:00
### 接口文档：
#### 0.检查微信登录**
###### 接口功能
> 检查微信是否登录
###### 接口地址
> [/api/?type=0](/api/?type=0)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1 成功, 0失败|
|result|string|成功提示|
|data|string|响应内容|
###### 接口示例
入参：
``` javascript
```
响应：
``` javascript
{
"code": 1,
"result": "ok"
}
```
#### 1.获取登录用户信息**
###### 接口功能
> 获取登录用户信息
###### 接口地址
> [/api/?type=1](/api/?type=1)
###### 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解密数据库
###### 接口示例
入参：
``` javascript
```
响应：
``` javascript
{"code":1,"data":{"account":"xx","headImage":"https://wx.qlogo.cn/mmhead/ver_1xx","city":"xx","country":"CN","currentDataPath":"C:\\xx\\wxid_xxxxx","dataSavePath":"C:\\xx","mobie":"13812345678","name":"xx","province":"xx","signature":"xx","wxid":"xx","dbKey":"aaa2222"},"result":"OK"}
```
#### 2.发送文本消息**
###### 接口功能
> 发送文本消息
###### 接口地址
> [/api/?type=2](/api/?type=2)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|wxid |true |string| 接收人wxid |
|msg|true |string|消息文本内容|
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,不为0成功, 0失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"wxid": "filehelper",
"msg": "1112222"
}
```
响应：
``` javascript
{"code":345686720,"result":"OK"}
```
#### 3.发送@文本消息**
###### 接口功能
> 发送@文本消息
###### 接口地址
> [/api/?type=3](/api/?type=3)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|chatRoomId |true |string| 群id |
|msg|true |string|消息文本内容|
|wxids |true |string| @的用户微信id用,号分隔， @所有人 传 notify@all ，区分大小写 |
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,不为0成功, 0失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"chatRoomId": "123333@chatroom",
"wxids":"notify@all,wxid_122221",
"msg": "12333"
}
```
响应：
``` javascript
{"code":345686720,"result":"OK"}
```
#### 5.发送图片消息**
###### 接口功能
> 发送图片消息
###### 接口地址
> [/api/?type=5](/api/?type=5)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|wxid |true |string| 接收人wxid |
|imagePath|true |string|图片路径|
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,不为0成功, 0失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"wxid": "filehelper",
"imagePath": "C:/Users/123.png"
}
```
响应：
``` javascript
{"code":345686724,"result":"OK"}
```
#### 6.发送文件消息**
###### 接口功能
> 发送文件
###### 接口地址
> [/api/?type=6](/api/?type=6)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|wxid |true |string| 接收人wxid |
|filePath|true |string|文件路径|
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, 0失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"wxid": "filehelper",
"filePath": "C:/Users/123.txt"
}
```
响应：
``` javascript
{"code":1,"result":"OK"}
```
#### 9.hook消息**
###### 接口功能
feat: hook消息增加http支持
2023-06-05 14:10:01 +08:00
> hook接收文本消息，图片消息，群消息.该接口将hook的消息通过tcp回传给本地的端口。
enableHttp=1时，使用url，timeout参数配置服务端的接收地址。请求为post，Content-Type 为json。
enableHttp=0时，使用ip，port的tcp服务回传消息。
feat: 新增邀请入群
2023-05-27 00:18:11 +08:00
###### 接口地址
> [/api/?type=9](/api/?type=9)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|port |true |string| 本地服务端端口，用来接收消息内容 |
doc: update
2023-06-08 09:27:14 +08:00
|ip |true |string| 服务端ip地址，用来接收消息内容，可以是任意ip,即tcp客户端连接的服务端的ip |
feat: hook消息增加http支持
2023-06-05 14:10:01 +08:00
|url |true |string| http的请求地址，enableHttp=1时，不能为空 |
|timeout |true |string| 超时时间，单位ms|
|enableHttp |true |number| 0/1 ：1.启用http 0.不启用http|
feat: 新增邀请入群
2023-05-27 00:18:11 +08:00
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, 0失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"port": "19099"
doc: update
2023-06-08 09:27:14 +08:00
"ip":"127.0.0.1"，
"url":"http://test.com",
"timeout":"3000",
"enableHttp":1,
feat: 新增邀请入群
2023-05-27 00:18:11 +08:00
}
```
响应：
``` javascript
{"code":1,"result":"OK"}
```
#### 10.取消hook消息**
###### 接口功能
> 取消hook消息
###### 接口地址
> [/api/?type=10](/api/?type=10)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, 0失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
```
响应：
``` javascript
{"code":1,"result":"OK"}
```
#### 11.hook图片**
###### 接口功能
> hook图片原始内容，不推荐该接口，可以使用图片查询接口
###### 接口地址
> [/api/?type=11](/api/?type=11)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|imgDir |true |string| 图片保存的目录 |
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, 0失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"imgDir":"C:\\other"
}
```
响应：
``` javascript
{"code":1,"result":"OK"}
```
#### 12.取消hook图片**
###### 接口功能
> 取消hook图片
###### 接口地址
> [/api/?type=12](/api/?type=12)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, 0失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
```
响应：
``` javascript
{"code":1,"result":"OK"}
```
#### 13.hook语音**
###### 接口功能
> hook语音
###### 接口地址
> [/api/?type=13](/api/?type=13)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|voiceDir |true |string| 语音保存的目录 |
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, 0失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"voiceDir":"C:\\other"
}
```
响应：
``` javascript
{"code":1,"result":"OK"}
```
#### 14.取消hook语音**
###### 接口功能
> 取消hook语音
###### 接口地址
> [/api/?type=14](/api/?type=14)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, 0失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
```
响应：
``` javascript
{"code":1,"result":"OK"}
```
#### 17.删除好友**
###### 接口功能
> 删除好友,该接口不够完善，删除后，只会在通讯录里删除，如果点击聊天记录，又会重新加回来，删除的不彻底。
###### 接口地址
> [/api/?type=17](/api/?type=17)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|wxid |true |string| 好友wxid |
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,0成功, -1失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"wxid":"wxid_o"
}
```
响应：
``` javascript
{"code":0,"result":"OK"}
```
#### 19.通过手机或qq查找微信**
###### 接口功能
> 通过手机或qq查找微信
###### 接口地址
> [/api/?type=19](/api/?type=19)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|keyword |true |string| 手机或qq |
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, -1失败|
|result|string|成功提示|
|userInfo|object|用户信息|
|  bigImage|string|大头像|
|  smallImage|string|小头像|
|  city|string|城市|
|  nation|string|民族|
|  nickname|string|昵称|
|  province|string|省|
|  sex|number|性别|
|  signature|string|签名|
|  v2|string|v2|
|  v3|string|v3|
###### 接口示例
入参：
``` javascript
{
"keyword":"131111111"
}
```
响应：
``` javascript
{
"code": 1,
"result": "OK",
"userInfo": {
"bigImage": "http://wx.qlogo.cn/mmhead/ver_1/7NIHQAyXeaAPa7Vd7p122mKxgETJwoAiaERdk1sSyOyfnLLQOfElw4G9I32QkZzh7bGfZr2lg0OIQE1Az3cUwtWaLUM79Q/0",
"city": "",
"nation": "",
"nickname": "昵称",
"province": "",
"sex": 0,
"signature": "",
"smallImage": "http://wx.qlogo.cn/mmhead/ver_1/7NIHQAyXeaAPa7Vd7p4KR3vxiasmKxgETJwoAiaER23QE6G5mLBcdBQkZzh7bGfZr2lg0OIQE1Az3cUwtWaLUM79Q/132",
"v2": "wxid_12333",
"v3": "v3_020b3826fd0301000000000098ca23832239a3dba12f95f6b60a0536a1adb6b40fc4086288f46c0b89e6c4eb70c34f118c7b4b6a6845144843b088f0077e406507f821068571289b36c4158a8ac47ec41ae47bee65e9@stranger"
}
}
```
#### 20.通过wxid添加好友**
###### 接口功能
> 添加好友
###### 接口地址
> [/api/?type=20](/api/?type=20)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|wxid |true |string| 好友wxid |
|msg |true |string| 验证消息 |
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, -1失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"wxid":"wxid_o1112222"
}
```
响应：
``` javascript
{"code":1,"result":"OK"}
```
#### 23.通过好友申请**
###### 接口功能
> 通过好友的申请
###### 接口地址
> [/api/?type=23](/api/?type=23)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|v3 |true |string| 添加好友消息内容里的encryptusername|
|v4 |true |string| 添加好友消息内容里的ticket|
|permission |true |number| 好友权限，0.全部 8.仅聊天。（好友超过5000人后，会验证权限，传8即可）|
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, -1失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"wxid":"wxid_o1112222"
}
```
响应：
``` javascript
{"code":1,"result":"OK"}
```
#### 25.获取群成员**
###### 接口功能
> 获取群成员
###### 接口地址
> [/api/?type=25](/api/?type=25)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|chatRoomId |true |string| 群id |
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, 0失败|
|result|string|成功提示|
|data|object|返回内容|
|admin|string|群主id|
|chatRoomId|string|群id|
|members|string|群成员id以^分隔|
###### 接口示例
入参：
``` javascript
{
"chatRoomId":"123@chatroom"
}
```
响应：
``` javascript
{"code":1,"data":{"admin":"wxid","chatRoomId":"123@chatroom","members":"wxid_123^Gwxid_456^Gwxid_45677"},"result":"OK"}
```
#### 26.获取群成员昵称**
###### 接口功能
> 获取群成员群内昵称
###### 接口地址
> [/api/?type=26](/api/?type=26)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|chatRoomId |true |string| 群id |
|memberId |true |string| 群成员id |
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, 0失败|
|result|string|成功提示|
|nickname|string|昵称|
###### 接口示例
入参：
``` javascript
{
"chatRoomId":"123@chatroom",
"memberId":"wxid_123"
}
```
响应：
``` javascript
{"code":1,"nickname":"昵称","result":"OK"}
```
#### 27.删除群成员**
###### 接口功能
> 删除群成员
###### 接口地址
> [/api/?type=27](/api/?type=27)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|chatRoomId |true |string| 群id |
|memberIds |true |string| 成员id，以,分割 |
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, 0失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"chatRoomId":"34932563384@chatroom",
"memberIds":"wxid_oyb662qhop4422"
}
```
响应：
``` javascript
{"code":1,"result":"OK"}
```
#### 28.增加群成员**
###### 接口功能
> 增加群成员
###### 接口地址
> [/api/?type=28](/api/?type=28)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|chatRoomId |true |string| 群id |
|memberIds |true |string| 成员id，以,分割 |
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, 0失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"chatRoomId":"34932563384@chatroom",
"memberIds":"wxid_oyb662qhop4422"
}
```
响应：
``` javascript
{"code":1,"result":"OK"}
```
#### 31.修改自身群昵称**
###### 接口功能
> 修改群名片
###### 接口地址
> [/api/?type=31](/api/?type=31)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|chatRoomId |true |string| 群id |
|wxid |true |string| 自己的id，只能修改自己的群名片 |
|nickName |true |string| 修改的昵称 |
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, 0失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"chatRoomId":"34932563384@chatroom",
"wxid":"wxid_272211111121112",
"nickName":"昵称test"
}
```
响应：
``` javascript
{"code":1,"result":"OK"}
```
#### 32.获取数据库句柄**
###### 接口功能
> 获取sqlite3数据库句柄
###### 接口地址
> [/api/?type=32](/api/?type=32)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, 0失败|
|result|string|成功提示|
|data|array|返回数据|
|databaseName|string|数据库名称|
|handle|int|数据库句柄|
|tables|array|表信息|
|name|string|表名|
|rootpage|string|rootpage|
|sql|string|sql|
|tableName|string|tableName|
###### 接口示例
入参：
``` javascript
```
响应：
``` javascript
{
"data": [
{
"databaseName": "MicroMsg.db",
"handle": 119561688,
"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"
}
]
}
],
"result": "OK"
}
```
#### 34.查询数据库**
###### 接口功能
> 查询数据库
###### 接口地址
> [/api/?type=34](/api/?type=34)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|dbHandle |true |int| 句柄 |
|sql |true |string| sql语句 |
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, 0失败|
|result|string|成功提示|
|data|array|返回数据|
###### 接口示例
入参：
``` javascript
{
"dbHandle": 219277920,
"sql":"select * from MSG where MsgSvrID=8985035417589024392"
}
```
响应：
``` javascript
{"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"],["6346","24","8985035417589024392","1","0","0","1670897832","1670897832000","0","0","2","1","778715089","wxid_1222","112","","0","2","","","","","","","CgQIEBAAGkEIBxI9PG1zZ3NvdXJjZT4KCTxzaWduYXR1cmU+djFfSFFyeVAwZTE8L3NpZ25hdHVyZT4KPC9tc2dzb3VyY2U+ChokCAISIDU5NjI1NjUxNWE0YzU2ZDQxZDJlOWMyYmIxMjFhNmZl",""]],"result":"OK"}
```
#### 35.hook日志**
###### 接口功能
> hook微信日志，在控制台打印日志，方便调试
###### 接口地址
> [/api/?type=35](/api/?type=35)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, 0失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
```
响应：
``` javascript
{"code":1,"result":"OK"}
```
#### 36.取消hook日志**
###### 接口功能
> 取消hook日志
###### 接口地址
> [/api/?type=36](/api/?type=36)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, 0失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
```
响应：
``` javascript
{"code":1,"result":"OK"}
```
#### 40.转发消息**
###### 接口功能
> 直接转发消息
###### 接口地址
> [/api/?type=40](/api/?type=40)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|wxid |true |string| 消息接收人wxid |
|msgid |true |number| 消息id，hook消息接口中返回的消息id |
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,非0成功|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"wxid": "filehelper",
"msgid":7215505498606506901
}
```
响应：
``` javascript
{"code":4344,"result":"OK"}
```
#### 44.退出登录**
###### 接口功能
> 退出登录微信，相当于直接退出微信，跟手动退出比，少了重新打开登录的一步，dll注入后也会随微信关闭而关闭。调用后不能再继续操作dll。
###### 接口地址
> [/api/?type=44](/api/?type=44)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,非0成功|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
```
响应：
``` javascript
{"code":4344,"result":"OK"}
```
#### 45.确认收款**
###### 接口功能
> 收到转账消息后，自动收款确认。type=49 即是转账消息。
###### 接口地址
> [/api/?type=45](/api/?type=45)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|wxid|string|转账人微信id，从hook的消息中获取|
|transcationId|string|从hook的消息中获取对应的字段内容。|
|transferId|string|从hook的消息中获取对应的字段内容。|
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"wxid":"wxid_agz5q76f11112",
"transcationId":"10000500012302060002831233124719620",
"transferId":"10000500012023020619112332136412"
}
```
响应：
``` javascript
{"code":1,"result":"OK"}
```
#### 46.联系人列表**
###### 接口功能
> 联系人列表
###### 接口地址
> [/api/?type=46](/api/?type=46)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, 0失败|
|result|string|成功提示|
|data|array|返回内容|
|customAccount|string|自定义账号|
|delFlag|int|删除标志|
|type|int|好友类型|
|userName|string|用户名称|
|verifyFlag|int|验证|
|wxid|string|wxid|
###### 接口示例
入参：
``` javascript
{
"wxid": "filehelper",
"msgid":7215505498606506901
}
```
响应：
``` javascript
{"code":1,"data":[{"customAccount":"custom","delFlag":0,"type":8388611,"userName":"昵称","verifyFlag":0,"wxid":"wxid_123pcqm22"}]}
```
#### 47.群详情**
###### 接口功能
> 获取群详情
###### 接口地址
> [/api/?type=47](/api/?type=47)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|chatRoomId |true |string| 群id |
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, 0失败|
|result|string|成功提示|
|data|object|返回内容|
|admin|string|群主id|
|chatRoomId|int|群id|
|notice|int|通知|
|xml|string|xml|
###### 接口示例
入参：
``` javascript
{
"wxid": "filehelper",
"msgid":7215505498606506901
}
```
响应：
``` javascript
{"code":1,"data":{"admin":"123","chatRoomId":"123@chatroom","notice":"1222","xml":""},"result":"OK"}
```
#### 48.获取解密图片**
###### 接口功能
> 获取解密图片
###### 接口地址
> [/api/?type=48](/api/?type=48)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|imagePath |true |string| 图片路径 |
|savePath |true |string| 保存路径 |
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, 0失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"imagePath":"C:\\3a610d7bc1cf5a15d12225a64b8962.dat",
"savePath":"C:\\other"
}
```
响应：
``` javascript
{"code":1,"result":"OK"}
```
#### 49.提取文字**
###### 接口功能
> 提取图片中的文字
###### 接口地址
> [/api/?type=49](/api/?type=49)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|imagePath |true |string| 图片路径 |
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,0成功, -1失败，1 2 则是缓存或者正在进行中需再调用一次|
|result|string|成功提示|
|text|string|提取的相应文字|
#### 50.拍一拍**
###### 接口功能
> 群里拍一拍用户
###### 接口地址
> [/api/?type=50](/api/?type=50)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|chatRoomId |true |string| 微信群聊id |
|wxid |true |string| 要拍的用户wxid，如果使用用户自定义的微信号，则不会显示群内昵称 |
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, -1失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"chatRoomId":"123331@chatroom",
"wxid":"wxid_123456"
}
```
响应：
``` javascript
{"code":1,"result":"OK"}
```
#### 51.群内消息置顶**
###### 接口功能
> 在群聊里置顶某条消息,可以置顶文字和图片消息，其他消息未测试，部分低版本移动端置顶消息点击后会直接取消，高版本会一直置顶，其他未测试。
###### 接口地址
> [/api/?type=51](/api/?type=51)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|wxid |true |string| 置顶消息的发送人wxid |
|msgid |true |string| 消息id |
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,0成功, -1失败，-2 未查到该消息|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"wxid":"wxid_oy11111p4422",
"msgid":3334956046278903121
}
```
响应：
``` javascript
{"code":0,"result":"OK"}
```
#### 52.取消群内消息置顶**
###### 接口功能
> 取消置顶的消息。部分低版本移动端会不显示移除消息，但是会正常移除。
###### 接口地址
> [/api/?type=52](/api/?type=52)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|chatRoomId |true |string| 微信群聊id |
|msgid |true |string| 消息id |
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,0成功, -1失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"chatRoomId":"2136311004@chatroom",
"msgid":3374951233278903120
}
```
响应：
``` javascript
{"code":0,"result":"OK"}
```
#### 53.朋友圈首页消息**
###### 接口功能
> 获取朋友圈最新消息，调用之后，会在tcpserver服务中收到朋友圈的消息。格式如下：
``` javascript
{
'data': [
{
'content': '朋友圈[玫瑰][玫瑰]',
'createTime': 1675827480,
'senderId': 'wxid_12333',
'snsId': 14057859804711563695,
'xml': '<TimelineObject><id><![CDATA[1405712322563695]]></id><username><![CDATA[wxid_12333]]></username><createTime><![CDATA[1675827480]]></createTime><contentDescShowType>0</contentDescShowType><contentDescScene>0</contentDescScene><private><![CDATA[0]]></private><contentDesc><![CDATA[朋友圈[玫瑰][玫瑰]]]></contentDesc><contentattr><![CDATA[0]]></contentattr><sourceUserName></sourceUserName><sourceNickName></sourceNickName><statisticsData></statisticsData><weappInfo><appUserName></appUserName><pagePath></pagePath><version><![CDATA[0]]></version><debugMode><![CDATA[0]]></debugMode><shareActionId></shareActionId><isGame><![CDATA[0]]></isGame><messageExtraData></messageExtraData><subType><![CDATA[0]]></subType><preloadResources></preloadResources></weappInfo><canvasInfoXml></canvasInfoXml><ContentObject><contentStyle><![CDATA[2]]></contentStyle><contentSubStyle><![CDATA[0]]></contentSubStyle><title></title><description></description><contentUrl></contentUrl></ContentObject><actionInfo><appMsg><mediaTagName></mediaTagName><messageExt></messageExt><messageAction></messageAction></appMsg></actionInfo><appInfo><id></id></appInfo><location poiClassifyId="" poiName="" poiAddress="" poiClassifyType="0" city=""></location><publicUserName></publicUserName><streamvideo><streamvideourl></streamvideourl><streamvideothumburl></streamvideothumburl><streamvideoweburl></streamvideoweburl></streamvideo></TimelineObject>'
}]
}
```
###### 接口地址
> [/api/?type=53](/api/?type=53)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, -1失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
```
响应：
``` javascript
{"code":1,"result":"OK"}
```
#### 54.朋友圈下一页**
###### 接口功能
> 朋友圈下一页，会在tcpserver服务中收到朋友圈的消息。格式如下：
``` javascript
{
'data': [
{
'content': '朋友圈[玫瑰][玫瑰]',
'createTime': 1675827480,
'senderId': 'wxid_12333',
'snsId': 14057859804711563695,
'xml': '<TimelineObject><id><![CDATA[1405712322563695]]></id><username><![CDATA[wxid_12333]]></username><createTime><![CDATA[1675827480]]></createTime><contentDescShowType>0</contentDescShowType><contentDescScene>0</contentDescScene><private><![CDATA[0]]></private><contentDesc><![CDATA[朋友圈[玫瑰][玫瑰]]]></contentDesc><contentattr><![CDATA[0]]></contentattr><sourceUserName></sourceUserName><sourceNickName></sourceNickName><statisticsData></statisticsData><weappInfo><appUserName></appUserName><pagePath></pagePath><version><![CDATA[0]]></version><debugMode><![CDATA[0]]></debugMode><shareActionId></shareActionId><isGame><![CDATA[0]]></isGame><messageExtraData></messageExtraData><subType><![CDATA[0]]></subType><preloadResources></preloadResources></weappInfo><canvasInfoXml></canvasInfoXml><ContentObject><contentStyle><![CDATA[2]]></contentStyle><contentSubStyle><![CDATA[0]]></contentSubStyle><title></title><description></description><contentUrl></contentUrl></ContentObject><actionInfo><appMsg><mediaTagName></mediaTagName><messageExt></messageExt><messageAction></messageAction></appMsg></actionInfo><appInfo><id></id></appInfo><location poiClassifyId="" poiName="" poiAddress="" poiClassifyType="0" city=""></location><publicUserName></publicUserName><streamvideo><streamvideourl></streamvideourl><streamvideothumburl></streamvideothumburl><streamvideoweburl></streamvideoweburl></streamvideo></TimelineObject>'
}]
}
```
###### 接口地址
> [/api/?type=54](/api/?type=54)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|snsId |true |string| 朋友圈的snsId |
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, -1失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"snsId":"14056334227327177401"
}
```
响应：
``` javascript
{"code":1,"result":"OK"}
```
#### 55.获取联系人或者群名称**
###### 接口功能
> 根据wxid，获取联系人微信名称，传入群id获取群名称，传入群内非好友获取的是微信名称不是群内昵称。
###### 接口地址
> [/api/?type=55](/api/?type=55)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|id |true |string| wxid或者群id |
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, -1失败|
|result|string|成功提示|
|name|string|名称|
###### 接口示例
入参：
``` javascript
{
"id":"wxid_123"
}
```
响应：
``` javascript
{"code":1,"name":"文件助手","result":"OK"}
```
#### 56.获取消息附件**
###### 接口功能
> 根据消息id,下载消息附件（图片，视频，文件）
###### 接口地址
> [/api/?type=56](/api/?type=56)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|msgId |true |string| 消息id |
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,0成功, 非0失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"msgId": 3224560917391784099
}
```
响应：
``` javascript
{"code":0,"result":"OK"}
```
#### 57.获取语音文件**
###### 接口功能
> 根据消息id，获取该语音消息的语音文件，文件为silk3格式，可以自行转换mp3.
###### 接口地址
> [/api/?type=57](/api/?type=57)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|msgId |true |string| 消息id |
|voiceDir |true |string| 语音文件保存的目录，文件名称为 (msgid).amr |
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, 非0失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"msgId": 3224560917391784099,
"voiceDir" : "c:\\voice"
}
```
响应：
``` javascript
{"code":1,"result":"OK"}
```
#### 58.登录url**
###### 接口功能
> 登录的url，生成二维码即可扫描登录
###### 接口地址
> [/api/?type=58](/api/?type=58)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, 非0失败|
|result|string|成功提示|
|url|string|登录url|
###### 接口示例
入参：
``` javascript
```
响应：
``` javascript
{"code":1,"result":"OK"，"url":"https://weixin.qq.com/x/qqqqxxxxxx"}
```
#### 59.邀请入群**
###### 接口功能
> 邀请入群
###### 接口地址
> [/api/?type=58](/api/?type=58)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|chatRoomId|string|群id|
|memberIds|string|成员id，以,分隔|
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, 非0失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"chatRoomId":"1111@chatroom",
"memberIds":"wxid_1111"
}
```
响应：
``` javascript
{"code":1,"result":"OK"}
feat: 获取群成员详情
2023-05-27 11:27:39 +08:00
```
#### 60.群/群成员详情**
###### 接口功能
> 邀请入群
###### 接口地址
> [/api/?type=60](/api/?type=60)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|wxid|string|wxid|
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, 非0失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"wxid":"wxid_8888"
}
```
响应：
``` javascript
{
"account": "lllla",
"code": 1,
"headImage": "",
"nickname": "昵称",
"result": "OK",
"v3": "v3_020b3sssd031xxxxx05@stranger",
"wxid": "wxid_888888"
}
doc: 撤回消息文档
2023-05-29 22:59:56 +08:00
```
#### 61.撤回消息**
###### 接口功能
> 撤回消息，有时间限制。
###### 接口地址
doc: update
2023-06-01 08:46:18 +08:00
> [/api/?type=61](/api/?type=61)
doc: 撤回消息文档
2023-05-29 22:59:56 +08:00
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|msgId|string|消息id|
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, 非0失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"msgId":45645454654654874548888
}
```
响应：
``` javascript
{"code":1,"result":"OK"}
feat: 发送公众号文章消息
2023-05-31 14:58:07 +08:00
```
#### 62.发送公众号消息**
###### 接口功能
> 公众号文章分享/转发的功能
###### 接口地址
doc: update
2023-06-01 08:46:18 +08:00
> [/api/?type=62](/api/?type=62)
feat: 发送公众号文章消息
2023-05-31 14:58:07 +08:00
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|appname|string|消息xml中的appname|
|username|string|消息xml中的username|
|title|string|消息xml中的title，文章的title|
|url|string|消息xml中的url，文章的uerl|
|thumburl|string|消息xml中的thumburl，缩略图|
|digest|string|消息xml中的digest|
|wxid|string|接收人wxid|
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, 非0失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"appname": "电手",
"username": "gh_271633b4f577",
"title": "PC硬件、数码产品彻底反转，搞机佬春天回来了",
"url": "http://mp.weixin.qq.com/s?__biz=Mzg3MzY2MjgxMg==&mid=2247712540&idx=1&sn=bd8e8b0d9f2753f3c34a2bfc01770510&chksm=ced16f2ff9a6e639cc9bb76631ff03487f86486f0f29fcf9f8bed754354cb20eda31cc894a56&scene=0&xtrack=1#rd",
"thumburl": "https://mmbiz.qpic.cn/sz_mmbiz_jpg/tpzwaqMCicQyEkBtLgibrKXVKD5gGUEtL00rJ2pxmpmmP9KgoBHiciamYhqZ0ff4kNlnPpnATqozxgRq4AtEzibo4iaw/640?wxtype=jpeg&wxfrom=0",
"digest": "这谁顶得住？",
"wxid": "filehelper"
}
doc: update
2023-06-01 08:46:18 +08:00
```
响应：
``` javascript
{"code":0,"result":"OK"}
```
#### 63.转发公众号消息**
###### 接口功能
> 转发收到的公众号的文章
###### 接口地址
> [/api/?type=63](/api/?type=63)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|msgId|string|收到的消息msgId,type=49|
|wxid|string|接收人wxid|
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, 非0失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"msgId": "123456456456",
"wxid": "filehelper"
}
feat: 发送公众号文章消息
2023-05-31 14:58:07 +08:00
```
响应：
``` javascript
{"code":0,"result":"OK"}
feat: 发送小程序 close issue #158
2023-06-01 21:13:45 +08:00
```
#### 64.发送小程序**
###### 接口功能
> 发送小程序（该接口不是很完善，调用多了就提示操作过于频繁，可稍后再试。有兴趣的可以完善一下）
###### 接口地址
> [/api/?type=64](/api/?type=64)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|appletId|string|小程序id|
|wxid|string|接收人wxid|
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功, 0失败|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"appletId": "wa11223212",
"wxid": "filehelper"
}
feat: 退款
2023-06-01 22:02:56 +08:00
```
响应：
``` javascript
{"code":1,"result":"OK"}
```
doc: update doc
2023-06-01 22:06:56 +08:00
#### 65.退款**
feat: 退款
2023-06-01 22:02:56 +08:00
###### 接口功能
> 收到转账消息后，自动退款。type=49 即是转账消息。
###### 接口地址
feat: 头像
2023-06-02 14:28:25 +08:00
> [/api/?type=65](/api/?type=65)
feat: 退款
2023-06-01 22:02:56 +08:00
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|wxid|string|转账人微信id，从hook的消息中获取|
|transcationId|string|从hook的消息中获取对应的字段内容。|
|transferId|string|从hook的消息中获取对应的字段内容。|
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"wxid":"wxid_agz5q76f11112",
"transcationId":"10000500012302060002831233124719620",
"transferId":"10000500012023020619112332136412"
}
feat: 发送小程序 close issue #158
2023-06-01 21:13:45 +08:00
```
响应：
``` javascript
{"code":1,"result":"OK"}
feat: 头像
2023-06-02 14:28:25 +08:00
```
#### 66.查询或下载头像**
###### 接口功能
> 暂时没用的功能
###### 接口地址
> [/api/?type=66](/api/?type=66)
###### HTTP请求方式
> POST JSON
###### 请求参数
|参数|必选|类型|说明|
|---|---|---|---|
|wxid|string|微信id|
|imageUrl|string|头像地址|
###### 返回字段
|返回字段|字段类型|说明 |
|---|---|---|
|code|int|返回状态,1成功|
|result|string|成功提示|
###### 接口示例
入参：
``` javascript
{
"wxid":"wxid_agz5q76f11112",
"imageUrl":""
}
```
响应：
``` javascript
{"code":1,"result":"OK"}
feat: 新增邀请入群
2023-05-27 00:18:11 +08:00
```
Reference in New Issue Copy Permalink