SOAP API

Resumen

En SOAP se encuentra el lenguaje de definición de servicios web (WSDL) de Modica, más información: https://api.modicagroup.com/ModicaSoap.wsdl

Para enviar un SMS a través de SOAP, use la operación sendMessage.

Debe acceder al servicio web a través de https; los intentos de usar http se redirigirán a su URL de http equivalente.

Parámetros

El método SOAP que se utiliza para entregar un SMS a un teléfono móvil se denomina ‘sendMessage’ en WSDL. Los parámetros de este método son:

(*campos obligatorios marcados con un asterisco)

• Para obtener más información sobre los conjuntos de caracteres SMS y la concatenación de SMS, visite: https://en.wikipedia.org/wiki/Concatenated_SMS

• Modica puede entregar un conjunto completo de caracteres GSM 0.038, sin incluir los siguientes caracteres: ¤ ¡ § |

• https://en.wikipedia.org/wiki/GSM_03.38

Envío SMS (SOAP)

Para enviar su aplicación de SMS a través de SOAP, use el método sendMessage como se define en la WSDL .

Respuestas MO

Si ha proporcionado una URL de respuesta MO en Omni.

Cuando se recibe un mensaje MO y se enruta a su aplicación, se realiza una solicitud GET a la URL de devolución de llamada de MO. Puede establecer esta URL aquí: https://omni.modicagroup.com/gateway/api_config/soap. Cuando configura la URL de respuesta MO, su URL no debe contener una query string, ya que se agrega automáticamente.

Recomendamos el uso de https: // para sus URL de respuesta.

NOTA :   El certificado de seguridad debe coincidir con el nombre de *dominio que se está utilizando, los certificados autofirmados no se verificarán *y generarán errores.  

Su servidor recibirá una solicitud GET como esta:

GET https://yourserver.example.com/receiveMessage?id=12345&source=%2B642741234567&destination=4433&content=SMS+message+content+here&operator=Telecom_NZ

El contendrá los siguientes parámetros GET:

Si el mensaje del teléfono contiene contenido binario, se proporcionará un parámetro adicional:

Mensajes DLR

Si ha proporcionado una URL de respuestas DLR en Omni.

Cuando se recibe un mensaje DLR para un mensaje MT enviado por su aplicación, se realiza una solicitud GET a la URL de respuestas DLR. Puede establecer esta URL aquí: https://omni.modicagroup.com/gateway/api_config/soap. Cuando configura la URL de respuestas DLR, su URL no debe contener una query string, ya que se agrega automáticamente.

Recomendamos el uso de https: // para sus URL de respuestas.

NOTA :   El certificado de seguridad debe coincidir con el nombre de dominio que se está utilizando, los certificados autofirmados no se verificarán y generarán errores.  

Su servidor recibirá una solicitud GET como esta:

GET https://yourserver.com/receiveStatus?id=54321&status=received

El contendrá los siguientes parámetros GET:

Cuando un mensaje SMS MT se envía correctamente a través de SOAP, se devuelve el ID de mensaje del gateway.

Para rastrear el estado de un mensaje, necesitará almacenar esa ID, ya que la respuesta de estado utilizará la ID para hacer referencia al mensaje.

Los estados posibles varían entre los operadores, por ejemplo, algunos operadores marcarán un mensaje como “rechazado” cuando el número de teléfono móvil no es válido, el teléfono no tiene crédito suficiente o el mensaje ha caducado. Otros operadores diferenciarán entre cada uno de estos eventos.

Tendrá que atender los siguientes estados:

Ejemplo : https://yourserver.com/receiveStatus?id=54321&status=received

Deberá especificar su URL aquí: https://omni.modicagroup.com/gateway/api_config/soap

Cuando un mensaje SMS MT se envía correctamente a través de SOAP, se devuelve el ID de mensaje al gateway.

Para rastrear el estado de un mensaje, necesitará almacenar esa ID, ya que la respuesta DLR de estado utilizará la ID para hacer referencia al mensaje.

Los estados posibles varían entre los operadores, por ejemplo, algunos operadores marcarán un mensaje como “rechazado” cuando el número de teléfono móvil no es válido, el teléfono no tiene crédito suficiente o el mensaje ha caducado. Otros operadores diferenciarán entre cada uno de estos eventos.

Ejemplo de cliente SOAP

<?php
define('WSDL_URL','https://api.modicagroup.com/ModicaSoap.wsdl');
define('APPLICATION', 'your_application_name');
define('PASSWORD', 'password');
define('SEND_TO_MOBILE','+6421xxxxxxx'); // Mobile # Intl Format
define('MESSAGE_CLASS','mt_message');
define('MESSAGE_REFERENCE','');

try {
    $client = new SoapClient(
        WSDL_URL,
        array(
            'trace' => true,
            'exceptions' => true
        )
    );
    $return = $client->sendMessage(
        array('application' => APPLICATION,
              'password'    => PASSWORD,
              'destination' => SEND_TO_MOBILE,
              'content'     => 'This is a test message.',
              'reference'   => MESSAGE_REFERENCE,
              'class'       => MESSAGE_CLASS)
    );
} catch (SoapFault $fault) {
    // log error here
}
?>

Códigos de Error

La respuesta que la puerta de enlace devuelva en los errores dependerá de la versión de API que solicite. Pueden ocurrir los siguientes errores:

Ayuda

¿Tienes problemas para integrarte con alguno de nuestros servicios? Visite nuestro servicio de asistencia técnica en https://omni.modicagroup.com/docs/es/ o póngase en contacto con support@modicagroup.com y le ayudaremos a resolverlo.