WeChat3 接口（3.x 版本）

支持版本：3.9.12.51

初始化

from pywechat_libencode import WeChat3

bot = WeChat3(version="3.9.12.51")

登录相关

接口	方法
登录	login()
检查登录状态	check_login()
刷新登录二维码	refresh_qrcode()

个人信息

接口	方法
获取自己详细信息(缓存)	get_self_info()
获取在线信息	get_online_info()
获取连接信息	get_connect_info()
获取mmtls短链接	get_short_link()
获取个人二维码	get_self_qrcode(wxid, style, opcode, info)
修改昵称	modify_self_nickname(nickname)
修改个性签名	modify_self_signature(signature)
修改头像	modify_self_headimg(file)
修改微信号	modify_self_alias(new_alias)
获取收款码	get_collection_code()
获取自定义收款码	get_custom_collection_code(money, description)
获取服务器信息	get_server_info()

发送消息

接口	方法
发送文本消息	send_text(to_wxid, content)
发送文本消息(协议)	send_text_pb(to_wxid, content, msg_type)
Cdn发送文本消息	send_text_cdn(to_wxid, content)
发送图片消息	send_image(to_wxid, file)
Cdn发送图片消息	send_cdn_image(to_wxid, file_id, aes_key, ...)
发送文件	send_file(to_wxid, file)
发送语音(silk格式)	send_voice(to_wxid, silk_path, seconds)
发送表情	send_emotion(to_wxid, file)
发送名片	send_card(to_wxid, card_wxid)
发送群@消息	send_room_at(room_wxid, content, at_wxids)
发送群@消息(协议)	send_room_at_pb(room_wxid, content, at_wxids, msg_type)
发送自定义卡片消息	send_xml(to_wxid, content, msg_type)
发送xml消息	send_xml_msg(to_wxid, img_url, link, content, title, self_wxid)
发送位置信息	send_location(to_wxid, xml_content)
发送引用消息	send_quote(to_wxid, msg_id, content)
转发单条消息	forward_single_msg(to_wxid, msg_id)
合并转发	forward_merge_msg(to_wxids, msg_ids)
撤回消息	revoke_msg(index_id)
获取本地消息ID	get_local_id_by_msg_id(msg_id)

发送文本示例

bot.send_text(to_wxid="filehelper", content="Hello World!")

发送群@消息示例

bot.send_room_at(
    room_wxid="50582745779@chatroom",
    content="在干嘛呢",
    at_wxids=["notify@all"]  # @所有人
)

好友相关

接口	方法
获取好友列表	get_contacts()
获取好友列表(含完整头像)	get_contacts_v2()
初始化联系人列表	init_contacts()
获取好友详细信息(协议)	get_contact(wxid)
获取好友详细信息(缓存)	get_contact_cache(wxid)
wxid取昵称	get_contact_nickname(wxid)
网络搜索微信号	search_friend(search)
搜索通讯录(协议)	search_contact_pb(search)
添加好友	add_friend(wxid, greet, scene, role)
添加好友(协议)	add_friend_pb(wxid_or_v3, v4, verify_content, scene, op_code)
添加企业微信好友	add_im_friend(wxid)
通过好友验证	accept_friend(v3, v4, scene, role)
删除好友	delete_contact(wxid)
修改备注	remark_contact(wxid, remark)
检测好友状态	check_friend(wxid)
僵尸粉检测	zombie_test(wxid)
僵尸粉检测方法二	check_zombie_new(wxids, room_id, op_code, content, add_type)
星标好友	set_star(wxid)
拉黑好友	set_black(wxid)
取消拉黑	remove_black(wxid)
设置朋友权限	set_friend_role(wxids, role)
设置好友验证开关	set_verify_func(func_id, switch)

标签相关

接口	方法
获取标签列表	get_labels()
添加标签	add_label(label_name)
删除标签	delete_label(label_id)
修改好友标签	modify_contact_label(wxids, label_list)

群聊相关

接口	方法
创建群聊	create_room(wxids)
获取群聊列表	get_rooms()
获取群聊列表详细信息	get_rooms_info()
获取群公告/群信息	get_room_info(room_wxid)
获取群聊二维码	get_room_qrcode(room_wxid, style, opcode, info)
获取群成员列表详细	get_room_members(room_wxid)
设置群公告	set_room_announcement(room_wxid, announcement)
修改群聊名称	modify_room_name(room_wxid, name)
修改自己群昵称	modify_room_self_nickname(room_wxid, nickname, self_wxid)
修改群聊备注	modify_room_remark(room_wxid, remark)
拉人进群(40人以内)	add_room_members(room_wxid, wxid_list)
邀请进群(40人以上)	invite_room_members(room_wxid, wxid_list)
踢出群聊	remove_room_member(room_wxid, wxid_list)
转让群主	transfer_room(room_wxid, to_wxid)

聊天管理

接口	方法
置顶好友	set_top(wxid, chose)
删除聊天	del_session(wxid)
微信设置	wechat_set(flg, open_val)

转账/红包

接口	方法
确认收款	confirm_transfer(wxid, transfer_id)
退还转账	refund_transfer(wxid, transfer_id)

朋友圈

接口	方法
发朋友圈	sns_post(content, black_list, with_auser_list)
朋友圈上传图片	sns_upload(file)
获取朋友圈首页	sns_get_first_page()
获取指定人朋友圈	sns_get_user_page(wxid, first_page_md5, max_id)
获取朋友圈下一页	sns_get_next_page(sns_id)
获取朋友圈详情	sns_get_detail(sns_id)
点赞朋友圈	sns_like(sns_id, wxid)
取消点赞	sns_unlike(sns_id)
评论朋友圈	sns_comment(sns_id, comment)
删除朋友圈评论	sns_delete_comment(sns_id, comment_id)

A8Key/小程序

接口	方法
获取a8key	get_a8key(url, wxid, scene)
获取a8key(群邀请)	get_a8key_invite(url, wxid, scene, code_type, code_version)
获取a8key(公众号)	get_a8key_biz(url, wxid, scene)
获取小程序code	get_mini_app_code(app_id)
获取小程序分享链接	get_mini_app_short_link(app_id)
获取小程序列表	get_applet()
小程序云函数	js_operate(wa_id, func, scene)
小程序链接获取信息	tag_to_wa_id(query)

公众号

接口	方法
获取公众号文章	get_biz_profile(biz_username)
获取公众号信息	get_biz_info(biz_id)

扫一扫

接口	方法
扫一扫获取v3	scan_qrcode(url)
扫一扫获取企业微信名片url	scan_wxwork_qrcode(url)

数据库

接口	方法
获取数据库句柄	get_db_handle()
执行sql语句	exec_sql(db_handle, sql)
备份数据库	backup_db(db_handle, save_path)

下载/解码

接口	方法
CDN下载	cdn_download(file_id, aes_key, save_path)
解码图片	decode_image(file_path, save_path)
自动下载图片/hook消息	hook_old_msg()
语音转文本	voice_to_text(msg_id)

OCR

接口	方法
OCR识别	ocr(wechat_ocr_exe, wechat_dir, img_path)

CDN信息

接口	方法
获取CdnDns列表	get_cdn_ip()
获取Cdn信息	get_cdn_info()

Hook/调试

接口	方法
hook日志	hook_log()
卸载日志hook	unhook_log()
Pb数据调试	pb_debug()
关闭pb调试	close_pb_debug()
自定义协议发包	send_pb(cgi, pb_data)