Dokumenty

Wyślij swoją pierwszą wiadomość w popołudnie

Prosty interfejs API REST do wysyłania, śledzenia i odbierania SMS-ów — uwierzytelnianie tokenów, webhook w czasie rzeczywistym i pakiety SDK, bez konieczności uczenia się niczego egzotycznego.

Szybki start

Trzy ruchy i zacznij dostarczać

Każda integracja to ten sam krótki cykl — uwierzytelnianie, wysyłanie, a następnie śledzenie.

01 · UwierzytelniaćToken: sk_live_9f2a7c10Typ zawartości: aplikacja/json ✓

Wysyłaj swój klucz dostępu jako nagłówek tokenu z typem zawartości: application/json przy każdym żądaniu.

02 · WysłaćPOST /zewnętrzny/sms{ msgid: "9f2a7c10", kod błędu: 0 }

Opublikuj a od, do i treść. Odpowiedź natychmiast pojawia się z identyfikatorem msgid i kodem błędu.

03 · ŚcieżkaGET /report?status=Dostarcz200 OK

WYSŁAMY lub OTRZYMAMY raport o stanie na adres URL wywołania zwrotnego w momencie, gdy wiadomość osiągnie swój ostateczny stan.

Wysłać

Jedna prośba, w języku, którego już używasz

Opublikuj swojego nadawcę, odbiorcę i treść za pomocą nagłówka Tokena. Odpowiedź pojawia się w momencie, gdy ją zaakceptujemy.

01curl -X POST https://secure.smslocal.com/api/service/enterprise-service/external/sms \02  -H "Token: $SMSLOCAL_TOKEN" \03  -H "Content-Type: application/json" \04  -d '{05    "from": "SMSLOCAL",06    "to": "14155550123",07    "content": "Your code is 481920."08  }'
201 · Zaakceptowano

msgstr „9f2a7c10-4b2e-…”

kierunek „mt”

kod błędu 0

Zapisz msgstr — w ten sposób możesz stąd śledzić tę wiadomość.

Obiekt wiadomości

Przeczytaj wiadomość od góry do dołu

Wszystkie zdarzenia wysyłania, stanu i przychodzące zwracają ten sam kształt — naucz się tego raz.

01Identyfikator wiadomości

Identyfikator wiadomości

msgid — wydawany w momencie utworzenia wiadomości. Jest to uchwyt, którego użyjesz do późniejszego sprawdzenia jego stanu.

02Nadawca

Nadawca

od — numer telefonu lub identyfikator alfanumeryczny składający się z maksymalnie 11 znaków, w zależności od tego, jaką tożsamość widzą odbiorcy.

03Odbiorca

Odbiorca

do — numer, pod który ma zostać wysłana wiadomość, łącznie z kodem kraju.

04Kodowanie

Kodowanie

kodowanie danych — GSM7 mieści 160 znaków na część; przejdź na Unicode, a liczba ta spadnie do 70. Przejdź dalej, a połączy się w dodatkowe płatne części.

05Kierunek

Kierunek

kierunek — każda wiadomość ma postać mt (wysłałeś) lub mo (otrzymałeś), w obu przypadkach ten sam kształt.

06Kod błędu

Kod błędu

kod błędu — zwracany w odpowiedzi na wysłanie i każdym raporcie o stanie. 0 oznacza zaakceptowane; wszystko inne powie dokładnie, co poszło nie tak.

Odniesienie

Jeden punkt końcowy, dwa czasowniki

POST do wysłania, GET do sprawdzenia statusu — w obu przypadkach ten sam adres URL i ten sam nagłówek tokenu.

POST

Wysłać

Wyślij wiadomość i natychmiast otrzymaj identyfikator msgid oraz kod błędu.

Powroty msgstr + kod błędu
DOSTAWAĆ

Ścieżka

Wyszukaj wiadomość, którą już wysłałeś, aby sprawdzić jej aktualny status.

Powroty wiadomość + status
Haki internetowe

Raporty o stanie, w momencie ich wystąpienia

Ustaw adres URL wywołania zwrotnego, a każda dostawa, niepowodzenie i odpowiedź przychodząca będą tam trafiać jako GET lub POST — nie jest wymagane odpytywanie.

dostarczonymsgid 9f2a7c10 · status Delivrd
przychodząceodpowiedź otrzymana · kierunek mo
przegranymsgstr 4c81e2 · status Niepowodzenie
Twój punkt końcowy200 OK
Rozpocznij

Zdobądź klucz API

Rozpocznij integrację w ciągu kilku minut dzięki naszemu REST API.

Odpowiedzi na Twoje pytania

Dokumentacja programisty — często zadawane pytania

Przy każdym żądaniu przekazuj swój klucz dostępu w nagłówku Tokenu — Token: {accessKey} — wraz z typem treści: application/json.

Każde wysłanie zwraca msgid. Wskaż nam adres URL wywołania zwrotnego, a my POST lub OTRZYMAMY raport o stanie w momencie, gdy wiadomość osiągnie swój ostateczny stan — zawiera poddatę, datę wykonania i wynikowy kod stanu.

mt (telefon zakończony) to wiadomość, którą wysłałeś; mo (pochodzące z telefonu komórkowego) to odpowiedź, którą otrzymałeś. Obydwa używają tego samego kształtu obiektu wiadomości.

Dostarczenie jest ponawiane zgodnie z zasadami ponawiania — nic nie jest po cichu odrzucane, ale punkt końcowy, który nigdy nie potwierdzi, będzie nadal otrzymywać ponawianie prób.

160 znaków w kodowaniu GSM7 lub 70 w Unicode. Po przekroczeniu limitu wiadomość zostanie złożona w wiele części, z których każda będzie rozliczana osobno.