README

本软件包使您能够轻松地在 Laravel 5.5+、6.x、7.x、8.x 和 9.x 中发送 Twilio 通知

您正在查看 3.x 文档。点击此处查看文档 2.x

内容

安装
使用方法
- 可用的消息方法
变更日志
测试
安全
贡献
致谢
许可

安装

您可以通过 composer 安装此软件包

composer require laravel-notification-channels/twilio

配置

将您的 Twilio Account SID、授权令牌和 From Number（可选）添加到您的 .env

TWILIO_AUTH_TOKEN=ABCD
TWILIO_ACCOUNT_SID=1234 # always required
TWILIO_SID=5678 # allow using separate access tokens
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 数组。您可以从文档中获取异常代码列表。

如果您想抑制所有错误，可以将选项设置为 ['*']。错误将不会被记录，但失败的通知事件仍然会被发出。

从 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");
    }
}

为了让通知知道您正在发送或呼叫哪个电话，通道将查找 Notifiable 模型的 phone_number 属性。如果您想覆盖此行为，请将 routeNotificationForTwilio 方法添加到您的 Notifiable 模型。

public function routeNotificationForTwilio()
{
    return '+1234567890';
}

可用的消息方法

TwilioSmsMessage

from('')：接受一个用于通知发送者的电话号码。
content('')：接受通知主体的字符串值。
messagingServiceSid('')：接受一个消息服务 SID 以处理配置。

TwilioCallMessage

from('')：接受一个用于通知发送者的电话号码。
url('')：接受用于通话 TwiML 的 URL。

变更日志

请参阅变更日志获取有关最近更改的更多信息。

测试

$ composer test

安全

如果您发现任何与安全相关的问题，请通过电子邮件gregoriohc@gmail.com联系，而不是使用问题跟踪器。

safermobility / laravel-notification-channel-twilio

维护者

详细信息