WeChatPYAPI介绍

社区版跟专业版的区别?

使用教程

疑问解答、联系方式

学习 & 参考

help(WeChatPYApi)

class WeChatPYApi(builtins.object)
 | WeChatPYApi(msg_callback, **kwargs)
 | 
 | 基于PC微信的Python-API
 | 
 | Methods defined here:
 | 
 | __init__(self, msg_callback, **kwargs)
 | 初始化方法
 | :param msg_callback: 消息回调函数
 | :param exit_callback: 退出微信后的回调函数
 | :param logger: 日志器句柄
 | :param kwargs: 略
 | 
 | add_friend_by_chat_room(self, chat_room_id, wx_id, msg)
 | 添加好友【群成员】
 | :param chat_room_id: 群ID
 | :param wx_id: 微信ID
 | :param msg: 添加时的打招呼消息
 | :return: 无
 | 
 | add_friend_by_net(self, v3, v4, msg)
 | 添加好友【网络查询】
 | :param v3: v3数据(消息推送中获取)
 | :param v4: v4数据(消息推送中获取)
 | :param msg: 添加时的打招呼消息
 | :return: 无
 | 
 | agree_friend(self, msg_data)
 | 同意添加好友请求
 | :param msg_data: 好友请求时的消息数据
 | :return: 无
 | 
 | agree_friend_invite_join_chat_room(self, msg_data)
 | 同意好友邀请进群
 | :param msg_data: 消息数据
 | :return: 群ID
 | 
 | alter_chat_room_name(self, to_chat_room, name)
 | 修改群名称
 | :param to_chat_room: 群ID
 | :param name: 群名称
 | :return: 无
 | 
 | alter_friend_desc(self, to_wx, desc)
 | 修改好友描述信息
 | :param to_wx: 好友微信ID
 | :param desc: 描述信息
 | :return: 无
 | 
 | alter_friend_remark(self, to_wx, remark)
 | 修改好友备注
 | :param to_wx: 好友微信ID
 | :param remark: 备注内容
 | :return: 无
 | 
 | alter_my_name_in_chat_room(self, to_chat_room, name)
 | 修改我在群里的昵称
 | :param to_chat_room: 群ID
 | :param name: 昵称
 | :return: 无
 | 
 | batch_query_member_nick_name(self, to_chat_room, wx_id_list)
 | 批量查询群成员的群昵称
 | :param to_chat_room: 群ID
 | :param wx_id_list: 群成员的微信ID列表
 | :return: List数据
 | 
 | cdn_download_file(self, file_id, aes_key, save_path)
 | CDN下载文件
 | :param file_id: 文件ID【消息回调中获取】
 | :param aes_key: aes_key【消息回调中获取】
 | :param save_path: 保存路径
 | :return: 无
 | 
 | cdn_download_img(self, img_type, file_id, aes_key, save_path)
 | CDN下载图片
 | :param img_type: 图片类型【1=缩略图 2=高清图 3=原图】
 | :param file_id: 文件ID【消息回调中获取】
 | :param aes_key: aes_key【消息回调中获取】
 | :param save_path: 保存路径
 | :return: 无
 | 
 | cdn_download_video(self, file_id, aes_key, save_path)
 | CDN下载视频
 | :param file_id: 文件ID【消息回调中获取】
 | :param aes_key: aes_key【消息回调中获取】
 | :param save_path: 保存路径
 | :return: 无
 | 
 | collection(self, msg_data)
 | 收款
 | :param msg_data: 消息数据
 | :return: 无
 | 
 | comment_moments(self, moments_id, content)
 | 朋友圈评论
 | :param moments_id: 朋友圈ID
 | :param content: 评论内容
 | :return: 无
 | 
 | create_chat_room(self, wx_id_list)
 | 创建群聊
 | :param wx_id_list: 邀请进群的微信ID列表
 | :return: 群ID
 | 
 | del_comment_moments(self, moments_id, comment_id)
 | 朋友圈删除评论
 | :param moments_id: 朋友圈ID
 | :param comment_id: 评论ID
 | :return: 无
 | 
 | delete_chat_room_member(self, to_chat_room, to_wx_list)
 | 踢出群成员
 | :param to_chat_room: 群ID
 | :param to_wx_list: 群成员微信ID列表
 | :return: 无
 | 
 | delete_friend(self, to_wx)
 | 删除好友
 | :param to_wx: 要删除的微信ID
 | :return: 无
 | 
 | exit_chat_room(self, to_chat_room)
 | 退出群聊
 | :param to_chat_room: 群ID
 | :return: 无
 | 
 | follow_mp(self, mp_id)
 | 关注公众号
 | :param mp_id: 公众号ID
 | :return: 无
 | 
 | get_access_url(self, url)
 | 获取外部浏览器可访问的URL
 | :param url: 只能在微信中打开的URL(如公众号链接)
 | :return: 可访问的URL
 | 
 | get_chat_room_members(self, to_chat_room)
 | 获取群成员列表
 | :param to_chat_room: 群ID
 | :return: list数据
 | 
 | get_cur_window_info(self)
 | 获取当前聊天窗口信息
 | :return: dict数据
 | 
 | get_cur_wx_pid(self)
 | 获取当前微信进程的PID
 | :return: 进程PID
 | 
 | get_login_state(self)
 | 获取微信登录状态
 | :return: True:已登录 False:未登录
 | 
 | get_moments(self, last_id=None)
 | 获取朋友圈数据
 | :param last_id: 最后一条朋友圈的ID【翻页必传】
 | :return: List数据
 | 
 | get_moments_by_friend(self, wx_id, last_id=None)
 | 获取指定好友的朋友圈
 | :param wx_id: 好友的微信ID
 | :param last_id: 最后一条朋友圈的ID【翻页必传】
 | :return: List数据
 | 
 | get_self_info(self)
 | 获取个人信息
 | :return: 未登录时返回None,登录成功返回字典数据
 | 
 | get_small_app_code(self, app_id)
 | 获取小程序code
 | :param app_id: 小程序的AppId
 | :return: 小程序code
 | 
 | hide_wx_windows(self)
 | 隐藏微信窗口
 | :return: 无
 | 
 | invite_friend_enter_chat_room(self, to_chat_room, to_wx_list)
 | 邀请好友进群
 | :param to_chat_room: 群ID
 | :param to_wx_list: 好友微信ID列表
 | :return: 无
 | 
 | like_moments(self, moments_id, state)
 | 朋友圈点赞/取消点赞
 | :param moments_id: 朋友圈ID
 | :param state: True:点赞 False:取消点赞
 | :return: 无
 | 
 | logout(self)
 | 退出登录
 | :return: 无
 | 
 | mask_msg_switch(self, to_id, switch)
 | 开启/关闭消息免打扰
 | :param to_id: 好友ID/群ID
 | :param switch: True:开启免打扰 False:关闭免打扰
 | :return: 无
 | 
 | moments_upload_img(self, path)
 | 朋友圈上传图片
 | :param path: 图片的绝对路径
 | :return: Dict数据
 | 
 | pull_list(self, pull_type)
 | 拉取列表(好友/群/公众号/其他)
 | :param pull_type: 好友:1 群:2 公众号:3 其他:4
 | :return: list数据
 | 
 | qr_code_join_chat_room(self, url)
 | 群二维码进群
 | :param url: 群二维码解析的URL
 | :return: 群ID
 | 
 | query_friend_info(self, to_wx)
 | 查询好友信息
 | :param to_wx: 要查询的微信ID
 | :return: dict数据
 | 
 | query_friend_info_by_net(self, to_wx)
 | 网络查询好友信息
 | :param to_wx: 要查询的微信ID
 | :return: dict数据
 | 
 | query_wx_info_by_net(self, key)
 | 网络查询陌生人信息
 | :param key: 手机号/QQ号/微信号
 | :return: dict数据
 | 
 | refund(self, msg_data)
 | 退款
 | :param msg_data: 消息数据
 | :return: 无
 | 
 | save_to_addr_book(self, to_chat_room, switch)
 | 群聊保存/取消保存到通讯录
 | :param to_chat_room: 群ID
 | :param switch: True:保存 False:取消保存
 | :return: 无
 | 
 | save_voice_switch(self, save_dir_path, switch)
 | 开启/关闭保存语音
 | :param save_dir_path: 保存语音的绝对路径【目录路径】
 | :param switch: True:开启 False:关闭
 | :return: 无
 | 
 | send_card_link(self, to_wx, title, desc, target_url, img_url)
 | 发送卡片链接
 | :param to_wx: 接收者的微信ID/群ID
 | :param title: 卡片标题
 | :param desc: 卡片描述
 | :param target_url: 目标地址
 | :param img_url: 卡片封面地址
 | :return: 无
 | 
 | send_card_link_moments(self, text, title, desc, target_url, thumb_url, is_private=False)
 | 发卡片链接朋友圈
 | :param text: 文本内容
 | :param title: 卡片标题
 | :param desc: 卡片描述
 | :param target_url: 目标地址
 | :param thumb_url: 封面地址【上传接口返回的thumb_url】
 | :param is_private: False:所有人可见 True:仅自己可见【默认为False】
 | :return: 朋友圈ID
 | 
 | send_file(self, to_wx, path)
 | 发送文件/视频消息
 | :param to_wx: 接收者的微信ID/群ID
 | :param path: 文件/视频的绝对路径
 | :return: 无
 | 
 | send_friend_card(self, to_wx, friend_wx, friend_name)
 | 发送好友名片
 | :param to_wx: 接收者的微信ID/群ID
 | :param friend_wx: 好友微信ID
 | :param friend_name: 好友昵称
 | :return: 无
 | 
 | send_gif(self, to_wx, path)
 | 发送GIF表情
 | :param to_wx: 接收者的微信ID/群ID
 | :param path: gif图片的绝对路径
 | :return: 无
 | 
 | send_img(self, to_wx, path)
 | 发送图片消息
 | :param to_wx: 接收者的微信ID/群ID
 | :param path: 图片的绝对路径
 | :return: 无
 | 
 | send_img_text_moments(self, text, img_url_list=None, is_private=False)
 | 发图文朋友圈
 | :param text: 文本内容
 | :param img_url_list: 上传接口返回的图片url列表【不传则是发纯文本】
 | :param is_private: False:所有人可见 True:仅自己可见【默认为False】
 | :return: 朋友圈ID
 | 
 | send_location(self, to_wx, lon, lat, address, detail_address)
 | 发送位置消息
 | :param to_wx: 接收者的微信ID/群ID
 | :param lon: 经度
 | :param lat: 纬度
 | :param address: 地址
 | :param detail_address: 详细地址
 | :return: 无
 | 
 | send_mp_card(self, to_wx, mp_id, mp_name)
 | 发送公众号名片
 | :param to_wx: 接收者的微信ID/群ID
 | :param mp_id: 公众号ID
 | :param mp_name: 公众号名称
 | :return: 无
 | 
 | send_notice(self, to_chat_room, content)
 | 发送群公告
 | :param to_chat_room: 群ID
 | :param content: 公告内容
 | :return: 无
 | 
 | send_or_forward_moments(self, xml_content, is_private=False)
 | 发送/转发朋友圈
 | :param xml_content: xml内容
 | :param is_private: False:所有人可见 True:仅自己可见【默认为False】
 | :return: 朋友圈ID
 | 
 | send_text(self, to_wx, msg)
 | 发送文本消息
 | :param to_wx: 接收者的微信ID/群ID
 | :param msg: 消息内容
 | :return: 无
 | 
 | send_text_and_at_all(self, to_chat_room, msg)
 | 群聊发送文本信息并且@所有人
 | :param to_chat_room: 群ID
 | :param msg: 文本消息
 | :return: 无
 | 
 | send_text_and_at_member(self, to_chat_room, to_wx_list, msg)
 | 群聊发送文本信息并且@指定群成员
 | :param to_chat_room: 群ID
 | :param to_wx_list: @人的微信ID列表
 | :param msg: 文本消息,需自行指定【@昵称】的位置且【@昵称】的数量要跟to_wx_list中的微信ID数量相等,否则@将失效
 | :return: 无
 | 
 | send_voice(self, to_wx, path, voice_time)
 | 发送语音消息
 | :param to_wx: 接收者的微信ID/群ID
 | :param path: silk文件的绝对路径
 | :param voice_time: 语音时长,单位:毫秒
 | :return: True:成功 False:失败
 | 
 | send_xml(self, to_wx, xml_str)
 | 发送XML消息
 | :param to_wx: 接收者的微信ID/群ID
 | :param xml_str: XML字符串
 | :return: 无
 | 
 | show_wx_windows(self)
 | 显示微信窗口
 | :return: 无
 | 
 | start_wx(self, path=None)
 | 启动微信,目前支持微信版本:V-4.1.2.16
 | :param path: 保存登录二维码的绝对路径
 | :return: (errno:状态码,errmsg:说明)
 | 
 | top_chat_switch(self, to_id, switch)
 | 置顶/取消置顶聊天
 | :param to_id: 好友ID/群ID
 | :param switch: True:置顶 False:取消置顶
 | :return: 无
 | 
 | un_follow_mp(self, mp_id)
 | 取消关注公众号
 | :param mp_id: 公众号ID
 | :return: 无
 | 
 | ----------------------------------------------------------------------

声明