fleetbase/twilio

Twilio API for Laravel

5.0.1 2024-08-15 08:26 UTC

This package is auto-updated.

Last update: 2024-09-15 08:39:25 UTC


README

Laravel Twilio API 集成

Build Status Total Downloads Latest Stable Version License

安装

首先通过 Composer 安装此包。在终端运行以下命令

composer require fleetbase/twilio

这将为您注册两个新的 artisan 命令

  • twilio:sms
  • twilio:call

并将这些对象设置为 IoC 容器中可解析的

  • Fleetbase\Twilio\Manager(别名 twilio
  • Fleetbase\Twilio\TwilioInterface(解析一个 Twilio 对象,这是由 Manager 创建的默认连接对象)。

如果您喜欢,还有一个 Facade 类可供使用。在您的 app.php 配置文件中,如果想要使用简短的类名,请向 aliases 数组添加以下行

'Twilio' => 'Fleetbase\Twilio\Support\Laravel\Facade',

您可以使用终端命令将默认配置文件发布到 config/twilio.php

php artisan vendor:publish --provider="Fleetbase\Twilio\Support\Laravel\ServiceProvider"

Facade

该 Facade 与 Fleetbase\Twilio\TwilioInterface 具有完全相同的方法。首先,在文件顶部包含 Facade

use Twilio;

要使用默认的 twilio 配置文件 发送消息

Twilio::message($user->phone, $message);

一个额外的功能是您可以定义要使用哪些设置(以及哪些发送者电话号码)

Twilio::from('call_center')->message($user->phone, $message);
Twilio::from('board_room')->message($boss->phone, 'Hi there boss!');

在您的 twilio 配置文件 中定义多个条目以利用此功能。

用法

创建一个 Twilio 对象。此对象实现了 Fleetbase\Twilio\TwilioInterface

$twilio = new Fleetbase\Twilio\Twilio($accountId, $token, $fromNumber);

发送短信

$twilio->message('+18085551212', 'Pink Elephants and Happy Rainbows');

创建一个通话

$twilio->call('+18085551212', 'http://foo.com/call.xml');

一次生成一个通话并构建消息

$twilio->call('+18085551212', function (\Twilio\TwiML\VoiceResponse $message) {
    $message->say('Hello');
    $message->play('https://api.twilio.com/cowbell.mp3', ['loop' => 5]);
});

或者使用 任何 Twiml 描述进行通话,您可以传递任何 Twiml 对象

$message = new \Twilio\TwiML\VoiceResponse();
$message->say('Hello');
$message->play('https://api.twilio.com/cowbell.mp3', ['loop' => 5]);

$twilio->call('+18085551212', $message);

访问配置的 Twilio\Rest\Client 对象

$sdk = $twilio->getTwilio();

您也可以通过 Facade 访问它

$sdk = Twilio::getTwilio();
传递尽可能多的可选参数

如果您想将额外的可选参数传递给 messages->sendMessage(...) 方法 从 Twilio SDK,可以在 message 方法中这样做。所有参数都会传递,并且 from 字段将从配置中预置。

$twilio->message($to, $message, $mediaUrls, $params);
// passes all these params on.

对于 调用方法 也是如此。

$twilio->call($to, $message, $params);
// passes all these params on.

示例类

有一个 TwilioInterface 的示例实现:Fleetbase\Twilio\Dummy。此类允许您在需要快速集成测试时注入此代替有效实现。

日志装饰器

还有一个可供您使用的类:Fleetbase\Twilio\LoggingDecorator。此类包装任何 TwilioInterface 对象并为您记录 Twilio 将执行的操作。它还接受一个 Psr\Log\LoggerInterface 对象(如 Monolog)进行日志记录,您知道。

默认情况下,服务提供者不会用 LoggingDecorator 包装对象,但如果需要,它可供您使用。一个可能的用例是构建一个记录将要发生什么但不实际调用 Twilio(使用 Dummy 类)的 TwilioInterface 对象。

if (getenv('APP_ENV') === 'production') {
    $twilio = $container->make(\Fleetbase\Twilio\Manager::class);
} else {
    $psrLogger = $container->make(\Psr\Log\LoggerInterface::class);
    $twilio = new LoggingDecorator($psrLogger, new \Fleetbase\Twilio\Dummy());
}

// Inject it wherever you want.
$notifier = new Notifier($twilio);

致谢

许可证

laravel-twilio 是在 MIT 许可证 下开源的软件