SMS API

POST https://api.ovh.com/1.0/sms/sms-aa1-1/jobs
{
  "message": "Test message",
  "receivers": ["+33601020304"],
  "senderForResponse": true
}

El destinatario recibirá un SMS procedente de un número corto con el contenido del campo «message», en este caso, «Test message».
La API devolverá el número de créditos consumidos, los destinatarios válidos y no válidos, y los identificadores de los SMS para poder consultar su estado.

POST https://api.ovh.com/1.0/sms/sms-aa1-1/jobs
{
  "message": "Test message",
  "receivers": ["+33601020304"],
  "diferedPeriod": 120,
  "senderForResponse": true
}

Es posible programar el envío de un SMS en una fecha posterior.

El campo «differedPeriod» permite posponer el envío. En el ejemplo, el envío se ha retrasado 120 minutos.

Puede consultar el estado del SMS utilizando la siguiente llamada, en el campo «deliveryReceipt»:

GET https://api.ovh.com/1.0/sms/sms-aa1-1/outgoing/123456

El campo «deliveryReceipt» puede contener los siguientes valores:

• 0 → Enviando
• 1 → Entregado
• 2 → Rechazado o expirado
• 4 → En espera en la red del operador del destinatario
• 8 → Transmitido a la red del operador del destinatario
• 16 → No distribuible

El campo «ptt» contiene información adicional.

Dicha información se presenta en forma de código, cuya descripción puede consultarse utilizando la siguiente llamada:

https://api.ovh.com/1.0/sms/ptts
{
  "ptt":  4
}

OVHcloud puede informarle en tiempo real del cambio de estado de un SMS mediante una llamada HTTP.

Para configurar la URL a la que quiere que se realice la llamada:

PUT https://api.ovh.com/1.0/sms/sms-aa1-1                        {                            "callBack": "http://www.misitio.com/callbackSmsOvh.php"                        }                    

Una vez configuradas las notificaciones, con cada cambio de estado de un SMS, se realizará una llamada a la URL indicada con los siguientes parámetros:

• Id → ID del SMS
• dlr → Estado de «deliveryReceipt»
• ptt → Estado de «ptt»
• date → Fecha de actualización del estado
• sender → Remitente del SMS
• receiver → Número del destinatario del SMS

Puede generar una orden de pedido a través de la API de OVHcloud:

POST https://api.ovh.com/1.0/order/sms/sms-aa1-1/credits                        {                            "quantity":     100                        }                    

OVHcloud le permite recargar su cuenta de SMS automáticamente cuando baje de un número de créditos determinado.

En ese caso, se generará automáticamente una orden de pedido, que será abonada también de forma automática utilizando la forma de pago configurada en su cuenta de cliente de OVHcloud.

Para configurar la recarga automática de 100 créditos cuando la cuenta tenga menos de 10 créditos:

PUT https://api.ovh.com/1.0/sms/sms-aa1-1                        {                            "automaticRecreditAmount":              100,                            "creditThresholdForAutomaticRecredit":  10,                        }                    

Para conocer con antelación el precio de su envío, puede utilizar la siguiente llamada:

GET https://api.ovh.com/1.0//sms/sms-aa1-1/seeOffers)                        {                            "countryDestination": "es",                            "countryCurrencyPrice": "es",                            "quantity": 1000,                        }                    

La llamada del ejemplo devuelve el precio del envío de 1000 SMS a España en la divisa utilizada en ese país (euros, en este caso).

Para optimizar el envío de SMS masivo, es posible precargar los destinatarios en un archivo CSV.

Para crear un archivo de destinatarios:

POST https://api.ovh.com/1.0/sms/sms-aa1-1/receivers                        {                            "csvUrl":       "http://misitio.com/mis_destinatarios.csv",                            "description":  "Lista de clientes",                            "slotId":       1                        }                    

El archivo debe incluir al menos una columna «number» con el número de teléfono de los destinatarios. Opcionalmente, puede incluir otras columnas, que se utilizarán para sustituir variables en los envíos. Ejemplo de archivo:

number;name;age                        +33601020304;García;47                        +33602030405;Martín;36                        +33603040506;López;39                    

Para enviar un SMS a todos los destinatarios del archivo anterior, utilice la siguiente llamada:

POST https://api.ovh.com/1.0/sms/sms-aa1-1/jobs                        {                            "message":              "Hola, Sr. #NAME#. ¡Felicidades por su #AGE# cumpleaños!",                            "receiversSlotId":      1,                            "senderForResponse":    true                            "tag": "MiCampaña"                        }                    

Con esta llamada, los tres destinatarios recibirán un mensaje personalizado.
Por ejemplo, el señor García recibirá el mensaje «Hola, Sr. García. ¡Felicidades por su 47 cumpleaños!».

Si, además, añade el parámetro «tag», podrá buscar los SMS correspondientes al envío mediante la siguiente llamada:

GET https://api.ovh.com/1.0//sms/sms-aa1-1/outgoing)                            {                                "tag": "MiCampaña"                        }                    

Tenga en cuenta que, de este modo, la llamada https://api.ovh.com/1.0/sms/sms-aa1-1/jobs no devolverá los ID de los SMS, ya que el envío se realizará de forma asíncrona.