WeChat类#

{{< callout emoji="🌐" >}} 提示：
WeChat 类继承了 Chat类 的所有方法，有关聊天框内的操作，请参考 Chat类 的文档。 {{< /callout >}}

#WeChat 类方法

#概念

为确保您可以理解该文档的一些内容，这里先简单介绍一下 wxauto(x) 的设计思路，如下图所示，wxauto(x) 将微信窗口拆解为三部分：

• 导航栏（NavigationBox）：下图蓝色框内部分
• 会话列表（SessionBox）：下图绿色框内部分
  • 会话列表项（SessionElement）：会话列表中每一个会话的元素，如好友、群聊、公众号等
• 聊天框（Chat）：下图红色框内部分

#初始化参数

from wxautox import WeChat

wx = WeChat()

#保持程序运行 KeepRunning

由于wxautox使用守护线程来监听消息，当程序仅用于监听模式时，主线程会退出，因此需要调用此方法来保持程序运行

from wxautox import WeChat

wx = WeChat()
wx.AddListenChat('张三', callback=lambda msg, chat: ...)

# 保持程序运行，确保正常监听
wx.KeepRunning()

#获取当前会话列表 GetSession

sessions = wx.GetSession()
for session in sessions:
    print(session.info)

返回值：

• 类型：List[SessionElement]
• 描述：当前会话列表

#✨发送链接卡片 SendUrlCard

wx.SendUrlCard(url="https://example.com", friends="张三", timeout=10)

参数：

返回值：

• 类型：WxResponse
• 描述：发送结果

#打开聊天窗口 ChatWith

wx.ChatWith(who="张三", exact=False)

参数：

返回值：无

#获取子窗口实例 GetSubWindow

chat = wx.GetSubWindow(nickname="张三")

参数：

返回值：

• 类型：Chat
• 描述：子窗口实例

#获取所有子窗口实例 GetAllSubWindow

chats = wx.GetAllSubWindow()

返回值：

• 类型：List[Chat]
• 描述：所有子窗口实例的列表

#添加监听聊天窗口 AddListenChat

{{< cards >}} {{< card link="/docs/example/#2-监听消息" title="👉查看监听消息示例" tag="点击跳转" tagType="info" >}} {{< /cards >}}

def on_message(msg, chat):
    print(f"收到来自 {chat} 的消息: {msg.content}")

wx.AddListenChat(nickname="张三", callback=on_message)

参数：

返回值：

• 成功时：

  • 类型：Chat
  • 描述：该监的听子窗口实例

• 失败时：

  • 类型：WxResponse
  • 描述：执行结果，成功时包含监听名称

#移除监听聊天 RemoveListenChat

wx.RemoveListenChat(nickname="张三")

参数：

返回值：

• 类型：WxResponse
• 描述：执行结果

#开始监听 StartListening

wx.StartListening()

参数：无

返回值：无

#停止监听 StopListening

wx.StopListening()

参数：

返回值：无

#✨进入朋友圈 Moments

moments = wx.Moments(timeout=3)

参数：

返回值：

• 类型：MomentsWnd
• 描述：朋友圈窗口实例

#获取下一个新消息 GetNextNewMessage

messages = wx.GetNextNewMessage(filter_mute=False)

参数：

返回值：

• 类型：Dict[str, List[Message]]
• 描述：消息列表，键为聊天名称，值为消息列表
• 示例：

  {'chat_name': 'wxauto交流',
    'chat_type': 'group',
    'msg': [
        <wxautox - TimeMessage(2025年5月2...) at 0x227379555d0>,
        <wxautox - FriendImageMessage([图片]) at 0x2273795ca10>,
        <wxautox - FriendTextMessage(/[微笑]) at 0x22737967c50>,
        <wxautox - FriendTextMessage(你点击发送会自动...) at 0x227366c4f50>, 
        ...
      ]
  }

#✨获取好友列表 GetFriendDetails

# 获取前10个好友详情信息
messages = wx.GetFriendDetails(n=10)

参数：

返回值：

• 类型：List[dict]
• 描述：好友详情信息列表

#✨获取新的好友申请列表 GetNewFriends

{{< cards >}} {{< card link="/docs/example/#3-处理好友申请" title="👉查看处理好友申请示例" tag="点击跳转" tagType="info" >}} {{< /cards >}}

newfriends = wx.GetNewFriends(acceptable=True)

参数：

返回值：

• 类型：List[NewFriendElement]
• 描述：新的好友申请列表

示例：

newfriends = wx.GetNewFriends(acceptable=True)
tags = ['标签1', '标签2']
for friend in newfriends:
    remark = f'备注{friend.name}'
    friend.accept(remark=remark, tags=tags)  # 接受好友请求，并设置备注和标签

#✨添加新的好友 AddNewFriend

wx.AddNewFriend(keywords="张三", addmsg="我是小明", remark="老张", tags=["同学"], permission="朋友圈", timeout=5)

参数：

返回值：

• 类型：WxResponse
• 描述：添加好友的结果

#✨获取最近群聊名称列表 GetAllRecentGroups

groups = wx.GetAllRecentGroups()
if groups:
    print(groups)
else:
    print('获取失败')

返回值：

• 类型：WxResponse | List[str]: 失败时返回WxResponse，成功时返回所有最近群聊列表

#切换到聊天页面 SwitchToChat

wx.SwitchToChat()

返回值：无

#切换到联系人页面 SwitchToContact

wx.SwitchToContact()

返回值：无

#✨是否在线 IsOnline

wx.IsOnline()

返回值：

• 类型：bool

#✨获取我的信息 GetMyInfo

获取自己的微信号等信息

wx.GetMyInfo()

返回值：

• 类型：Dict[str, str]

#✨获取通讯录群聊列表 GetContactGroups

获取通讯录中的群聊列表

wx.GetContactGroups()

参数：

返回值：

• 类型：List[str]