README

laravel-ovh-sms

安装

您可以通过 composer 安装此包

composer require tipytechnique/laravel-ovh-sms

使用

凭证

首先，您需要将您的 OVH 凭证设置在您的 .env 文件中

OVHSMS_APP_KEY = "your-app-key"
OVHSMS_APP_SECRET = "your-app-secret"
OVHSMS_CONSUMER_KEY = "your-consumer-key"
OVHSMS_ACCOUNT = "your-sms-account"
OVHSMS_SENDER = "your-sms-sender"

要创建您的凭证，您可以访问 https://api.ovh.com/createToken/index.cgi?GET=/sms&GET=/sms/*&PUT=/sms/*&DELETE=/sms/*&POST=/sms/*

可选地，您可以通过运行以下命令将此包的配置文件发布到您的 config 文件夹

php artisan vendor:publish --provider="TipyTechnique\LaravelOvhSms\SmsServiceProvider"

如果您正在使用 Themosis 框架，请运行

php console vendor:publish --provider="TipyTechnique\LaravelOvhSms\SmsServiceProvider"

示例

依赖注入与 Facade

您可以使用依赖注入或 Facade 来管理您的短信。

// Using depency injection

use Illuminate\Routing\Controller as BaseController;
use TipyTechnique\LaravelOvhSms\Contracts\Sms;

class SmsController extends BaseController
{
    /**
     * Get all outgoing messages
     *
     * @param Sms $sms
     *
     * @return array
     */
    public function getAllSms(Sms $sms): array
    {
        return $sms->getMessages('incoming');
    }
}

// Using Facade

use Illuminate\Routing\Controller as BaseController;
use TipyTechnique\LaravelOvhSms\Facades\Sms;

class SmsController extends BaseController
{
    /**
     * Get all outgoing messages
     *
     * @param Sms $sms
     *
     * @return array
     */
    public function getAllSms(Sms $sms): array
    {
        return Sms::getMessages('incoming');
    }
}

创建消息

/**
 * First parameter  : receivers, can be a single one (string) or multiple (array)
 * Second parameter : isMarketing, true or false
 * Thir parameter   : allowResponse, true or false
 */
$message = Sms::createMessage('+33654213566', false, false);
$message = Sms::createMessage(['+33654213566', '+33652147895'], false, true);

发送消息

$message = Sms::createMessage('+33654213566', false, false);
$message->send('Hello world');

// Or with a single line
Sms::createMessage('+33654213566', false, false)->send('Hello world');

获取消息

// get ongoing messages
$messages = Sms::getMessages('ongoing');

// get incoming messages
$messages = Sms::getMessages('incoming');

// get planned messages
$messages = Sms::getMessages('planned');

// for ongoing and incoming messages, you can use a second argument to set filters
// all filters are optionals
$messages = Sms::getMessages(
    'ongoing', 
    [
        'dateStart' => '2019-07-01 12:00:00',    // using date as a string
        'dateEnd' => new DateTime('2019-08-01'), // using DateTime object
        'sender' => 'your-sender',
        'receiver' => 'a-receiver',
        'tag'  => 'a-tag'   
    ]
);

处理黑名单号码

// get all blacklisted numbers
$blasklisted = Sms::getBlacklistedNumbers(); // array

// remove a given number from the blacklist
Sms::removeBlacklistedNumber('+33654632544');

测试

composer test

变更日志

请参阅 CHANGELOG 以获取有关最近更改的更多信息。

贡献

请参阅 CONTRIBUTING 以获取详细信息。

问题

请使用问题跟踪器提交您的问题。

鸣谢

许可证

MIT 许可证 (MIT)。有关更多信息，请参阅许可证文件。

tipytechnique / laravel-ovh-sms

维护者

详细信息