smsglobal php

Клиентская библиотека smsglobal php

SMSGlobal REST API и библиотеки для PHP

Это клиентская библиотека PHP для REST API SMSGlobal, позволяющая интегрировать возможности SMS в ваше приложение PHP.

Зарегистрируйте бесплатную учетную запись SMSGlobal сегодня и получите свой ключ API от нашей передовой SMS-платформы MXT. Кроме того, наслаждайтесь неограниченным бесплатным тестированием в песочнице для разработчиков, чтобы полностью опробовать свой API!

Требования

• PHP 7.3 и выше
• Guzzle7 (PHP HTTP-клиент)

Установка

Чтобы установить клиентскую библиотеку PHP в ваш проект, мы рекомендуем использовать Composer.

composer require smsglobal/smsglobal-php

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

Посмотрите папку examples

Отправить СМС

 <?php

require_once __DIR__ . ' /vendor/autoload.php ' ;

// get your REST API keys from MXT https://mxt.smsglobal.com/integrations
 SMSGlobal Credentials:: set ( ' YOUR_API_KEY ' , ' YOUR_SECRET_KEY ' );

$ sms = new  SMSGlobal  Resource  Sms ();

try {
    $ response = $ sms -> sendToOne ( ' DESTINATION_NUMBER ' , ' This is a test message. ' );
    print_r ( $ response [ ' messages ' ]);
} catch (  Exception $ e ) {
    echo $ e -> getMessage ();
}

Отправить OTP

 <?php

require_once __DIR__ . ' /vendor/autoload.php ' ;

// get your REST API keys from MXT https://mxt.smsglobal.com/integrations
 SMSGlobal Credentials:: set ( ' YOUR_API_KEY ' , ' YOUR_SECRET_KEY ' );

$ otp = new  SMSGlobal  Resource  Otp ();

try {
    $ response = $ otp -> send ( ' DESTINATION_NUMBER ' , ' {*code*} is your SMSGlobal verification code. ' );
    print_r ( $ response );
} catch (  Exception $ e ) {
    echo $ e -> getMessage ();
}

Сервер вернет следующий ответ json:

{
    "requestId" : " 404372541683674336263499 " ,
    "validUnitlTimestamp" : " 2020-11-18 16:24:51 " ,
    "createdTimestamp" : " 2020-11-18 16:22:51 " ,
    "lastEventTimestamp" : " 2020-11-18 16:22:51 " ,
    "destination" : " 61400000000 " ,
    "status" : " Sent "
}

Подтвердить одноразовый код

OTP-код, введенный вашим пользователем, можно проверить, используя requestId или destination number . Ниже приведены примеры каждого метода:

 <?php


require_once __DIR__ . ' /vendor/autoload.php ' ;

// get your REST API keys from MXT https://mxt.smsglobal.com/integrations
 SMSGlobal Credentials:: set ( ' YOUR_API_KEY ' , ' YOUR_SECRET_KEY ' );

$ otp = new  SMSGlobal  Resource  Otp ();

try {
    $ response = $ otp -> verifyByRequestId ( ' request Id ' , ' OTP code enterted by your user. ' );
    print_r ( $ response );
} catch (  Exception $ e ) {
    echo $ e -> getMessage ();
}

 <?php

require_once __DIR__ . ' /vendor/autoload.php ' ;

// get your REST API keys from MXT https://mxt.smsglobal.com/integrations
 SMSGlobal Credentials:: set ( ' YOUR_API_KEY ' , ' YOUR_SECRET_KEY ' );

$ otp = new  SMSGlobal  Resource  Otp ();

try {
    $ response = $ otp -> verifyByDestination ( ' destination number ' , ' OTP code enterted by your user. ' );
    print_r ( $ response );
} catch (  Exception $ e ) {
    echo $ e -> getMessage ();
}

Следующий ответ json будет возвращен сервером в случае успешной проверки:

{
    "requestId" : " 404372541683674336263499 " ,
    "validUnitlTimestamp" : " 2020-11-18 16:24:51 " ,
    "createdTimestamp" : " 2020-11-18 16:22:51 " ,
    "lastEventTimestamp" : " 2020-11-18 16:22:51 " ,
    "destination" : " 61400000000 " ,
    "status" : " Verified "
}

Отменить одноразовый код

Запрос OTP можно отменить, если срок действия OTP еще не истек и он еще не проверен. Это можно сделать, используя requestId или destination number . Ниже приведены примеры каждого метода:

 require_once __DIR__ . ' /vendor/autoload.php ' ;

// get your REST API keys from MXT https://mxt.smsglobal.com/integrations
 SMSGlobal Credentials:: set ( ' YOUR_API_KEY ' , ' YOUR_SECRET_KEY ' );

$ otp = new  SMSGlobal  Resource  Otp ();

try {
    $ response = $ otp -> cancelByRequestId ( ' request Id ' );
    print_r ( $ response );
} catch (  Exception $ e ) {
    echo $ e -> getMessage ();
}

 require_once __DIR__ . ' /vendor/autoload.php ' ;

// get your REST API keys from MXT https://mxt.smsglobal.com/integrations
 SMSGlobal Credentials:: set ( ' YOUR_API_KEY ' , ' YOUR_SECRET_KEY ' );

$ otp = new  SMSGlobal  Resource  Otp ();

try {
    $ response = $ otp -> cancelByDestination ( ' destination number ' );
    print_r ( $ response );
} catch (  Exception $ e ) {
    echo $ e -> getMessage ();
}

Следующий ответ json будет возвращен сервером в случае успешной отмены:

{
    "requestId" : " 404372541683674336263499 " ,
    "validUnitlTimestamp" : " 2020-11-18 16:24:51 " ,
    "createdTimestamp" : " 2020-11-18 16:22:51 " ,
    "lastEventTimestamp" : " 2020-11-18 16:22:51 " ,
    "destination" : " 61400000000 " ,
    "status" : " Cancelled "
}

Доступные ресурсы REST API

• SMS
• Входящие смс
• Одноразовый пароль (бета)
• Пользователь

Модульные тесты

Установить зависимости разработки

composer require smsglobal/smsglobal-php

Запускайте модульные тесты

./vendor/bin/phpunit tests

С покрытием (требуется расширение pcov или xdebug)

./vendor/bin/phpunit --coverage-text tests

Получение помощи

Просмотрите документацию по REST API, чтобы увидеть список доступных ресурсов.

По любому вопросу свяжитесь с нами