Dokumentacja REST API

API REST połączeń alarmowych

Zarejestruj numer i adres usługi, śledź status aktywacji i aktualizuj rekord wraz ze zmianą lokalizacji.

Otwórz dokumentację specyficzną dla konta Programiści i automatyzacja

Wybierz API i poświadczenie razem

Zatwierdzone konta dla programistów i automatyzacji, firm oraz dostawców usług komunikacyjnych mogą integrować włączone usługi. Indywidualny programista nie musi udawać firmy. SMS/MMS wysyłane przez aplikacje wymagają odpowiedniej zgody na wysyłkę i rejestracji. Usługa dla osób prywatnych i rodzin nie udostępnia klientom API do inicjowania wysyłki wiadomości.

Rodzina API	Bazowy adres URL	Uwierzytelnianie i wynik
Komunikacja v3	`https://api.multitel.net/v3`	Zatwierdzone poświadczenia Basic; kwalifikujące się udostępnione tokeny tylko dla operacji, które je obsługują. JSON `status` i `response`.
Rejestracja numerów alarmowych	`https://api.multi.tel/emergency`	Zatwierdzone poświadczenia Basic lub specjalnie udostępniony dostęp bearer. JSON `code`, `message` i `data`.
Integracje REST portalu	Host i operacja wskazane w dokumentacji dla programistów Twojego konta	Używaj danych uwierzytelniających, zakresów uprawnień i schematu opisanych dla danej operacji. Żądania sesji przeglądarki stanowią odrębny kanał dostępu.

Przed użyciem przykładów ustaw MULTITEL_API_USERNAME i MULTITEL_API_PASSWORD w konfiguracji sekretów swojego serwera. Nigdy nie umieszczaj ich w publicznym JavaScripcie przeglądarki, adresach URL ani w repozytorium kodu. Dedykowanymi poświadczeniami zarządzasz w ustawieniach integracji API.

Odczytaj zasięg bez rejestrowania numeru

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multi.tel/emergency/coverage?environment=production"

Obsługiwany jest także https://api.multitel.net/emergency. Żaden z bazowych adresów URL usługi alarmowej nie zawiera /v3. Zasięg wymienia kraje międzynarodowe, obsługiwane typy numerów i ceny; kwalifikowalność do północnoamerykańskiego E911 jest sprawdzana podczas rejestracji.

{
  "code": 200,
  "message": "",
  "environment": "production",
  "requestId": "EXAMPLE_REQUEST_ID",
  "data": {}
}

To ilustruje wyłącznie kopertę. Schemat data każdej operacji znajdziesz w opublikowanym przewodniku połączeń alarmowych API.

Zarejestruj, śledź status, a potem skonfiguruj połączenia

Dla USA/Kanady i innych obsługiwanych regionów północnoamerykańskiego E911 podaj numer, adres E911 i wymagane potwierdzenia zgód. Północnoamerykańskie E911 działa wyłącznie w środowisku produkcyjnym.
W przypadku obsługiwanego, posiadanego numeru międzynarodowego podaj zapisane odwołanie do dokumentu (Document) albo tożsamość i adres użytkownika końcowego. Najpierw zapoznaj się z wymaganiami dla kraju i typu numeru.
Wyślij jedno żądanie POST /registrations. Opcjonalny Idempotency-Key identyfikuje jedną logiczną mutację; zachowaj go oraz dokładny ładunek przy ponowieniach.
Odczytaj GET /registrations/:number. Sprawdź cykl życia, pending i actionRequired; rozwiąż wymagane poprawki. Przyjęcie lub oczekiwanie nie oznacza aktywnej usługi.
Po aktywacji skonfiguruj prawidłowy identyfikator dzwoniącego dla połączeń alarmowych oraz trasę wybierania właściwą dla kraju. Użyj procedury weryfikacji usługi, która nie dotyczy połączeń alarmowych.

Międzynarodowe rejestracje w piaskownicy są izolowane i nie aktywują prawdziwych połączeń alarmowych. Poświadczenia konta głównego są wymagane dla północnoamerykańskiego E911; przewodnik wyjaśnia ograniczoną obsługę międzynarodowych subkont.

Konfiguracja i weryfikacja w portalu Zasięg w krajach i numery alarmowe Kompletny publiczny przewodnik po żądaniach, polach, statusie i ponowieniach

Obsługa błędów i ponowień

Błąd uwierzytelniania lub uprawnień: Sprawdź, czy poświadczenie API jest włączone, jaka usługa jest dozwolona oraz jakie obowiązuje ograniczenie źródłowego adresu IP. Plik cookie sesji portalu nie jest poświadczeniem integracji.
Niewystarczające środki lub brak wymaganej zgody: Uzupełnij środki na koncie, uzyskaj zgodę na wysyłkę lub dostarcz wymagany dokument, zanim powtórzysz operację.
Brak wyniku: Puste zasoby numerów lub brak nazwy dzwoniącego traktuj jako zwykły wynik. Nie zakładaj, że poprawny składniowo numer obsługuje każdą usługę.
Przekroczenie czasu sieci lub awaria usługi: Dla operacji odczytu stosuj ograniczoną liczbę ponowień z rosnącymi odstępami między próbami. Przy zakupie, wysyłce lub rejestracji najpierw sprawdź stan operacji; ponowienie przyjętego żądania może powielić płatną czynność.

Obsługa idempotentności zależy od danej rodziny API. połączeń alarmowych API obsługuje klucze ponowień, ale to nie czyni dowolnych żądań v3 idempotentnymi. Zachowaj znaczniki czasu, zwrócone identyfikatory i odpowiedzi z usuniętymi danymi wrażliwymi na potrzeby pomocy technicznej.

Przejdź do dokumentacji swojego konta

Dokumentacja dostępna po zalogowaniu filtruje operacje według Twoich uprawnień i włączonych usług. Korzystaj z jej dokładnego hosta, typu poświadczeń, pól żądania i schematu odpowiedzi. Konsole mogą wykonywać operacje na żywo, w tym zakupy i wysyłanie wiadomości.

Katalog punktów końcowych dla Twojego konta Konsola REST usług komunikacyjnych Publiczny dokument OpenAPI usług komunikacyjnych Przewodnik integracji OAuth