python-whatsapp-bot

python-whatsapp-bot

使用Python构建智能WhatsApp机器人实现自动化客户服务

该项目介绍了使用Python和Flask构建WhatsApp机器人的方法。通过Meta Cloud API发送消息,webhook接收实时消息,并整合OpenAI生成智能回复。项目提供了完整的设置指南、API使用说明、webhook配置和AI集成步骤。适合各级开发者学习如何创建功能强大的WhatsApp自动化系统。

WhatsApp机器人PythonFlaskMeta Cloud APIOpenAIGithub开源项目

使用纯Python构建AI WhatsApp机器人

本指南将指导您使用Meta(前身为Facebook)云API和纯Python(特别是Flask)创建WhatsApp机器人的过程。我们还将集成webhook事件以实时接收消息,并使用OpenAI生成AI回复。有关Flask应用程序结构的更多信息,您可以参考此文档

先决条件

  1. Meta开发者账号 — 如果您没有,可以在此创建Meta开发者账号
  2. 商业应用 — 如果您没有,可以在此学习如何创建商业应用。如果您没有看到创建商业应用的选项,请选择其他 > 下一步 > 商业
  3. 熟悉Python以便跟随教程。

目录

开始

  1. 概述与设置:从这里开始您的旅程。
  2. 定位您的机器人:您可以在这里找到您的机器人。
  3. WhatsApp API文档:熟悉官方文档
  4. 有用指南:这是一个基于Python的指南,用于发送消息。
  5. 发送消息的API文档:查看此文档

步骤1:选择电话号码

  • 确保已将WhatsApp添加到您的应用中。
  • 您最初会有一个测试号码,可用于向最多5个号码发送消息。
  • 转到API设置,找到您将用来发送消息的测试号码。
  • 在这里,您还可以添加要发送消息的号码。输入您自己的WhatsApp号码
  • 您将通过WhatsApp在手机上收到一个验证码来验证您的号码。

步骤2:使用API发送消息

  1. 从API访问部分获取24小时访问令牌。
  2. 它将显示如何使用curl命令发送消息的示例,可以从终端或使用Postman等工具发送。
  3. 让我们将其转换为使用request库的Python函数
  4. 基于example.env创建一个.env文件,并更新所需的变量。这里有视频示例
  5. 您将收到一条"Hello World"消息(预计消息延迟60-120秒)。

创建有效期超过24小时的访问令牌

  1. Meta商业账户级别创建系统用户
  2. 在系统用户页面,为您的系统用户配置资产,为您的WhatsApp应用分配完全控制权。别忘了点击保存更改按钮。
  3. 现在点击生成新令牌,选择应用,然后选择访问令牌的有效期。您可以选择60天或永不过期。
  4. 选择所有权限,因为我在只选择WhatsApp相关权限时遇到了错误。
  5. 确认并复制访问令牌。

现在我们需要在应用仪表板上找到以下信息:

  • APP_ID:"<你的WhatsApp商业应用APP_ID>"(在应用仪表板中找到)
  • APP_SECRET:"<你的WhatsApp商业应用APP_SECRET>"(在应用仪表板中找到)
  • RECIPIENT_WAID:"<你的接收者测试电话号码>"(这是你的WhatsApp ID,即电话号码。确保它已如示例测试消息所示添加到账户中。)
  • VERSION:"v18.0"(Meta Graph API的最新版本)
  • ACCESS_TOKEN:"<你的系统用户访问令牌>"(在上一步中创建)

你只能向用户发送模板类型的消息作为第一条消息。这就是为什么你必须先发送回复,然后我们才能继续。我花了2个小时才弄明白这一点。

步骤3:配置Webhooks以接收消息

请注意,这是本教程中最困难的部分。

启动你的应用

  • 确保你有Python安装环境并安装依赖:pip install -r requirements.txt
  • 通过执行run.py在本地运行你的Flask应用

启动ngrok

以下步骤来自ngrok文档

你需要一个静态ngrok域名,因为Meta会验证你的ngrok域名和证书!

一旦你的应用成功在localhost上运行,让我们使用ngrok安全地将其发布到互联网上!

  1. 如果你还不是ngrok用户,只需免费注册ngrok。
  2. 下载ngrok代理。
  3. 进入ngrok仪表板,点击你的Authtoken,并复制你的Authtoken。
  4. 按照说明验证你的ngrok代理。你只需要做一次。
  5. 在左侧菜单中,展开Cloud Edge,然后点击Domains。
  6. 在Domains页面,点击 + Create Domain 或 + New Domain。(这里每个人都可以从一个免费域名开始)
  7. 在本地桌面的终端中运行以下命令启动ngrok:
ngrok http 8000 --domain your-domain.ngrok-free.app
  1. ngrok将显示一个URL,你的localhost应用将通过该URL暴露给互联网(复制此URL以供Meta使用)。

集成WhatsApp

在Meta应用仪表板中,转到WhatsApp > Configuration,然后点击Edit按钮。

  1. 在编辑webhook回调URL弹窗中,在回调URL字段中输入ngrok代理提供的URL,以将你的应用暴露给互联网,并在末尾添加/webhook(例如https://myexample.ngrok-free.app/webhook)。
  2. 输入验证令牌。当你创建webhook端点时,你设置这个字符串。你可以选择任何你喜欢的字符串。确保在你的VERIFY_TOKEN环境变量中更新它。
  3. 将webhook添加到WhatsApp后,WhatsApp将通过ngrok向你的应用提交验证POST请求。确认你的localhost应用收到验证GET请求,并在终端中记录WEBHOOK_VERIFIED
  4. 返回Configuration页面,点击Manage。
  5. 在Webhook字段弹窗中,点击订阅messages字段。提示:你可以订阅多个字段。
  6. 如果你的Flask应用和ngrok正在运行,你可以点击messages旁边的"Test"来测试订阅。你会收到一条大写的测试消息。如果是这样,你的webhook就设置正确了。

测试集成

使用与你的WhatsApp产品关联的电话号码或使用你之前复制的测试号码。

  1. 将此号码添加到你的WhatsApp应用联系人中,然后向此号码发送消息。
  2. 确认你的localhost应用收到消息并在终端中记录标头和正文。
  3. 测试机器人是否以大写形式回复你。
  4. 你现在已成功集成了机器人!🎉
  5. 现在是时候用它来构建真正酷炫的东西了。

步骤4:了解Webhook安全性

以下是来自Meta Webhooks API文档关于验证和安全性的一些信息。它已经在代码中实现,但你可以参考它以更好地理解security.py中发生的情况。

验证请求

来源

每次你在应用仪表板中配置Webhooks产品时,我们都会向你的端点URL发送GET请求。验证请求包括以下查询字符串参数,附加在你的端点URL末尾。它们看起来会像这样:

GET https://www.your-clever-domain-name.com/webhook?
  hub.mode=subscribe&
  hub.challenge=1158201444&
  hub.verify_token=meatyhamhock

verify_token,在这个例子中是meatyhamhock,是你可以选择的字符串。它是什么并不重要,只要你将其存储在VERIFY_TOKEN环境变量中即可。

验证验证请求

来源

每当你的端点收到验证请求时,它必须:

  • 验证hub.verify_token值是否与你在应用仪表板中配置Webhooks产品时在验证令牌字段中设置的字符串匹配(你还没有设置这个令牌字符串)。
  • 用hub.challenge值响应。

验证有效载荷

WhatsApp会使用SHA256签名对所有事件通知载荷进行签名,并在请求的X-Hub-Signature-256头部中包含该签名,前缀为sha256=。你不必验证载荷,但建议这样做。

验证载荷的步骤:

  • 使用载荷和你的应用程序密钥生成SHA256签名。
  • 将你的签名与X-Hub-Signature-256头部中的签名(sha256=后面的所有内容)进行比较。如果签名匹配,则载荷是真实的。

第5步:了解API并构建你的应用

查看开发者文档,了解如何构建应用并开始发送消息。查看文档

第6步:将AI集成到应用中

现在我们已经建立了端到端连接,我们可以让机器人变得比仅仅用大写字母喊叫更聪明一些。你只需在whatsapp_utils.py中创建自己的generate_response()函数即可。

如果你想要一个集成OpenAI助手API和检索工具的现成示例,请按以下步骤操作:

  1. 观看此视频:OpenAI助手教程
  2. 使用OpenAI创建你自己的助手,并在环境变量中更新你的OPENAI_API_KEYOPENAI_ASSISTANT_ID
  3. 为你的助手提供数据和指令。
  4. 根据你的用例更新openai_service.py
  5. generate_reponse导入到whatsapp_utils.py中。
  6. 用新的generate_reponse()函数更新process_whatsapp_message()

第7步:添加电话号码

当你准备将应用用于生产用例时,你需要使用自己的电话号码向用户发送消息。

要开始向任何WhatsApp号码发送消息,请添加一个电话号码。要管理你的账户信息和电话号码,请查看概览页面WhatsApp文档

如果你想使用已在WhatsApp客户端或商业应用中使用的号码,你必须将该号码完全迁移到商业平台。一旦号码迁移,你将失去对WhatsApp客户端或商业应用的访问权限。有关信息,请参阅将现有WhatsApp号码迁移到商业账户

选择电话号码后,你必须将其添加到WhatsApp商业账户中。请参阅添加电话号码

在处理WhatsApp商业API并希望在不影响个人号码的情况下进行实验时,你有几个选择:

  1. 购买新的SIM卡
  2. 虚拟电话号码
  3. 双SIM卡手机
  4. 使用不同的设备
  5. 临时号码服务
  6. 专用开发设备

建议:如果是长期或专业用途,建议使用虚拟电话号码服务或为专用设备购买新的SIM卡。对于快速测试,临时号码可能足够,但要始终注意安全和隐私。请记住,一旦号码与WhatsApp商业API关联,就不能在设备上使用常规WhatsApp,除非你从商业API中停用它并在设备上重新验证。

Datalumina

本文档由Datalumina为你提供。我们帮助数据分析师、工程师和科学家启动和扩展成功的自由职业业务——每年10万美元以上、有趣的项目、满意的客户。如果你想了解更多关于我们的工作,可以访问我们的网站并订阅我们的新闻通讯。欢迎与你的数据朋友和同事分享此文档。

教程

如需视频教程,请访问YouTube频道:youtube.com/@daveebbelaar

编辑推荐精选

问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

openai-agents-python

openai-agents-python

OpenAI Agents SDK,助力开发者便捷使用 OpenAI 相关功能。

openai-agents-python 是 OpenAI 推出的一款强大 Python SDK,它为开发者提供了与 OpenAI 模型交互的高效工具,支持工具调用、结果处理、追踪等功能,涵盖多种应用场景,如研究助手、财务研究等,能显著提升开发效率,让开发者更轻松地利用 OpenAI 的技术优势。

下拉加载更多