Dokumentacja API
Transkrypt
Dokumentacja API
Dokumentacja API HTTP v. 0.2.1 Zawsze wymagane parametry service api token Twój identyfikator usługi dostępny w panelu klienta Twój identyfikator API dostępny w panelu klienta Token zabezpieczający konto API dostępny w panelu klienta http://fabrykasms.pl/api/acc/ przy koncie api wybieramy “zdalne używanie” aby uzyskać wszystkie wymagane informacje dotyczące w/w parametrów. Wysyłanie wiadomości SMS link (POST/GET) https://api.fabrykasms.pl/0.2/http/sms/send dest numer pod który wiadomość ma zostać dostarczona (11 znaków) text treść wiadomości która ma zostać wysłana (max 160 / 612 znaków) Opcjonalne parametry orig Nazwa nadawcy która jest zatwierdzona w systemie Fabrykasms.pl (string) send_at Data wysłania wiadomości (DateTime) long Wiadomość o maksymalnej długości 612 znaków. (true/false) test Symulacja wysyłki (true/false) Odpowiedzi 29 Brak jednego z wymaganych parametrów (service, api, token). 27 Niepoprawna autoryzacja. Sprawdź czy service, api oraz token są poprawne. 19 Parametr dest jest niepoprawny. 18 Parametr text jest niepoprawny. 10 Parametr orig jest niepoprawny. Sprawdź czy masz uprawnienia do tej nazwy nadawcy 1 Przykładowa odpowiedź (json) Wiadomość wysłana poprawnie {"api":{"status":200,"response":1,"error":false,"sms":{"id":11231233}}} Masowe wysyłanie wiadomości link (POST/GET) https://api.fabrykasms.pl/0.2/http/package/send dest tablica numerów pod które wiadomości mają zostać dostarczone text treść wiadomości bądź tablica z treściami dla tablicy numerów (do 160 znaków) Opcjonalne parametry orig send_at test Nazwa nadawcy która jest zatwierdzona w systemie Fabrykasms.pl Data wysłania wiadomości Symulacja wysyłki wiadomości Odpowiedzi 29 Brak jednego z wymaganych parametrów (service, api, token). 27 Niepoprawna autoryzacja. Sprawdź czy service, api oraz token są poprawne. 19 Parametr dest jest niepoprawny. 18 Parametr text jest niepoprawny. 17 Tablice dest, text mają różne identyfikatory. 10 Parametr orig jest niepoprawny. Sprawdź czy masz uprawnienia do tej nazwy nadawcy 1 Wiadomość została poprawnie wysłana. Sprawdzanie wiadomości SMS link (POST/GET) https://api.fabrykasms.pl/0.2/http/sms/get sms numer identyfikacyjny wiadomości sms zwrócony przez system podczas wysyłki Odpowiedzi 29 Brak jednego z wymaganych parametrów (service, api, token). 27 Niepoprawna autoryzacja. Sprawdź czy service, api oraz token są poprawne. 15 Podany identyfikator sms nie występuje w systemie. 1 Przykładowa odpowiedź (json) Informacje odebrane poprawnie {"api":{"status":200,"response":1,"error":false,"sms":{"id":"66785","phonenum ber":"48666888777","created_at":{"date":"20121024 15:20:05","timezone":"Europe\/Warsaw"},"deleted_at":null,"send_at":null,"se nt_at":{"date":"20121024 15:20:05","timezone":"Europe\/Warsaw"},"status":1}}} Kasowanie zaplanowanej wiadomości SMS link (POST/GET) https://api.fabrykasms.pl/0.2/http/sms/cancel sms numer identyfikacyjny wiadomości sms zwrócony przez system podczas wysyłki Odpowiedzi 29 Brak jednego z wymaganych parametrów (service, api, token). 27 Niepoprawna autoryzacja. Sprawdź czy service, api oraz token są poprawne. 15 Podany identyfikator sms nie występuje w systemie. 1 Przykładowa odpowiedź (json) Informacje odebrane poprawnie {"api":{"status":200,"response":1,"error":false,"sms":{"id":"66785","deleted_at ":{"date":"20121021 15:20:05","timezone":"Europe\/Warsaw"}}}}