Lista prefiksów dla obszaru

Zanim zaczniesz

Wybierz obszar za pomocą getareas. Skopiuj identyfikator obszaru z odpowiedzi lub ze zwróconego pola next_function. W przypadku obszaru w USA lub Kanadzie użyj getstates , jeśli chcesz zawęzić wyniki do jednego stanu lub jednej prowincji.

Odczytaj wynik

Sprawdź status.code w treści JSON, a także status HTTP. Wyniki udanego żądania zawiera tablica response. Domyślnie odpowiedź jest posortowana według nazwy. Wartość available jest szacunkowa, a znaczniki katalogowe nie zastępują sprawdzenia rzeczywistych możliwości wybranego numeru i wymagań dotyczących jego rejestracji.

Wybierz kolejny krok

Użyj wyniku bez grupowania. Gdy returns_numbers ma wartość 1, zwrócone pole next_function wskazuje wyszukiwanie numerów. Gdy wartość wynosi 0, numery są przydzielane podczas składania zamówienia, a ścieżka wskazuje operację zamawiania. Przed wysłaniem żądania sprawdź operację i jej wymagania: żądanie zamówienia może spowodować obciążenie konta opłatą. Nie wysyłaj automatycznie żądań do każdej zwróconej ścieżki.

Ceny nie są tutaj uwzględnione. Przed zakupem zapoznaj się z odpowiednią wyceną, wymaganymi dokumentami i instrukcjami zamawiania. Zachowaj zwrócone identyfikatory poszczególnych prefiksów i wycen zamiast tworzyć je na podstawie wyświetlanego prefiksu telefonicznego.

Zaawansowane opcje wyświetlania

compact=1 zwraca próbkę w losowej kolejności, zawierającą najwyżej 100 wierszy, a nie stronę większego zbioru wyników. Grupowanie tworzy wiersze podsumowujące i syntetyczne identyfikatory; do wyboru pojedynczego prefiksu użyj zwykłej odpowiedzi bez grupowania. Nie wykorzystuj wyników próbkowanych ani grupowanych do stwierdzania kompletności zasobów lub dokładnych możliwości numerów.

Żądanie

Użyj danych uwierzytelniających aktywnego konta API przez HTTPS. Obsługiwane są uwierzytelnianie Basic i aktywne tokeny bearer konta API; obowiązują ograniczenia konta.

Użyj metody GET i przekaż opcjonalne parametry w ciągu zapytania. Nie polegaj na awaryjnej obsłudze parametrów formularza w treści żądania.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/getprefixes/$AREA_ID?state=NY"

Odpowiedź

Standardowa struktura JSON z polami status/response. Pole status.results podaje liczbę zwróconych wierszy, z uwzględnieniem próbkowania lub grupowania. Pole response zawiera obiekty prefiksów. Pola z cenami nie są zwracane. W zwykłej odpowiedzi bez grupowania uuid jest identyfikatorem prefiksu; area_uuid i country_uuid to zwrócone identyfikatory; prefix i name to informacje do wyświetlania; available jest szacunkiem dostępności, a nie rezerwacją; needs_registration i restrictions opisują informacje dotyczące rejestracji; sms_coverage, is_mobile i number_type są wskazówkami katalogowymi, a nie gwarancją określonej możliwości danego numeru. Pole number_type może być puste lub zawierać inny ciąg znaków z katalogu, dlatego nie wymagaj stałego zestawu wartości wyliczeniowych. Pole state jest ciągiem znaków i może być puste lub zawierać formatowanie katalogowe. Pola latitude i longitude mogą być puste. Pola metered i overflow są znacznikami katalogowymi, a nie kwotami pieniężnymi. Pole returns_numbers wybiera ścieżkę listowania numerów (1) lub ścieżkę przydzielania numerów podczas zamawiania (0). Pole next_function wskazuje tę kolejną ścieżkę. Odpowiedzi grupowane zawierają dodatkowo scalone cechy, w tym zastępcze wartości cech; nie interpretuj ich jako zweryfikowanych możliwości każdego numeru.

Przykładowa struktura odpowiedzi; nie przedstawia bieżących danych konta ani aktualnej wyceny.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "uuid": "PREFIX_ID_FROM_RESPONSE",
      "area_uuid": "AREA_ID_FROM_RESPONSE",
      "country_uuid": "COUNTRY_ID_FROM_RESPONSE",
      "prefix": "+1212",
      "name": "Example area",
      "metered": 0,
      "overflow": 0,
      "needs_registration": 0,
      "restrictions": "",
      "state": "NY",
      "country_iso": "US",
      "is_mobile": 0,
      "number_type": "local",
      "latitude": "",
      "longitude": "",
      "available": 12,
      "sms_coverage": 1,
      "returns_numbers": 1,
      "next_function": "v3/getnumbers/PREFIX_ID_FROM_RESPONSE"
    }
  ]
}

Błędy

• 404: Invalid area ID: pobierz aktualny identyfikator obszaru podczas przeglądania oferty.
• 404: State filter is only available for US and CA: dla innych krajów pomiń parametr state.
• 404: Invalid state: użyj stanu lub prowincji zwróconych przez getstates dla tego kraju.
• 404: No prefixes found: nie zwrócono pasujących wierszy katalogu. Nie dowodzi to, że danego numeru nigdy nie będzie można zamówić.
• 500: Błąd: 'Failed loading prefixes': wyszukiwanie w katalogu nie powiodło się. Spróbuj ponownie później, a jeśli problem będzie się powtarzał, skontaktuj się z pomocą techniczną.

Dostępność i skutki uboczne

• Jest to etap przeglądania oferty, a nie potwierdzenie zamówienia. Dostępność może być odświeżana za pomocą kolejnych wyszukiwań w katalogu, dlatego czas odpowiedzi może się różnić.
• Ceny nie są zwracane. Przed złożeniem zamówienia pobierz odpowiednią wycenę numeru lub zamówienia i zapoznaj się z wymaganiami dotyczącymi rejestracji.
• Nie traktuj pola available jako dokładnej liczby dostępnych numerów, zera jako bezwzględnego zakazu zamawiania ani udanego wyszukiwania jako rezerwacji. Dostępność może się zmienić przed złożeniem zamówienia.