timedoor/whatsapp-otp

Laravel 的 WhatsApp OTP 包

v1.0.0 2023-01-12 03:26 UTC

This package is auto-updated.

Last update: 2024-09-12 07:38:39 UTC


README

此包用于使用 WhatsApp Cloud API 在 Laravel 上发送 WhatsApp OTP 通知。

安装

通过 composer 安装包

composer require timedoor/whatsapp-otp

安装 WhatsApp OTP 的配置和通知文件

php artisan whatsapp-otp:install

设置 WhatsApp Cloud API

此包需要一个 Meta 开发者账户和一个 Meta 开发者应用来开始通过 WhatsApp 发送消息。要设置 Meta 开发者应用,请按照 WhatsApp Cloud API 文档 中的说明操作。

创建 WhatsApp 模板

WhatsApp API 只允许您通过发送模板消息来开始对话。为了发送 OTP 通知,您必须首先创建 WhatsApp 模板。有关详细信息,您可以查看 WhatsApp 模板 文档 页面。

对于多语言模板,您可以为不同的语言创建具有相同模板名称的单独模板。

配置 WhatsApp Cloud API

从 WhatsApp 应用仪表板复制访问令牌和电话号码 ID。

然后将您的访问令牌、电话号码 ID、模板名称和模板语言放入以下 .env 文件中。

WHATSAPP_ACCESS_TOKEN=
WHATSAPP_PHONE_ID=
WHATSAPP_TEMPLATE_NAME=
WHATSAPP_TEMPLATE_LANG=

WhatsApp API 的配置设置可以在 config/whatsapp.php 文件中看到。

用法

此包包含一个名为 WhatsappOtpNotification 的通知类,该类存储在 app/Notifications 文件夹中。

要发送 OTP 通知,您可以使用 Notifiable 特性提供的 notify 方法,如下例所示。

$notification = new WhatsappOtpNotification();
$event->otp->notify($notification);