为Laravel提供Twilio通知通道
Requires
- php: >=7.2|^8.0
- illuminate/events: ^7.0 || ^8.0 || ^9.0 || ^10.0|^11.0
- illuminate/notifications: ^7.0 || ^8.0 || ^9.0 || ^10.0|^11.0
- illuminate/queue: ^7.0 || ^8.0 || ^9.0 || ^10.0|^11.0
- illuminate/support: ^7.0 || ^8.0 || ^9.0 || ^10.0|^11.0
- twilio/sdk: ~6.0|^7.16
Requires (Dev)
- mockery/mockery: ^1.3
- orchestra/testbench: ^5.0 || ^6.0 || ^7.0 || ^8.0|^9.0
- phpunit/phpunit: ^8.5|^9.5|^10.5
This package is auto-updated.
Last update: 2024-09-14 22:46:26 UTC
README
此包使得发送Twilio通知变得容易,支持Laravel 5.5+、6.x、7.x、8.x和9.x
您正在查看3.x
版本的文档。 点击此处查看2.x
版本的文档。
目录
安装
您可以通过composer安装此包
composer require laravel-notification-channels/twilio
配置
将您的Twilio Account SID、Auth Token和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 TWILIO_SHORTEN_URLS=true # optional, enable URL shortener
高级配置
运行 php artisan vendor:publish --provider="NotificationChannels\Twilio\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 NotificationChannels\Twilio\TwilioChannel; use NotificationChannels\Twilio\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 NotificationChannels\Twilio\TwilioChannel; use NotificationChannels\Twilio\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 NotificationChannels\Twilio\TwilioChannel; use NotificationChannels\Twilio\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。
变更日志
有关最近更改的更多信息,请参阅变更日志。
测试
$ composer test
安全性
如果您发现任何安全相关的问题,请通过电子邮件联系 gregoriohc@gmail.com,而不是使用问题跟踪器。
贡献
请参阅 CONTRIBUTING 获取详细信息。
致谢
许可证
MIT许可证(MIT)。请参阅 许可文件 获取更多信息。