API SMS

La API es un servicio simple y fiable que permite enviar SMS a todo el mundo. Integre el envío de SMS en sus algoritmos y procedimientos y disfrute del medio de comunicación más instantáneo y universal.

Casos prácticos

Recordatorios y citas por SMS

Recordar las citas por SMS es una forma muy fiable de asegurar la asistencia de los destinatarios del mensaje. Si atiende a sus clientes o pacientes con cita previa, envíeles recordatorios por SMS para evitar que se olviden de las citas concertadas.

Ventajas

  • API REST
  • Remitente personalizable
  • Acuse de recibo
  • Envío diferido
  • 200 000 SMS
  • Alta tasa de entrega y rutas redundadas
  • Cobertura mundial con 600 operadores

Más información sobre el envío de SMS a través de aplicaciones

Enviar el primer SMS
POST https://api.ovh.com/1.0/sms/sms-aa1-1/jobs
{
    "message":              "Mensaje de texto",
    "receivers":            ["+34601020304"],
    "senderForResponse":    true
}
                    

El destinatario recibirá un SMS proveniente 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.

Personalizar el remitente de un SMS

El servicio de SMS de OVHcloud permite personalizar los remitentes (hasta 11 caracteres alfanuméricos).
Para evitar posibles usurpaciones de identidad, es necesario validar previamente el nombre de los remitentes.


1 Para declarar un nuevo remitente:

POST https://api.ovh.com/1.0/sms/sms-aa1-1/senders
{
    "reason":   "Es mi empresa y necesito enviar SMS a mis clientes",
    "sender":   "SMS inc."
}
                    

2 Se iniciará un proceso de validación manual.
Para obtener el campo «status» y conocer el estado de la validación:

GET https://api.ovh.com/1.0/sms/sms-aa1-1/senders/SMS inc.
                    


3 El campo «status» puede contener los siguientes valores:

  • waitingValidation: Pendiente de validación.
  • refused: Validación denegada (puede consultar el motivo en el campo «comment»).
  • enable: Activado (ya puede utilizar el remitente).
  • disable: Desactivado (el remitente está temporalmente desactivado y puede reactivarlo en cualquier momento).

Una vez validado el remitente, ya podrá enviar SMS con él.

POST https://api.ovh.com/1.0/sms/sms-aa1-1/jobs
{
    "message":      "Mensaje de texto",
    "receivers":    ["+34601020304"],
    "sender":       "SMS inc."
}
                    


Programar el envío de un SMS
POST https://api.ovh.com/1.0/sms/sms-aa1-1/jobs
{
    "message":              "Mensaje de texto",
    "receivers":            ["+34601020304"],
    "differedPeriod":       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 diferido 120 minutos, de modo que el SMS se enviará dos horas más tarde.

Monitorizar el envío de un SMS

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: Imposible de entregar


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
}
                    
Recibir una notificación cuando cambie el estado de un SMS

OVHcloud permite recibir notificaciones en tiempo real cuando cambia el 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
Recargar manualmente una cuenta de SMS

Para 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
}
                    
Recargar la cuenta automáticamente al alcanzar un umbral determinado

Con OVHcloud no tendrá que preocuparse por el saldo de su cuenta de SMS.

Es posible recargarla 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,
}
                    
Enviar una campaña de SMS a varios destinatarios

Para optimizar los envíos masivos, 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
+34601020304;García;47
+34602030405;Martín;36
+34603040506;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.

Consultar el precio de los SMS hacia un destino

Para conocer el precio de un envío antes de realizarlo, 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 Francia en la divisa utilizada en ese país (euros, en este caso).

SDK para enviar SMS desde PHP

Área de clienteContactar con el equipo comercialWebmail OVHcloud Blog

¡Bienvenido/a a OVHcloud!

Identifíquese para contratar una solución, gestionar sus productos y servicios, y consultar sus pedidos

Conectar