API

Esta sección es la documentación técnica para integrar nuestro servicio de envío de SMS con su aplicación / sitio web. Para obtener el token necesario para usar la API, necesita crear una cuenta.

Enviando SMS

Para enviar o programar un SMS, debe hacer una solicitud a través del método POST para abordar: https://www.smsadvert.io/api/sms/ escriba application/json

Ejemplo de envío de SMS a través de la red smsadvert.ro

La entrega del SMS se realiza inmediatamente después de su solicitud.

var axios = require('axios');
var data = JSON.stringify({
  phone: '+40740123456',
  shortTextMessage: 'This is the content of the SMS message',
  sendAsShort: true
});

var config = {
  method: 'post',
  url: 'https://www.smsadvert.ro/api/sms/',
  headers: {
    Authorization: 'API_AUTH_TOKEN',
    'Content-Type': 'application/json'
  },
  data: data
};

axios(config)
  .then(function(response) {
    console.log(JSON.stringify(response.data));
  })
  .catch(function(error) {
    console.log(error);
  });

Ejemplo de envío de SMS usando sus propios dispositivos

La entrega del SMS se realiza inmediatamente después de su solicitud.

POST https://www.smsadvert.io/api/sms/ HTTP/1.1
Authorization: API_AUTH_TOKEN
Content-Type: application/json

{
  "phone": "+40740123456",
  "shortTextMessage": "Este es el contenido del mensaje SMS."
}

Ejemplo de envío de SMS utilizando sus propios dispositivos con conmutación por error

Si no tiene ninguno de sus dispositivos conectados o el operador GSM responde con un mensaje de error, el SMS se enviará a través de smsadvert.ro la red

POST https://www.smsadvert.io/api/sms/ HTTP/1.1
Authorization: API_AUTH_TOKEN
Content-Type: application/json

{
  "phone": "+40740123456",
  "shortTextMessage": "Este es el contenido del mensaje SMS.",
  "failover": "short"
}

Ejemplo de envío de horarios SMS

La entrega del SMS se realiza de acuerdo con los parámetros startDate y endDate.

POST https://www.smsadvert.io/api/sms/ HTTP/1.1
Authorization: API_AUTH_TOKEN
Content-Type: application/json

{
  "phone": "+40740123456",
  "shortTextMessage": "Este es el contenido del mensaje SMS.",
  "startDate": 1486883578036,
  "endDate": 1486889778036
}

Ejemplo de envío de SMS con múltiples destinatarios

La entrega del SMS a los destinatarios se realiza uno por uno, inmediatamente después de su solicitud.

POST https://www.smsadvert.io/api/sms/ HTTP/1.1
Authorization: API_AUTH_TOKEN
Content-Type: application/json

{
  "phone": "+40740123456,+40740123457,+40740123458",
  "shortTextMessage": "Este es el contenido del mensaje SMS."
}

Ejemplo de envío de SMS con devolución de llamada de informe de entrega

La entrega del SMS se realiza inmediatamente después de su solicitud. Luego recibirá una solicitud a la dirección del parámetro callback con el informe de entrega.

POST https://www.smsadvert.io/api/sms/ HTTP/1.1
Authorization: API_AUTH_TOKEN
Content-Type: application/json

{
  "phone": "+40740123456",
  "shortTextMessage": "Este es el contenido del mensaje SMS.",
  "callback": "http://yourwebsite.com/callback-url/"
}

Descripción de los parámetros.

  • phone

    string, obligatorio
  • Representa el número de teléfono del destinatario.
    El número debe estar en formato internacional E.164 (Ej: +40740123456)

    Para múltiples destinatarios, puede ingresar sus números de teléfono separados por comas, ej. "+40740123456,+40740123457".
    Hasta 1000 números de teléfono, y los números que están duplicados no se registrarán para su envío.
    ¡Advertencia! La coma no se acepta al final de la lista.

  • shortTextMessage

    string, obligatorio
  • Representa el contenido del mensaje SMS y debe constar de un mínimo de 3 y un máximo de 480 caracteres.

  • sendAsShort

    boolean, opcional
  • Para enviar SMS a través de la red smsadvert.ro, este parámetro debe contener el valor true. En el caso de que este parámetro tenga un valor false o no esté presente, el mensaje se enviará a través de sus dispositivos.

  • startDate

    integer, opcional
  • Representa la fecha / hora / minuto / segundo después de la cual comenzará el envío del mensaje. El formato es tiempo UNIX (milisegundos).

  • endDate

    integer, opcional
  • Representa la fecha / hora / minuto / segundo después de la cual se detendrá el envío del mensaje. El formato es tiempo UNIX (milisegundos).

  • failover

    string, opcional
  • Representa el canal de envío secundario.
    Si el mensaje no se puede entregar a través de sus dispositivos (no hay al menos un dispositivo conectado o el operador GSM responde con un mensaje de error) el envío se intentará a través del canal secundario.

    Si el parámetro failover se establece como "short", luego el SMS se enviará a través de smsadvert.ro la red.

  • callback

    string, opcional
  • Representa la dirección web (URL) donde recibirá una solicitud que contiene el estado de entrega del mensaje.

    La solicitud será de tipo POST (application/json) y contendrá dos parámetros: status con valor "delivered" o "failed" y msgId que representan la identificación del mensaje que recibió como respuesta de la solicitud de envío.

    Ejemplo de solicitud que recibe a su URL de devolución de llamada

    POST http://yourwebsite.com/callback-url/ HTTP/1.1
Content-Type: application/json

{
  "status": "delivered",
  "msgId": "xxxxxx"
}

Respuesta

La respuesta recibida por la solicitud es de tipo application/json.

Ejemplo de respuesta exitosa

Content-Type: application/json

{
  "successMessage": "Your message has been successfully submitted!",
  "msgId": "xxxxxx"
}

Ejemplos de respuesta a errores

Content-Type: application/json

{
  "errors": {
    "phone": "¡Numero de telefono invalido!",
    "shortTextMessage": "¡Ingrese caracteres mínimos 3!"
  }
}

Content-Type: application/json

{
  "errorMessage": "There was a database error!"
}