微信3.x HTTP接口文档

基础地址: http://127.0.0.1:19088

所有接口均为 POST 请求，参数以 JSON 格式传递。

---

消息相关

发送文本消息

POST /api/send_text_msg

参数	类型	必填	说明
wxid	string	是	接收人wxid
msg	string	是	消息内容

{"wxid": "filehelper", "msg": "Hello World!"}

发送文本消息(协议)

POST /api/send_text_pb

参数	类型	必填	说明
wxid	string	是	接收人wxid
msg	string	是	消息内容
type	string	是	消息类型

{"wxid": "filehelper", "msg": "你好啊", "type": "1"}

发送图片消息

POST /api/send_image_msg

参数	类型	必填	说明
wxid	string	是	接收人wxid
image_path	string	是	图片本地路径

{"wxid": "filehelper", "image_path": "c:\\1.jpg"}

发送文件

POST /api/send_file_msg

参数	类型	必填	说明
wxid	string	是	接收人wxid
full_path	string	是	文件完整路径

{"wxid": "filehelper", "full_path": "C:\\Users\\Desktop\\file.md"}

发送语音(协议)

POST /api/send_voice

参数	类型	必填	说明
toWxid	string	是	接收人wxid
silkPath	string	是	silk格式语音文件路径
seconds	string	是	语音时长（秒）

{"toWxid": "wxid_xxx", "silkPath": "D:\\output.silk", "seconds": "20"}

发送表情

POST /api/send_custom_emotion

参数	类型	必填	说明
wxid	string	是	接收人wxid
file_path	string	是	表情文件路径

{"wxid": "filehelper", "file_path": "D:\\1.gif"}

发送名片

POST /api/send_card_msg

参数	类型	必填	说明
towxid	string	是	接收人wxid
fromwxid	string	是	名片wxid

{"towxid": "filehelper", "fromwxid": "wxid_xxx"}

发送At消息

POST /api/send_at_text

参数	类型	必填	说明
room_id	string	是	群聊ID
msg	string	是	消息内容
wxids	string	是	被@人的wxid，notify@all表示@所有人

{"room_id": "50582745779@chatroom", "msg": "在干嘛呢", "wxids": "notify@all"}

发送引用消息

POST /api/send_quote_msg

参数	类型	必填	说明
wxid	string	是	接收人wxid或群聊ID
msgId	string	是	被引用的消息ID
msg	string	是	回复内容

{"wxid": "50582745779@chatroom", "msgId": "8292128004080533745", "msg": "回复内容"}

撤回消息

POST /api/revoke_msg

参数	类型	必填	说明
index_id	string	是	消息索引ID

{"index_id": "4796650063682630984"}

转发单条消息

POST /api/forward_single_msg

参数	类型	必填	说明
msgid	number	是	消息ID
wxid	string	是	转发目标wxid

{"msgid": 7123908525629997597, "wxid": "filehelper"}

---

个人信息

获取自己详细信息

POST /api/get_profile_cache

{}

登录

POST /api/login

{}

检查登录状态

POST /api/check_login

{}

刷新登录二维码

POST /api/reflash_qrcode

{}

修改昵称

POST /api/mod_self_nick_name

参数	类型	必填	说明
newName	string	是	新昵称

{"newName": "新昵称"}

---

好友管理

获取好友列表

POST /api/get_frien_lists

{}

获取好友详细信息(协议)

POST /api/net_scene_get_contact

参数	类型	必填	说明
wxids	string	是	wxid
roomId	string	否	群聊ID

{"wxids": "wxid_xxx", "roomId": ""}

获取好友详细信息(缓存)

POST /api/get_contact_cache

参数	类型	必填	说明
wxid	string	是	好友wxid

{"wxid": "wxid_xxx"}

网络搜索微信号

POST /api/net_scene_search_contact

参数	类型	必填	说明
search	string	是	搜索关键词

{"search": "13671934252"}

添加好友

POST /api/add_friend

参数	类型	必填	说明
wxid	string	是	wxid 或 v3
greet	string	是	验证消息
scence	string	是	场景值
role	string	是	朋友权限

{"wxid": "wxid_xxx", "greet": "你好啊", "scence": "30", "role": "0"}

通过好友

POST /api/accept_friend

参数	类型	必填	说明
v3	string	是	v3数据
v4	string	是	v4数据
scence	string	是	好友来源
role	string	是	朋友权限

{"v3": "v3", "v4": "v4", "scence": "好友来源", "role": "朋友权限"}

删除好友

POST /api/del_contact

参数	类型	必填	说明
wxid	string	是	好友wxid

{"wxid": "wxid_xxx"}

---

群聊管理

获取群聊列表

POST /api/get_room_lists

{}

获取群成员列表

POST /api/net_scene_get_member_from_chat_room

参数	类型	必填	说明
room_id	string	是	群聊ID

{"room_id": "5367651578@chatroom"}

创建群聊

POST /api/creat_chat_room

参数	类型	必填	说明
wxids	string	是	成员wxid，多个用逗号分隔

{"wxids": "wxid_xxx,wxid_yyy"}

设置群公告

POST /api/set_room_announcement

参数	类型	必填	说明
roomId	string	是	群聊ID
announcement	string	是	公告内容

{"roomId": "53324112125@chatroom", "announcement": "测试公告"}

修改群聊名称

POST /api/mod_chat_room_topic

参数	类型	必填	说明
topic	string	是	新群名称
room_id	string	是	群聊ID

{"topic": "新群名称", "room_id": "57317789416@chatroom"}

拉人进群

POST /api/add_member_to_chat_room

参数	类型	必填	说明
wxid_list	string	是	要拉入的wxid
room_id	string	是	群聊ID

{"wxid_list": "wxid_xxx", "room_id": "38994638667@chatroom"}

踢出群聊

POST /api/del_member_from_chat_room

参数	类型	必填	说明
wxid_list	string	是	要踢出的wxid
room_id	string	是	群聊ID

{"wxid_list": "wxid_xxx", "room_id": "群wxid"}

---

数据库操作

获取数据库句柄

POST /api/get_db_handle

{}

执行sql语句

POST /api/sqlite3_exec

参数	类型	必填	说明
dbHandle	string	是	数据库句柄
sql	string	是	SQL语句

{"dbHandle": "1622390499712", "sql": "select * from sqlite_master"}

---

朋友圈

发朋友圈

POST /api/sns_post

参数	类型	必填	说明
content	string	是	朋友圈文本内容
blackList	string	否	不可见名单
withauserList	string	否	可见名单

{"content": "这是我测试的朋友圈", "blackList": "", "withauserList": ""}

获取朋友圈首页

POST /api/sns_get_first_page

{}

点赞朋友圈

POST /api/sns_like

参数	类型	必填	说明
sns_id	string	是	朋友圈ID
wxid	string	是	自己的wxid

{"sns_id": "14417590059746931229", "wxid": "wxid_xxx"}

---

其他功能

CDN下载

POST /api/cdn_download

参数	类型	必填	说明
file_id	string	是	CDN文件ID
aes_key	string	是	AES解密密钥
save_path	string	是	文件保存路径

{"file_id": "[file_id]", "aes_key": "[aes_key]", "save_path": "D:\\file.jpg"}

解码图片

POST /api/decode_img

参数	类型	必填	说明
path	string	是	加密图片路径
save	string	是	解码后保存路径

{"path": "F:\\wechatflie\\xxx.dat", "save": "d:\\output.jpg"}

OCR识别

POST /api/ocr

参数	类型	必填	说明
wechatocr_exe_path	string	是	WeChatOCR路径
wechat_dir	string	是	微信安装目录
img_path	string	是	待识别图片路径

{
    "wechatocr_exe_path": "C:\\...\\WeChatOCR.exe",
    "wechat_dir": "D:\\WeChat\\[3.9.11.17]",
    "img_path": "C:\\image.png"
}

确认收款

POST /api/ten_pay_trans_fer_confirm

参数	类型	必填	说明
wxid	string	是	转账发送方wxid
transId	string	是	转账交易ID

{"wxid": "wxid_xxx", "transId": "1000050001202408161428438482833"}