cri2net/sms-fly

PHP 库,用于 sms-fly 服务

1.0.7 2021-07-19 23:09 UTC

This package is auto-updated.

Last update: 2024-09-20 05:56:49 UTC


README

这个库依赖于包 cri2net/sms-client,并用于通过 sms-fly.com 通道发送短信。当前描述扩展了 cri2net/sms-client 的描述

安装

composer require cri2net/sms-fly

使用

方法描述

这里只列出了与 cri2net/sms-client 包描述不同的方法(或之前未描述的)

  • sendSMS($recipient, $text, $description = '') — 发送短信,添加了可选参数 $description,用于描述发送活动(不影响发送,但在 sms-fly.com 网页界面中显示)

  • getStateText($code) — 静态方法,返回网关的状态文本描述("解密"网关的状态代码)

  • sendSmsByCron() — 发送保存在数据库中的已准备短信

代码示例

普通发送

<?php

$sms = new \cri2net\sms_fly\SMS_fly($login, $password);
$sms->alfaname = 'SMS.TEST'; // by default InfoCenter

$data = $sms->sendSMS('+380480000000', 'Hello!');
var_dump($data); // array('campaignID' => 1111, 'status' => 'ACCEPTED')

数据库发送

要从数据库发送,需要创建一个数据库表,如 cri2net/sms-client 包中所述

此外,还需要通过库 cri2net/php-pdo-db 初始化与数据库的连接

<?php

// сохранение sms в БД для отправки
$arr = [
    'to'               => '+380480000000',
    'created_at'       => microtime(true),
    'updated_at'       => microtime(true),
    'min_sending_time' => microtime(true), // отправка прямо сейчас, но можно указать время в будущем для отложенной отправки
    'replace_data'     => json_encode([
        'username'     => 'John', // массив с правилами замен
    ]),
    'raw_text'         => 'Привет, {{username}}!', // переменные в тексте следует обрамлять в двойные фигурный кавычки
];
$insert_sms_id = \cri2net\php_pdo_db\PDO_DB::insert($arr, 'sms_table_name');


// непосредственно отправка, предположительно в кроне
$sms = new \cri2net\sms_fly\SMS_fly($login, $password);
$sms->table = 'sms_table_name'; // нужно создать таблицу в БД

$sms->sendSmsByCron();
$sms->checkStatusByCron();

在数据库中保存时,可以使用 additional 字段。该字段仅用于用户。例如,可以将与另一个实体的 JSON 关联或任何其他信息保存到其中

默认情况下,processing 字段为 NULL。在这种情况下,sms 将尝试通过任何可用的网关发送,发送后用其键填充该字段。但可以在插入数据库时指定该字段,这样 sms 就只能通过特定的网关发送。

<?php

$arr = [
    // ...
    'processing' => $sms->getProcessingKey(),
    'additional' => json_encode([
        'payment_id' => '10'
    ]),
    // ...
];