API

Cette section est la documentation technique pour intégrer notre service d'envoi de SMS à votre application / site Web. Pour obtenir le jeton nécessaire pour utiliser l'API, vous devez créer un compte.

Envoi de SMS

Pour envoyer ou programmer un SMS, vous devez faire une demande via la méthode POST pour adresser: https://www.smsadvert.io/api/sms/ type application/json

Exemple d'envoi de SMS via smsadvert.ro réseau

La livraison du SMS se fait immédiatement après votre demande.

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

Exemple d'envoi de SMS à l'aide de vos propres appareils

La livraison du SMS se fait immédiatement après votre demande.

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

{
  "phone": "+40740123456",
  "shortTextMessage": "C'est le contenu du message SMS"
}

Exemple d'envoi de SMS avec vos propres appareils avec basculement

Si vous n'avez aucun de vos propres appareils connectés ou si l'opérateur GSM répond avec un message d'erreur, le SMS sera envoyé via smsadvert.ro le réseau

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

{
  "phone": "+40740123456",
  "shortTextMessage": "C'est le contenu du message SMS",
  "failover": "short"
}

Exemple d'envoi d'horaires SMS

La livraison du SMS se fait selon les paramètres startDate et endDate.

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

{
  "phone": "+40740123456",
  "shortTextMessage": "C'est le contenu du message SMS",
  "startDate": 1486883578036,
  "endDate": 1486889778036
}

Exemple d'envoi de SMS avec plusieurs destinataires

La livraison du SMS aux destinataires se fait un par un, immédiatement après votre demande.

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

{
  "phone": "+40740123456,+40740123457,+40740123458",
  "shortTextMessage": "C'est le contenu du message SMS"
}

Exemple d'envoi de SMS avec rappel de rapport de livraison

La livraison du SMS se fait immédiatement après votre demande. Vous recevrez alors une demande à l'adresse du paramètre callback avec rapport de livraison.

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

{
  "phone": "+40740123456",
  "shortTextMessage": "C'est le contenu du message SMS",
  "callback": "http://votresite.com/callback-url/"
}

Description des paramètres

  • phone

    string, obligatoire
  • Il représente le numéro de téléphone du destinataire.
    Le numéro doit être au format international E.164 (Ex: +40740123456)

    Pour plusieurs destinataires, vous pouvez saisir vos numéros de téléphone séparés par des virgules, ex. "+40740123456,+40740123457".
    Jusqu'à 1000 numéros de téléphone, et les numéros qui sont en double ne seront pas enregistrés pour la soumission.
    Attention! La virgule n'est pas acceptée à la fin de la liste.

  • shortTextMessage

    string, obligatoire
  • Il représente le contenu du message SMS et doit être composé d'un minimum de 3 et d'un maximum de 480 caractères.

  • sendAsShort

    boolean, optionnel
  • Pour envoyer des SMS via smsadvert.ro le réseau, ce paramètre doit contenir la valeur true. Dans le cas où ce paramètre a une valeur false ou n'est pas présent, le message sera envoyé via vos appareils.

  • startDate

    integer, optionnel
  • Il représente la date / heure / minute / seconde après laquelle l'envoi du message commencera. Le format est l'heure UNIX (en millisecondes).

  • endDate

    integer, optionnel
  • Il représente la date / heure / minute / seconde après laquelle l'envoi du message s'arrêtera. Le format est l'heure UNIX (en millisecondes).

  • failover

    string, optionnel
  • Il représente le canal d'envoi secondaire.
    Si le message ne peut pas être transmis via vos appareils (il n'y a pas au moins un appareil connecté ou un opérateur GSM répond avec un message d'erreur), l'envoi sera tenté via le canal secondaire.

    Si le le paramètre failover est défini comme "short" puis le SMS sera envoyé via smsadvert.ro le réseau.

  • callback

    string, optionnel
  • Représente l'adresse Web (URL) où vous recevrez une demande contenant l'état de remise du message.

    La demande sera de type POST (application/json) et contiendra deux paramètres: status avec la valeur "delivered" ou "failed" et msgId représentant l'ID du message que vous l'avez reçu en réponse à la demande d'envoi.

    Exemple de demande que vous recevez sur votre URL de rappel

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

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

Réponse

La réponse reçue par la demande est de type application/json.

Exemple de réponse réussie

Content-Type: application/json

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

Exemples de réponse d'erreur

Content-Type: application/json

{
  "errors": {
    "phone": "Numéro de téléphone invalide!",
    "shortTextMessage": "Saisissez un minimum de caractères 3!"
  }
}

Content-Type: application/json

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