korko/callr

一个用于在 Laravel 中处理 Callr 的简单库。

维护者

详细信息

framagit.org/Korko/callr

主页

1.1.0 2017-12-29 09:59 UTC

This package is auto-updated.

Last update: 2024-08-29 04:31:26 UTC


README

此包仅实现了 Callr API 并添加了一个层,以便快速在 Laravel 5.4 中使用。

安装

为了安装此包,您只需执行此命令(使用 Composer)

composer install korko/callr

Laravel 5.5+

如果您使用的是 Laravel 5.5 或更高版本,由于 Laravel 5.5 中添加的自动发现,提供者已经设置好了。如果您想的话,仍然可以添加别名,就像 Laravel 5.4 中描述的那样。

Laravel 5.4 及以下

您必须手动添加提供者,也许还想要添加一个外观(facade)。

提供者

config/app.php 文件中,添加提供者

Korko\Callr\CallrServiceProvider::class

别名

如果您想使用别名来测试并删除此特定包与您的代码之间的链接,您可以在 config/app.php 中添加一个类似这样的别名

'Sms'          => Facades\Korko\Callr\CallrClient::class,

我更喜欢在测试时使用外观(facade)作为别名,但您应该能够直接使用 Korko\Callr\CallrClient::class,因为它已经是一个单例。

配置

我倾向于使用 .env 文件来指定我的配置,特别是因为我的一些项目是开源的,所以如果您想使用相同的系统,只需在您的 .env 文件中添加此内容即可

CALLR_USERNAME = <my callr username>
CALLR_PASSWORD = <my callr password>
CALLR_ALIAS = <my callr alias, once added to my account, if I want to use one>
CALLR_SENDER = <my callr sender, once added to my account, if I want to use one>

如果您想直接将配置包含到项目中,可以使用命令 php artisan vendor:publish。这将导入 callr 配置文件,然后您可以直接在此文件中更改值。

用法

命令

为了测试我的实现,我可以使用命令 `php artisan callr:sms`

客户端调用

在我的代码中,我只需调用客户端(我使用之前添加的别名)

Sms::message(<number in "+prefix number" format>, <message>, <mode=CallrClient::ALERTING>);

模式也可以取 CallrClient::MARKETING 的值。这些常量只是 API 中使用的 "ALERTING" 和 "MARKETING" 值的别名。

您还可以调用 CallrClient::getApi() 来获取 callr API 的实例。