justcoded / laravel-notification-channel-twilio
为Laravel提供Twilio通知渠道
Requires
- php: >=7.2
- illuminate/events: ^5.8 || ^6.0 || ^7.0 || ^8.0
- illuminate/notifications: ^5.8 || ^6.0 || ^7.0 || ^8.0
- illuminate/queue: ^5.8 || ^6.0 || ^7.0 || ^8.0
- illuminate/support: ^5.8 || ^6.0 || ^7.0 || ^8.0
- twilio/sdk: ~6.0
README
内容
安装
您可以通过composer安装此包
composer require justcoded/laravel-notification-channel-twilio
配置
将您的Twilio Account SID、认证令牌和From Number(可选)添加到您的 .env
TWILIO_USERNAME=XYZ # optional when using auth token TWILIO_PASSWORD=ZYX # optional when using auth token TWILIO_AUTH_TOKEN=ABCD # optional when using username and password TWILIO_ACCOUNT_SID=1234 # always required TWILIO_FROM=100000000 # optional default from TWILIO_ALPHA_SENDER=HELLO # optional TWILIO_DEBUG_TO=23423423423 # Set a number that call calls/messages should be routed to for debugging TWILIO_SMS_SERVICE_SID=MG0a0aaaaaa00aa00a00a000a00000a00a # Optional but recommended
高级配置
运行 php artisan vendor:publish --provider="Justcoded\NotificationChannelTwilio\TwilioProvider"
/config/twilio-notification-channel.php
抑制特定错误或所有错误
使用上述命令发布配置,并编辑 ignored_error_codes
数组。您可以从 文档 中获取异常代码列表。
如果您想抑制所有错误,可以将选项设置为 ['*']
。错误将不会记录,但失败的通知事件仍会发出。
推荐配置
Twilio建议始终使用 消息服务,因为它可以访问高级取消订阅、粘性发送者、扩展器、地理匹配、简码重路由和智能编码等功能。
如果遇到短信问题,请检查Twilio的 最佳实践。
从2.x升级到3.x
如果您正在从版本 2.x
升级,请确保您的环境变量设置与配置部分中所示的一致。环境变量名称没有更改,但如果您在 services.php
配置中使用了不同的密钥,则需要更新它们以匹配上述设置,或者发布配置文件并更改 env
键。
您还应该从 services.php
配置中删除旧的 twilio
条目,因为它不再使用。
2.x
和 3.x
之间的主要更改是,失败的通告现在将抛出异常,除非它们在忽略的错误代码列表中(发布配置文件以编辑这些)。
您可以通过设置 'ignored_error_codes' => ['*']
来复制 2.x
的行为,这将导致所有异常被抑制。
使用方法
现在您可以在通知内部的 via()
方法中使用该频道
use Justcoded\NotificationChannelTwilio\TwilioChannel; use Justcoded\NotificationChannelTwilio\TwilioSmsMessage; use Illuminate\Notifications\Notification; class AccountApproved extends Notification { public function via($notifiable) { return [TwilioChannel::class]; } public function toTwilio($notifiable) { return (new TwilioSmsMessage()) ->content("Your {$notifiable->service} account was approved!"); } }
您还可以发送MMS
use Justcoded\NotificationChannelTwilio\TwilioChannel; use Justcoded\NotificationChannelTwilio\TwilioMmsMessage; use Illuminate\Notifications\Notification; class AccountApproved extends Notification { public function via($notifiable) { return [TwilioChannel::class]; } public function toTwilio($notifiable) { return (new TwilioMmsMessage()) ->content("Your {$notifiable->service} account was approved!") ->mediaUrl("https://picsum.photos/300"); } }
或创建Twilio通话
use Justcoded\NotificationChannelTwilio\TwilioChannel; use Justcoded\NotificationChannelTwilio\TwilioCallMessage; use Illuminate\Notifications\Notification; class AccountApproved extends Notification { public function via($notifiable) { return [TwilioChannel::class]; } public function toTwilio($notifiable) { return (new TwilioCallMessage()) ->url("http://example.com/your-twiml-url"); } }
为了让您的通知知道您正在发送或拨打哪个电话,该频道将查找可通知模型的 phone_number
属性。如果您想覆盖此行为,请将 routeNotificationForTwilio
方法添加到您的可通知模型中。
public function routeNotificationForTwilio() { return '+1234567890'; }
可用的消息方法
TwilioSmsMessage
from('')
:接受用作通知发送者的电话。content('')
:接受用于通知正文的字符串值。messagingServiceSid('')
:接受用于配置的消息服务SID。
TwilioCallMessage
from('')
:接受用作通知发送者的电话。url('')
:接受用于通话TwiML的URL。