Dokumentacja SMS API

Niezależnie od formy otrzymywania SMS (przez Panel Partnera lub SMS wysyłany przez LINK). Użytkownik musi wysłać prawidłowy prefix pod prawidłowy numer premium. Nieprawidłowy prefix, lub SMS wysłany pod niewłaściwy numer nie będą przekazywane do Partnerów poza poniższym wyjątkiem:
System Numery-Premium.PL po wysłaniu SMS przez użytkownika na prawidłowy numer telefonu loguje dany msisdn na okres około 2 godzin. Oznacza to, że użytkownik w pierwszym SMS bezwzględnie musi podać prefix i wysłać wiadomość pod prawidłowy numer premium (wykupiony przez Partnera). Po prawidłowej wysyłce dany msisdn jest logowany w systemie Partnera na okres około 2 godzin, co oznacza, że od momentu wysłania pierwszego SMS’a w kolejnych SMS’ach już użytkownik nie musi podawać prefixu (zalecamy jednak przyzwyczajanie klientów do każdorazowego podawania prefixu tj. pierwszego słowa w treści sms) przez okres 2 godzin.

System komunikuje się Partnerem przez protokół HTTP metodą POST

System komunikuje się z Partnerem w momencie nadejścia SMS’a. Oczekujemy kodu odpowiedzi 201. Jeśli kod odpowiedzi jest inny niż 201 ewentualnie 200 system będzie ponawiał próbę wysyłki co 60 minut aż 20 razy. Zalecamy zapis SMS w Partnera bazie metodą edytuj lub zapisz na podstawie unikalnego id, wysyłanego przez Numery-Premium.PL. Po 20 próbach doręczenia danego SMS'a nie będzie on dalej dostarczany, pozostanie jednak widoczny w Panelu Zarządzania Usługą, oraz w billingu usług.

FORM_PARAMS POST

Wysyłka SMS nie jest przeznaczona do wysyłki masowej. Każdorazowa akcja wysyłki masowej (komunikaty (w tym reklamowe) o tej samej, bądź podobnej (zbliżonej) treści, do różnych msisdn w okresie 1 tygodnia, ilości powyżej 70 sztuk) zakończy się nałożeniem kary przez Numery-Premium.PL w stosunku do Partnera w wysokości 20 000 zł (dwadzieścia tysięcy złotych) z możliwością dochodzenia dalszych roszczeń prawnych przez okres 10 lat od momentu wysyłki.

Jeśli potrzebujesz masowej wysyłki SMS, najpierw należy napisać e-mail z proponowaną treścią komunikatu, ilością msisdn, pełnymi danymi administratora bazy, daty rozpoczęcia wysyłki i daty zakończenia wysyłki. Numery-Premium.PL mogą wyrazić zgodę na wskazaną wysyłkę lub jej odmówić nie podając przyczyn. Numery-Premium.PL wydają zezwolenie, bądź odmowę na takie zgłoszenie w terminie maksymalnym 7 dni roboczych (co należy uwzględnić w dacie rozpoczęcia wysyłki). Nie udzielenie odpowiedzi jest równe nie udzieleniu pozwolenia. Jednorazowo można wysłać maksymalnie 100 smsów (przez jedno zgłoszenie do API).

Informujemy, że pobieramy opłatę od każdego SMS’a w wysyłce masowej, nawet jeśli nie dotrze on do odbiorcy. SMS’y masowe nie docierają wyłącznie do odbiorców, którzy u swojego operatora zablokowali komunikaty reklamowe. Odpowiedzi na SMS’y i wysyłka SMSów realizowane są bez tej opcji. Proszę zwrócić uwagę na fakt, że celowa i nachalna wysyłka treści reklamowych przez odpowiedź na SMS, lub standardową wysyłkę SMS może stanowić naruszenie zasad współpracy i spowodować nałożenie kary przez UKE i/lub Numery-Premium.PL na Partnera.

Adres: https://numery-premium.pl/api/partner/replyToSms/
Metoda: POST

Wymagane Parametry

Oczekiwany kod odpowiedzi 202 oznaczający prawidłowe wysłanie odpowiedzi na SMS do użytkownika.
W przypadku kodu 200 zapytanie zostało poprawnie wykonane, jednak wystąpił problem z wysyłką SMS’a do klienta po stronie operatora użytkownika. Należy ponowić próbę wysyłki SMS’a za kilka minut.

$client = new \GuzzleHttp\Client();
$client->request('POST','https://numery-premium.pl/api/partner/replyToSms/',[
 'form_params' => [
  'apikey' => 'apikey otrzymany od Numery-Premium.PL',
  'spam' => 0,
  'prefix' => 'prefix uruchomiony przez partnera',
  'id' => 'id SMS’a otrzymane od Numery-Premium.PL poczas wysyłki SMS',
  'msisdn' => 'odpowiedź na SMS można wysłać tylko na numer telefonu, z którego przyszedł SMS',
  'la' => 'numer premium uruchomiony przez partnera do obsługi SMS', na którego użytkownik wysłał SMS, na którego odpowiadamy,
  'reply' => 'odpowiedź, która ma być wysłana do klienta'
 ]
]);

Adres: https://numery-premium.pl/api/partner/sendSms/
Metoda: POST

Wymagane Parametry

Proszę zwrócić uwagę na fakt, że tylko jeden msisdn wysyłamy w zależności od parametru spam

Oczekiwany kod odpowiedzi 202 oznaczający prawidłowe wysłanie odpowiedzi na SMS do użytkownika.
W przypadku kodu 200 zapytanie zostało poprawnie wykonane, jednak wystąpił problem z wysyłką SMS’a do klienta po stronie operatora użytkownika. Należy ponowić próbę wysyłki SMS’a za kilka minut.

$client = new \GuzzleHttp\Client();
$client->request('POST','https://numery-premium.pl/api/partner/sendSms/',[
 'form_params' => [
  'apikey' => 'apikey otrzymany od Numery-Premium.PL',
  'spam' => 0,
  'msisdn' => 'Numer telefonu do wysłania SMS',
  'la' => 'jeden z uruchomionych numerów premium przez partnera do obsługi SMS, wybrany dobrowolnie przez Partnera',
  'msg' => 'Treść SMS, która ma być dostarczona do klienta'
 ]
]);

1. v1.0 - Utworzenie API