API

Questa sezione è la documentazione tecnica per l'integrazione del nostro servizio di invio di SMS con l'applicazione / il sito Web. Per ottenere il token necessario per utilizzare l'API è necessario creare un account.

Invio di SMS

Per inviare o programmare un SMS devi fare una richiesta tramite il metodo POST per indirizzare: https://www.smsadvert.io/api/sms/ digitare application/json

Esempio di invio di SMS tramite smsadvert.ro rete

La consegna dell'SMS avviene immediatamente dopo la tua richiesta.

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

Esempio di invio di SMS tramite i propri dispositivi

La consegna dell'SMS avviene immediatamente dopo la tua richiesta.

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

{
  "phone": "+40740123456",
  "shortTextMessage": "Questo è il contenuto del messaggio SMS"
}

Esempio di invio di SMS tramite i propri dispositivi con failover

Se non si dispone di alcun dispositivo connesso o l'operatore GSM risponde con un messaggio di errore, l'SMS verrà inviato tramite smsadvert.ro rete

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

{
  "phone": "+40740123456",
  "shortTextMessage": "Questo è il contenuto del messaggio SMS",
  "failover": "short"
}

Esempio di invio di programmi SMS

La consegna dell'SMS avviene secondo i parametri startDate e endDate.

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

{
  "phone": "+40740123456",
  "shortTextMessage": "Questo è il contenuto del messaggio SMS",
  "startDate": 1486883578036,
  "endDate": 1486889778036
}

Esempio di invio di SMS con più destinatari

La consegna degli SMS ai destinatari viene effettuata una ad una, immediatamente dopo la richiesta.

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

{
  "phone": "+40740123456,+40740123457,+40740123458",
  "shortTextMessage": "Questo è il contenuto del messaggio SMS"
}

Esempio di invio di SMS con richiamata del rapporto di consegna

La consegna dell'SMS avviene immediatamente dopo la tua richiesta. Riceverai quindi una richiesta all'indirizzo dal parametro callback con rapporto di consegna.

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

{
  "phone": "+40740123456",
  "shortTextMessage": "Questo è il contenuto del messaggio SMS",
  "callback": "http://yourwebsite.com/callback-url/"
}

Descrizione dei parametri

  • phone

    string, obbligatorio
  • Rappresenta il numero di telefono del destinatario.
    Il numero deve essere nel formato internazionale E.164 (Es: +40740123456)

    Per più destinatari, puoi inserire i tuoi numeri di telefono separati da virgole, ad es. "+40740123456,+40740123457".
    Fino a 1000 numeri di telefono e i numeri duplicati non verranno registrati per l'invio.
    Attenzione! La virgola non è accettata alla fine dell'elenco.

  • shortTextMessage

    string, obbligatorio
  • Rappresenta il contenuto del messaggio SMS e deve contenere un minimo di 3 e un massimo di 480 caratteri.

  • sendAsShort

    boolean, opzionale
  • Per inviare SMS tramite smsadvert.ro rete questo parametro deve contenere il valore true. Nel caso in cui questo parametro abbia valore false o non sia presente, il messaggio verrà inviato attraverso i tuoi dispositivi.

  • startDate

    integer, opzionale
  • Rappresenta la data / ora / minuto / secondo dopo la quale inizierà l'invio del messaggio. Il formato è tempo UNIX (millisecondi).

  • endDate

    integer, opzionale
  • Rappresenta la data / ora / minuto / secondo dopo la quale l'invio del messaggio verrà interrotto. Il formato è tempo UNIX (millisecondi).

  • failover

    string, opzionale
  • Rappresenta il canale di invio secondario.
    Se il messaggio non può essere recapitato tramite i tuoi dispositivi (non esiste almeno un dispositivo collegato o l'operatore GSM risponde con un messaggio di errore), l'invio verrà tentato tramite il canale secondario.

    Se il il parametro failover è impostato come "short", quindi l'SMS verrà inviato tramite smsadvert.ro rete.

  • callback

    string, opzionale
  • Rappresenta l'indirizzo Web (URL) a cui riceverai una richiesta contenente lo stato di consegna del messaggio.

    La richiesta sarà di tipo POST (application/json) e conterrà due parametri: status con valore "delivered" o "failed" e msgId rappresentano l'id del messaggio ricevuto come risposta dalla richiesta di invio.

    Esempio di richiesta ricevuta all'URL di richiamata

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

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

Risposta

La risposta ricevuta dalla richiesta è di tipo application/json.

Esempio di risposta riuscita

Content-Type: application/json

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

Esempi di risposta all'errore

Content-Type: application/json

{
  "errors": {
    "phone": "Numero di telefono invalido!",
    "shortTextMessage": "Inserisci un minimo 3 caratteri!"
  }
}

Content-Type: application/json

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