smsglobal php

Biblioteca cliente smsglobal php

API REST SMSGlobal y bibliotecas para PHP

Esta es una biblioteca de cliente PHP para la API REST de SMSGlobal para integrar capacidades de SMS en su aplicación PHP.

Regístrese hoy para obtener una cuenta SMSGlobal gratuita y obtenga su clave API de nuestra avanzada plataforma de SMS, MXT. Además, disfrute de pruebas ilimitadas y gratuitas en el entorno de pruebas para desarrolladores para probar su API en su totalidad.

Requisitos

• PHP 7.3 y superior
• Guzzle7 (cliente PHP HTTP)

Instalación

Para instalar la biblioteca cliente PHP en su proyecto, le recomendamos utilizar Composer.

composer require smsglobal/smsglobal-php

Uso

Consulte la carpeta examples

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

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

El servidor devolverá la siguiente respuesta 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 "
}

Verificar OTP

El código OTP ingresado por su usuario se puede verificar usando requestId o destination number . Los siguientes son ejemplos de cada método:

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

El servidor devolverá la siguiente respuesta json si la verificación se realiza correctamente:

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

Cancelar OTP

La solicitud de OTP se puede cancelar si una OTP aún no ha caducado ni verificado. Se puede hacer utilizando requestId o destination number . Los siguientes son ejemplos de cada método:

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

El servidor devolverá la siguiente respuesta json si la cancelación se realiza correctamente:

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

Recursos API REST disponibles

• mensajes de texto
• SMS entrantes
• OTP (beta)
• Usuario

Pruebas unitarias

Instalar dependencias de desarrollo

composer require smsglobal/smsglobal-php

Ejecutar pruebas unitarias

./vendor/bin/phpunit tests

Con cobertura (requiere extensión pcov o xdebug)

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

Obteniendo ayuda

Consulte la documentación de la API REST para obtener una lista de recursos disponibles.

Para cualquier consulta contáctanos