API

Ta sekcja to dokumentacja techniczna integracji naszej usługi wysyłania SMS-ów z twoją aplikacją / witryną Aby uzyskać niezbędny token do korzystania z interfejsu API, musisz utworzyć konto.

Wysyłanie SMS-ów

Aby wysłać lub zaplanować wiadomość SMS, musisz zrobić zapytanie za pomocą metody POST w celu adresu: https://www.smsadvert.io/api/sms/ wpisz application/json

Przykład wysyłania wiadomości SMS za pośrednictwem smsadvert.ro sieci

Dostawa SMS-a odbywa się natychmiast po złożeniu zapytania.

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

Przykład wysyłania wiadomości SMS za pomocą własnych urządzeń

Dostawa SMS-a odbywa się natychmiast po złożeniu zapytania.

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

{
  "phone": "+40740123456",
  "shortTextMessage": "To jest treść wiadomości SMS"
}

Przykład wysyłania wiadomości SMS za pomocą własnych urządzeń z przełączaniem awaryjnym

Jeśli nie masz żadnych podłączonych urządzeń lub operator GSM odpowie komunikatem o błędzie, wiadomość SMS zostanie wysłana za pośrednictwem smsadvert.ro sieci

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

{
  "phone": "+40740123456",
  "shortTextMessage": "To jest treść wiadomości SMS",
  "failover": "short"
}

Przykład wysyłania harmonogramu SMS

Dostawa SMS odbywa się zgodnie z parametrami startDate i endDate.

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

{
  "phone": "+40740123456",
  "shortTextMessage": "To jest treść wiadomości SMS",
  "startDate": 1486883578036,
  "endDate": 1486889778036
}

Przykładowe wysyłanie wiadomości SMS z wieloma adresatami

Dostarczenie wiadomości SMS do adresatów odbywa się pojedynczo, natychmiast po złożeniu wniosku.

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

{
  "phone": "+40740123456,+40740123457,+40740123458",
  "shortTextMessage": "To jest treść wiadomości SMS"
}

Przykład wysłania wiadomości SMS z oddzwonieniem do raportu dostawy

Dostawa SMS-a odbywa się natychmiast po złożeniu zapytania. Otrzymasz wówczas żądanie na adres z parametru callback z raportem dostawy.

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

{
  "phone": "+40740123456",
  "shortTextMessage": "To jest treść wiadomości SMS",
  "callback": "http://twojastrona.com/callback-url/"
}

Opis parametrów

• phone

  string, obowiązkowy
• Reprezentuje numer telefonu odbiorcy.
  Numer musi być w formacie międzynarodowym E.164 (np .: +40740123456)
  
  W przypadku wielu odbiorców można wprowadzić numery telefonów oddzielone przecinkami, np. „+40740123456,+40740123457”.
  Maksymalnie 1000 numerów telefonów i numery, które są duplikatami, nie będą rejestrowane do przesłania.
  Uwaga! Przecinek nie jest akceptowany na końcu listy.
  

• shortTextMessage

  string, obowiązkowy
• Reprezentuje treść wiadomości SMS i musi składać się z co najmniej 3 i maksymalnie 480 znaków.

• sendAsShort

  boolean, opcjonalny
• Aby wysłać SMS przez sieć smsadvert.ro, parametr ten musi zawierać wartość true. W przypadku, gdy ten parametr ma wartość false lub nie jest obecny, wiadomość zostanie wysłana przez twoje urządzenia.

• startDate

  integer, opcjonalny
• Reprezentuje datę / godzinę / minutę / sekundę, po której rozpocznie się wysyłanie wiadomości. Format to czas UNIX (milisekundy).

• endDate

  integer, opcjonalny
• Reprezentuje datę / godzinę / minutę / sekundę, po której wysyłanie wiadomości zostanie zatrzymane. Format to czas UNIX (milisekundy).

• failover

  string, opcjonalny
• Reprezentuje dodatkowy kanał wysyłający.
  Jeśli wiadomość nie może zostać dostarczona przez twoje urządzenia (nie ma co najmniej jednego podłączonego urządzenia lub operator GSM odpowiada komunikatem o błędzie), próba wysłania zostanie podjęta przez drugi kanał.
  
  Jeśli parametr failover jest ustawiony na „short”, wtedy SMS zostanie wysłany przez smsadvert.ro sieć.

• callback

  string, opcjonalny
• Reprezentuje adres internetowy (URL), na który otrzymasz żądanie zawierające status dostarczenia wiadomości.
  
  Żądanie będzie typu POST (application/json) i będzie zawierało dwa parametry: status o wartości „delivered” lub „failed” i msgId reprezentujące identyfikator otrzymanej wiadomości w odpowiedzi na żądanie wysyłania.
  
  

  Przykład żądania, które otrzymasz na swój adres zwrotny

  POST http://twojastrona.com/callback-url/ HTTP/1.1
  Content-Type: application/json
  
  {
    "status": "delivered",
    "msgId": "xxxxxx"
  }
  

Odpowiedź

Odpowiedź otrzymana przez żądanie jest typu application/json.

Przykład udanej odpowiedzi

Content-Type: application/json

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

Przykłady odpowiedzi na błąd

Content-Type: application/json

{
  "errors": {
    "phone": "Nieprawidłowy numer telefonu!",
    "shortTextMessage": "Wpisz minimum 3 znaków!"
  }
}

Content-Type: application/json

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