HTTP API - Wprowadzenie
HTTP API umożliwia wysyłanie i odbieranie wiadomości SMS za pośrednictwem bramki SMS Ozeki przy użyciu żądań HTTP. Żądania można wykonywać zarówno metodami GET, jak i POST, a także korzystać z protokołu http lub https, w zależności od konfiguracji.
Każde żądanie HTTP musi zawierać zestaw obowiązkowych parametrów. Są to: action, username i password. Parametr action definiuje polecenie do wykonania, a username i password służą do identyfikacji. Przewodnik Jak utworzyć konto użytkownika HTTP API zawiera informacje na temat tworzenia nazwy użytkownika i hasła.
Przykładowe żądanie HTTP:
https://127.0.0.1:9508/api?action=sendmessage&username=admin&password=abc123&
recipient=06203105366&messagedata=Hello+World
Przykładowa odpowiedź HTTP:
StatusCode: 200, ReasonPhrase: 'OK'
Zaleca się przetestowanie tego przykładu za pomocą narzędzia HTTP API Tester, które jest interfejsem graficznym do testowania API bramki SMS Ozeki. Tutorial dotyczący HTTP API Tester znajdziesz tutaj.
Obowiązkowe parametry w każdym żądaniu HTTP API
Parametr | Opis | Dopuszczalne wartości | Przykład | W/O* |
action | Nazwa akcji. | sendmessage, receivemessage, | action=sendmessage | W |
username | Określa nazwę użytkownika. Parametry username i password służą do uwierzytelnienia użytkownika. Wiadomość zostanie wysłana w imieniu uwierzytelnionego użytkownika. Wartość musi być zakodowana w URL. | wartość tekstowa | username=admin | W |
password | Określa hasło. Parametry username i password służą do uwierzytelnienia użytkownika. Wiadomość zostanie wysłana w imieniu uwierzytelnionego użytkownika. Wartość musi być zakodowana w URL. |
wartość tekstowa, minimalna długość: 6 znaków |
password=abc123 | W |
* W = Wymagany parametr, O = Opcjonalny parametr
Podsumowanie
W powyższym artykule przedstawiliśmy podstawowe informacje na temat HTTP API. Korzystanie z HTTP API oznacza, że możesz zarządzać wiadomościami SMS za pomocą żądań HTTP. Bramka SMS Ozeki jest kluczowym elementem tego systemu. Wysyłanie i odbieranie wiadomości SMS za pomocą żądań HTTP pozwala na zbudowanie systemu, który może obsługiwać SMS-y za pośrednictwem przeglądarki internetowej. Dzięki temu przepływ informacji w Twojej organizacji stanie się znacznie szybszy.
Jeśli chcesz dowiedzieć się więcej na temat tego systemu, odwiedź naszą stronę, gdzie znajdziesz artykuły na temat używania HTTP SMS API do wysyłania lub odbierania wiadomości.
Pierwszym krokiem w tworzeniu rozwiązania umożliwiającego wysyłanie i odbieranie wiadomości za pomocą strony internetowej jest pobranie bramki SMS Ozeki.
More information