API

Dit gedeelte is de technische documentatie voor het integreren van onze SMS-verzendservice met uw applicatie / website. Om het benodigde token te verkrijgen om de API te gebruiken, moet u een account aanmaken.

Sms verzenden

Om een sms te verzenden of te plannen, moet u een verzoek indienen via methode POST om te adresseren: https://www.smsadvert.ro/api/sms/ type application/json

Voorbeeld van het verzenden van sms via smsadvert.ro netwerk

De bezorging van de sms gebeurt onmiddellijk na uw verzoek.

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

Voorbeeld van het verzenden van sms-berichten met uw eigen apparaten

De bezorging van de sms gebeurt onmiddellijk na uw verzoek.

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

{
  "phone": "+40740123456",
  "shortTextMessage": "Dit is de inhoud van het sms-bericht"
}

Voorbeeld van sms-verzenden met uw eigen apparaten met failover

Als u geen van uw eigen verbonden apparaten heeft of de GSM-operator reageert met een foutmelding, wordt de sms verzonden via smsadvert.ro netwerk

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

{
  "phone": "+40740123456",
  "shortTextMessage": "Dit is de inhoud van het sms-bericht",
  "failover": "short"
}

Voorbeeld van het verzenden van SMS-schema's

De bezorging van de sms gebeurt volgens de parameters startDate en endDate.

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

{
  "phone": "+40740123456",
  "shortTextMessage": "Dit is de inhoud van het sms-bericht",
  "startDate": 1486883578036,
  "endDate": 1486889778036
}

Voorbeeld SMS-verzending met meerdere ontvangers

De levering van de sms aan de ontvangers gebeurt één voor één, onmiddellijk na uw verzoek.

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

{
  "phone": "+40740123456,+40740123457,+40740123458",
  "shortTextMessage": "Dit is de inhoud van het sms-bericht"
}

Voorbeeld van het verzenden van sms met terugbelrapportage

De bezorging van de sms gebeurt onmiddellijk na uw verzoek. U ontvangt dan een verzoek naar het adres van de parameter callback met afleverrapport.

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

{
  "phone": "+40740123456",
  "shortTextMessage": "Dit is de inhoud van het sms-bericht",
  "callback": "http://uwwebsite.com/callback-url/"
}

Beschrijving van parameters

  • phone

    string, verplicht
  • Het vertegenwoordigt het telefoonnummer van de ontvanger.
    Het nummer moet de internationale indeling hebben E.164 (bijv .: +40740123456)

    Voor meerdere ontvangers kunt u uw telefoonnummers invoeren, gescheiden door komma's, bijv. "+40740123456,+40740123457".
    Maximaal 1000 telefoonnummers en de nummers die duplicaat zijn, worden niet geregistreerd voor verzending.
    Waarschuwing! Komma wordt niet geaccepteerd aan het einde van de lijst.

  • shortTextMessage

    string, verplicht
  • Het vertegenwoordigt de inhoud van het sms-bericht en moet uit minimaal 3 en maximaal 480 tekens bestaan.

  • sendAsShort

    boolean, optioneel
  • Om een SMS via smsadvert.ro netwerk te verzenden, moet deze parameter de waarde true bevatten. In het geval dat deze parameter de waarde false heeft of niet aanwezig is, wordt het bericht via uw apparaten verzonden.

  • startDate

    integer, optioneel
  • Het vertegenwoordigt de datum / uur / minuut / seconde waarna het verzenden van het bericht zal beginnen. Het formaat is UNIX-tijd (milliseconden).

  • endDate

    integer, optioneel
  • Het vertegenwoordigt de datum / uur / minuut / seconde waarna het verzenden van het bericht stopt. Het formaat is UNIX-tijd (milliseconden).

  • failover

    string, optioneel
  • Het vertegenwoordigt het secundaire verzendkanaal.
    Als het bericht niet kan worden afgeleverd via uw apparaten (er is niet ten minste één aangesloten apparaat of de GSM-operator reageert met een foutmelding), wordt geprobeerd te verzenden via het secundaire kanaal.

    Als de parameter failover is ingesteld als "short" dan wordt de sms verzonden via smsadvert.ro netwerk.

  • callback

    string, optioneel
  • Vertegenwoordigt het webadres (URL) waar u een verzoek met de afleverstatus van het bericht zult ontvangen.

    Het verzoek is van het type POST (application/json) en bevat twee parameters: status met waarde "delivered" of "failed" en msgId staan voor de id van het bericht dat u het hebt ontvangen als antwoord op het verzendverzoek.

    Voorbeeld van een verzoek dat u ontvangt op uw callback-URL

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

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

Reactie

Het door het verzoek ontvangen antwoord is van het type application/json.

Voorbeeld van een succesvolle reactie

Content-Type: application/json

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

Voorbeelden van foutreacties

Content-Type: application/json

{
  "errors": {
    "phone": "Ongeldig telefoonnummer!",
    "shortTextMessage": "Voer minimaal 3 tekens in!"
  }
}

Content-Type: application/json

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