使用纯Python构建AI WhatsApp机器人
本指南将指导您使用Meta(前身为Facebook)云API和纯Python(特别是Flask)创建WhatsApp机器人的过程。我们还将集成webhook事件以实时接收消息,并使用OpenAI生成AI回复。有关Flask应用程序结构的更多信息,您可以参考此文档。
先决条件
- Meta开发者账号 — 如果您没有,可以在此创建Meta开发者账号。
- 商业应用 — 如果您没有,可以在此学习如何创建商业应用。如果您没有看到创建商业应用的选项,请选择其他 > 下一步 > 商业。
- 熟悉Python以便跟随教程。
目录
开始
- 概述与设置:从这里开始您的旅程。
- 定位您的机器人:您可以在这里找到您的机器人。
- WhatsApp API文档:熟悉官方文档。
- 有用指南:这是一个基于Python的指南,用于发送消息。
- 发送消息的API文档:查看此文档。
步骤1:选择电话号码
- 确保已将WhatsApp添加到您的应用中。
- 您最初会有一个测试号码,可用于向最多5个号码发送消息。
- 转到API设置,找到您将用来发送消息的测试号码。
- 在这里,您还可以添加要发送消息的号码。输入您自己的WhatsApp号码。
- 您将通过WhatsApp在手机上收到一个验证码来验证您的号码。
步骤2:使用API发送消息
- 从API访问部分获取24小时访问令牌。
- 它将显示如何使用
curl
命令发送消息的示例,可以从终端或使用Postman等工具发送。 - 让我们将其转换为使用request库的Python函数。
- 基于
example.env
创建一个.env
文件,并更新所需的变量。这里有视频示例。 - 您将收到一条"Hello World"消息(预计消息延迟60-120秒)。
创建有效期超过24小时的访问令牌
- 在Meta商业账户级别创建系统用户。
- 在系统用户页面,为您的系统用户配置资产,为您的WhatsApp应用分配完全控制权。别忘了点击保存更改按钮。
- 现在点击
生成新令牌
,选择应用,然后选择访问令牌的有效期。您可以选择60天或永不过期。 - 选择所有权限,因为我在只选择WhatsApp相关权限时遇到了错误。
- 确认并复制访问令牌。
现在我们需要在应用仪表板上找到以下信息:
- 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安全地将其发布到互联网上!
- 如果你还不是ngrok用户,只需免费注册ngrok。
- 下载ngrok代理。
- 进入ngrok仪表板,点击你的Authtoken,并复制你的Authtoken。
- 按照说明验证你的ngrok代理。你只需要做一次。
- 在左侧菜单中,展开Cloud Edge,然后点击Domains。
- 在Domains页面,点击 + Create Domain 或 + New Domain。(这里每个人都可以从一个免费域名开始)
- 在本地桌面的终端中运行以下命令启动ngrok:
ngrok http 8000 --domain your-domain.ngrok-free.app
- ngrok将显示一个URL,你的localhost应用将通过该URL暴露给互联网(复制此URL以供Meta使用)。
集成WhatsApp
在Meta应用仪表板中,转到WhatsApp > Configuration,然后点击Edit按钮。
- 在编辑webhook回调URL弹窗中,在回调URL字段中输入ngrok代理提供的URL,以将你的应用暴露给互联网,并在末尾添加/webhook(例如https://myexample.ngrok-free.app/webhook)。
- 输入验证令牌。当你创建webhook端点时,你设置这个字符串。你可以选择任何你喜欢的字符串。确保在你的
VERIFY_TOKEN
环境变量中更新它。 - 将webhook添加到WhatsApp后,WhatsApp将通过ngrok向你的应用提交验证POST请求。确认你的localhost应用收到验证GET请求,并在终端中记录
WEBHOOK_VERIFIED
。 - 返回Configuration页面,点击Manage。
- 在Webhook字段弹窗中,点击订阅messages字段。提示:你可以订阅多个字段。
- 如果你的Flask应用和ngrok正在运行,你可以点击messages旁边的"Test"来测试订阅。你会收到一条大写的测试消息。如果是这样,你的webhook就设置正确了。
测试集成
使用与你的WhatsApp产品关联的电话号码或使用你之前复制的测试号码。
- 将此号码添加到你的WhatsApp应用联系人中,然后向此号码发送消息。
- 确认你的localhost应用收到消息并在终端中记录标头和正文。
- 测试机器人是否以大写形式回复你。
- 你现在已成功集成了机器人!🎉
- 现在是时候用它来构建真正酷炫的东西了。
步骤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和检索工具的现成示例,请按以下步骤操作:
- 观看此视频:OpenAI助手教程
- 使用OpenAI创建你自己的助手,并在环境变量中更新你的
OPENAI_API_KEY
和OPENAI_ASSISTANT_ID
。 - 为你的助手提供数据和指令。
- 根据你的用例更新openai_service.py。
- 将
generate_reponse
导入到whatsapp_utils.py中。 - 用新的
generate_reponse()
函数更新process_whatsapp_message()
。
第7步:添加电话号码
当你准备将应用用于生产用例时,你需要使用自己的电话号码向用户发送消息。
要开始向任何WhatsApp号码发送消息,请添加一个电话号码。要管理你的账户信息和电话号码,请查看概览页面和WhatsApp文档。
如果你想使用已在WhatsApp客户端或商业应用中使用的号码,你必须将该号码完全迁移到商业平台。一旦号码迁移,你将失去对WhatsApp客户端或商业应用的访问权限。有关信息,请参阅将现有WhatsApp号码迁移到商业账户。
选择电话号码后,你必须将其添加到WhatsApp商业账户中。请参阅添加电话号码。
在处理WhatsApp商业API并希望在不影响个人号码的情况下进行实验时,你有几个选择:
- 购买新的SIM卡
- 虚拟电话号码
- 双SIM卡手机
- 使用不同的设备
- 临时号码服务
- 专用开发设备
建议:如果是长期或专业用途,建议使用虚拟电话号码服务或为专用设备购买新的SIM卡。对于快速测试,临时号码可能足够,但要始终注意安全和隐私。请记住,一旦号码与WhatsApp商业API关联,就不能在设备上使用常规WhatsApp,除非你从商业API中停用它并在设备上重新验证。
Datalumina
本文档由Datalumina为你提供。我们帮助数据分析师、工程师和科学家启动和扩展成功的自由职业业务——每年10万美元以上、有趣的项目、满意的客户。如果你想了解更多关于我们的工作,可以访问我们的网站并订阅我们的新闻通讯。欢迎与你的数据朋友和同事分享此文档。
教程
如需视频教程,请访问YouTube频道:youtube.com/@daveebbelaar。