smsglobal php

Bibliothèque cliente smsglobal php

API REST SMSGlobal et bibliothèques pour PHP

Il s'agit d'une bibliothèque client PHP pour l'API REST de SMSGlobal permettant d'intégrer les fonctionnalités SMS dans votre application PHP.

Créez un compte SMSGlobal gratuit dès aujourd'hui et obtenez votre clé API sur notre plateforme SMS avancée, MXT. De plus, profitez de tests sandbox gratuits et illimités pour les développeurs pour tester votre API dans son intégralité !

Exigences

• PHP 7.3 et supérieur
• Guzzle7 (client HTTP PHP)

Installation

Pour installer la bibliothèque client PHP sur votre projet, nous vous recommandons d'utiliser Composer.

composer require smsglobal/smsglobal-php

Usage

Consultez le dossier examples

Envoyer des SMS

 <?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 ();
}

Envoyer 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 ();
}

La réponse json suivante sera renvoyée par le serveur :

{
    "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 "
}

Vérifier OTP

Le code OTP saisi par votre utilisateur peut être vérifié en utilisant requestId ou destination number . Voici des exemples de chaque méthode :

 <?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 ();
}

La réponse json suivante sera renvoyée par le serveur si la vérification est réussie :

{
    "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 "
}

Annuler l'OTP

La demande OTP peut être annulée si un OTP n'est pas encore expiré et vérifié. Cela peut être fait en utilisant requestId ou destination number . Voici des exemples de chaque méthode :

 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 ();
}

La réponse json suivante sera renvoyée par le serveur si l'annulation réussit :

{
    "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 "
}

Ressources API REST disponibles

• SMS
• SMS entrants
• OTP (bêta)
• Utilisateur

Tests unitaires

Installer les dépendances de développement

composer require smsglobal/smsglobal-php

Exécuter des tests unitaires

./vendor/bin/phpunit tests

Avec couverture (nécessite l'extension pcov ou xdebug)

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

Obtenir de l'aide

Consultez la documentation de l'API REST pour obtenir la liste des ressources disponibles.

Pour toute question contactez-nous