cri2net/sms-fly

PHP Library for sms-fly service

1.0.7 2021-07-19 23:09 UTC

This package is auto-updated.

Last update: 2024-05-20 05:07:43 UTC


README

Эта библиотека зависит от пакета cri2net/sms-client и предназначена для отправки sms через шлюз sms-fly.com Текущее описание расширяет описание cri2net/sms-client

Установка

composer require cri2net/sms-fly

Использование

Описание методов

Тут приведены лишь методы, использование которых отличается от описания в пакете cri2net/sms-client (либо не описанные ранее)

  • sendSMS($recipient, $text, $description = '') — отправка sms, добавлен необязательный параметр $description, отвечающий за описании кампании отправки (не влияет на отправку, отображается в web интерфейсе sms-fly.com)

  • getStateText($code) — статический метод, который отдаёт текстовое описание статуса от шлюза ("расшифровывает" кодировки статуса у шлюза)

  • sendSmsByCron() — отправка подготовленных sms, которые сохранены в БД

Примеры кода

обычная оправка

<?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'
    ]),
    // ...
];