.mark_as_read()
消除当前聊天对象的未读提示小红点
.pin()
将聊天对象置顶
.unpin()
取消聊天对象的置顶状态
.get_avatar(save_path=None)
获取头像
参数: save_path – 保存路径(后缀通常为.jpg),若为 None 则返回字节数据
.uin
微信中的聊天对象ID,固定且唯一
因微信的隐私策略,该属性有时无法被获取到
建议使用 puid 作为用户的唯一 ID
.alias
若用户进行过一次性的 “设置微信号” 操作,则该值为用户设置的”微信号”,固定且唯一
因微信的隐私策略,该属性有时无法被获取到
建议使用 puid 作为用户的唯一 ID
.wxid
聊天对象的微信ID (实际为 .alias 或 .uin)
因微信的隐私策略,该属性有时无法被获取到
建议使用 puid 作为用户的唯一 ID
.user_name
该聊天对象的内部 ID,通常不需要用到
注意:同个聊天对象在不同用户中,此 ID 不一致 ,且可能在新会话中 被改变!
.send(content=None, media_id=None)
动态发送不同类型的消息,具体类型取决于 content 的前缀
| 参数 | 说明 |
| :-- | :-- |
| content | 由 前缀 和 内容 两个部分组成,若 省略前缀,将作为纯文本消息发送
前缀 部分可为: @fil@: 文件,@img@: 图片,@msg@: 纯文本,@vid@: 视频
内容 部分可为: 文件、图片、视频的路径,或纯文本的内容 |
| media_id | 填写后可省略上传过程 |
返回类型:wxpy.SentMessage
发送文本
.send_msg(msg=None)
| 参数 | 说明 |
| :-- | :-- |
| msg | 文本内容 |
发送图片
.send_image(path, media_id=None)
| 参数 | 说明 |
| :-- | :-- |
| path | 文件路径 |
| media_id | 设置后可省略上传过程 |
发送视频
.send_video(path=None, media_id=None)
| 参数 | 说明 |
| :-- | :-- |
| path | 文件路径 |
| media_id | 设置后可省略上传过程 |
发送文件
my_friend.send_file(path, media_id=None)
| 参数 | 说明 |
| :-- | :-- |
| path | 文件路径 |
| media_id | 设置后可省略上传过程 |
以原始格式发送其他类型消息
send_raw_msg(raw_type, raw_content, uri=None, msg_ext=None)
| 参数 | 说明 |
| :-- | :-- |
| raw_type: int | 原始的整数消息类型 |
| raw_content: str | 原始的消息内容 |
| uri: str | 请求路径,默认为 ‘/webwxsendmsg’ |
| msg_ext: dict | 消息的扩展属性 (会被更新到 Msg 键中) |
注册函数
可通过预先注册的方式,实现消息的自动处理。
预先将特定聊天对象的特定类型消息,注册到对应的处理函数,以实现自动回复等功能。
每当收到新消息时,将根据注册规则找到匹配条件的执行函数。并将消息对象作为唯一参数传入该函数。
将 bot.register() 作为函数的装饰器,即可完成注册。
bot.register(chats=None, msg_types=None, except_self=True, run_async=True, enabled=True
其中msg_types参数,是指定接收消息的类型,wxpy中支持以下消息类型:
| 值 | 描述 |
| :-- | :-- |
| TEXT 或 ‘Text’ | 文本 |
| MAP 或 ‘Map’ | 位置 |
| CARD 或 ‘Card’ | 名片 |
| NOTE 或 ‘Note’ | 提示 |
| SHARING 或 ‘Sharing’ | 分享 |
| PICTURE 或 ‘Picture’ | 图片 |
| RECORDING 或 ‘Recording’ | 语音 |
| ATTACHMENT 或 ‘Attachment’ | 文件 |
| VIDEO 或 ‘Video’ | 视频 |
| FRIENDS 或 ‘Friends’ | 好友请求 |
| SYSTEM 或 ‘System’ | 系统 |
其他参数
| 参数 | 描述 |
| :-- | :-- |
| chats | 消息所在的聊天对象:单个或列表形式的多个聊天对象或聊天类型,为空时匹配所有聊天对象;
既可以是聊天对象实例,也可以是对象类。当为类时,表示匹配该类型的所有聊天对象。 |
| msg_types | 消息的类型:单个或列表形式的多个消息类型,为空时匹配所有消息类型 (SYSTEM 类消息除外) |
| except_self | 排除由自己发送的消息 |
| run_async | 是否异步执行所配置的函数:可提高响应速度 |
| enabled | 当前配置的默认开启状态,可事后动态开启或关闭 |
在被注册函数中,可以通过直接 return <回复内容> 的方式来回复消息,等同于调用 msg.reply(<回复内容>)。
Message 消息对象
每当机器人接收到消息时,会自动执行以下两个步骤:
1.将消息保存到 Bot.messages 中
2.查找消息预先注册的函数,并执行(若有匹配的函数)
基本属性
消息的类型
Message.type
返回消息的类型:str
机器人对象
Message.bot
接收此消息的机器人对象
消息的唯一 ID
Message.id
(通常为大于 0 的 64 位整型)
内容数据
消息的文本内容
Message.text
下载图片、视频、语音、附件消息中的文件内容
可与 Message.file_name 配合使用
参数: save_path – 文件的保存路径。若为 None,将直接返回字节数据
Message.get_file(save_path=None)
消息中文件的文件名
Message.file_name
消息中文件的体积大小
Message.file_size
文件类消息中的文件资源 ID (但图片视频语音等其他消息中为空)
Message.media_id
原始数据 (dict 数据
)Message.raw
用户相关
Message.chat
消息所在的聊天会话
对于自己发送的消息,为消息的接收者
对于别人发送的消息,为消息的发送者
返回类型:wxpy.User, wxpy.Group
Message.sender
消息的发送者
返回类型: wxpy.User, wxpy.Group
Message.receiver
消息的接收者
返回类型:wxpy.User, wxpy.Group
Message.member
消息的实际发送人
若消息来自群聊,则此属性为消息的实际发送人(具体的群成员)
若消息来自其他聊天对象(非群聊),则此属性为 None# 返回类型:NoneType, wxpy.Member
Message.card
#好友请求中的请求用户
#名片消息中的推荐用户
群聊相关
Message.member
发送人
若消息来自群聊,则此属性为消息的实际发送人(具体的群成员)
若消息来自其他聊天对象(非群聊),则此属性为 None
返回类型: NoneType,wxpy.Member
Message.is_at
是否被 @
当消息来自群聊,且被 @ 时,为 True
时间相关
服务端发送时间
Message.create_time
本地接收时间
Message.receive_time
消息的延迟秒数 (发送时间和接收时间的差值)
Message.latency
不同类型消息
图片、视频、语音
图片高度
Message.img_height
图片宽度
Message.img_width
视频长度
Message.play_length
语音长度
Message.voice_length
文章
分享类消息中的网页 URL
Message.url
公众号推送中的文章列表 (首篇的 标题/地址 与消息中的 text/url 相同)
Message.articles
其中,每篇文章均有以下属性
| 属性 | 说明 |
| :-- | :-- |
| title | 标题 |
| summary | 摘要 |
| url | 文章 URL |
| cover | 封面或缩略图 URL |
位置消息
位置消息中的地理位置信息
Message.location
回复
方法一:获取聊天对象后发送消息
Message.chat.send(…)
Message.chat.send_msg(…)
…更多见本章 “发送消息”
方法二:直接回复
| 代码 | 描述 |
| :-- | :-- |
| Message.reply(…) | 回复 |
| Message.reply_msg(…) | 回复文本 |
| Message.reply_image(…) | 回复图片 |
| Message.reply_file(…) | 回复文件 |
| Message.reply_video(…) | 回复视频 |
| Message.reply_raw_msg(…) | 以原始格式回复其他类型消息 |
具体参数见本章 “发送消息”。
转发消息
将本消息转发给其他聊天对象
Message.forward(chat, prefix=None, suffix=None, raise_for_unsupported=False)
支持以下消息类型
| 类型 | 描述 |
| :-- | :-- |
| TEXT | 文本 |
| VIDEO | 视频 |
| ATTACHMENT | 文件 |
| PICTURE | 图片/自定义表情
不支持表情商店中的表情 |
| CARD | 名片
仅支持公众号名片,以及自己发出的个人号名片 |
| SHARING | 分享
会转化为 标题 + 链接 形式的文本消息 |
| RECORDING | 语音
会以文件方式发送 |
文末有福利领取哦~
👉一、Python所有方向的学习路线
Python所有方向的技术点做的整理,形成各个领域的知识点汇总,它的用处就在于,你可以按照上面的知识点去找对应的学习资源,保证自己学得较为全面。
👉二、Python必备开发工具
👉三、Python视频合集
观看零基础学习视频,看视频学习是最快捷也是最有效果的方式,跟着视频中老师的思路,从基础到深入,还是很容易入门的。
👉 四、实战案例
光学理论是没用的,要学会跟着一起敲,要动手实操,才能将自己的所学运用到实际当中去,这时候可以搞点实战案例来学习。(文末领读者福利)
👉五、Python练习题
检查学习结果。
👉六、面试资料
我们学习Python必然是为了找到高薪的工作,下面这些面试题是来自阿里、腾讯、字节等一线互联网大厂最新的面试资料,并且有阿里大佬给出了权威的解答,刷完这一套面试资料相信大家都能找到满意的工作。
👉因篇幅有限,仅展示部分资料,这份完整版的Python全套学习资料已经上传
网上学习资料一大堆,但如果学到的知识不成体系,遇到问题时只是浅尝辄止,不再深入研究,那么很难做到真正的技术提升。
一个人可以走的很快,但一群人才能走的更远!不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人,都欢迎加入我们的的圈子(技术交流、学习资源、职场吐槽、大厂内推、面试辅导),让我们一起学习成长!