Dokumentacja REST API

API REST numerów telefonicznych

Znajdź dostępne kraje i numery, sprawdź pełną ofertę oraz zarządzaj numerami, które posiadasz.

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 katalog dostępnych krajów

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multitel.net/v3/getcountries"

Odpowiedź v3 zawiera status oraz tablicę response. Wpisy krajów obejmują isocode, name, countrycode, informacje o możliwościach oraz next_function. Dostępność zależy od konta i zasobów; kraj nie jest obietnicą, że każdy prefiks lub typ numeru jest dostępny w zasobach.

{
  "status": {
    "code": 200,
    "msg": "Results: 1"
  },
  "response": [
    {
      "countrycode": "1",
      "name": "United States",
      "description": "United States",
      "isocode": "US",
      "is_mobile": 0,
      "sms_coverage": 1,
      "latitude": "37.0902",
      "longitude": "-95.7129",
      "next_function": "v3/getareas/US"
    }
  ]
}

Od wyszukania do aktywacji

Wybierz kraj, w razie potrzeby jednostkę podziału administracyjnego, obszar i typ numeru za pomocą odpowiednich operacji geograficznych.
Odczytaj ceny instalacji, abonamentu miesięcznego i użycia wybranego numeru, kanały, pulę oraz wymagania rejestracyjne.
Prześlij wymagane dokumenty użytkownika końcowego i sprawdź ich status. Numer może pozostawać w stanie oczekiwania do czasu zatwierdzenia.
Złóż zamówienie jeden raz, z dokładnym wyborem zasobu i ceny. Jeśli odpowiedź jest niejednoznaczna, sprawdź swój zasób numerów przed złożeniem kolejnego zamówienia.
Skonfiguruj routing głosowy i dostarczanie wiadomości niezależnie, a następnie przetestuj całą zamierzoną trasę.

Przewodnik zakupu numeru Wymagania rejestracyjne dla krajów Kanały i minuty w pakiecie

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