Wyświetl kraje z numerami dostępnymi od ręki

Tutaj rozpocznij wyszukiwanie numerów lokalnych. Lista zawiera tylko kraje, w których obecnie są numery dostępne od ręki. Nie powoduje to żadnej rezerwacji.

• Przekaż isocode do getareas, do getstates (tylko US i CA) lub do other.
• next_function zawsze wskazuje na v3/getareas/{isocode}. W przypadku Stanów Zjednoczonych i Kanady możesz najpierw wywołać getstates w celu zawężenia wyników do stanu lub prowincji.
• is_mobile i sms_coverage to znaczniki na poziomie kraju, które nie stanowią gwarancji dla każdego numeru. W przypadku Stanów Zjednoczonych is_mobile ma wartość 0, chyba że na Twoim koncie włączono dostęp do numerów komórkowych w Stanach Zjednoczonych.
• Kraje, w których numery są dostępne wyłącznie na zamówienie, nie są uwzględniane na liście. Nadal możesz wywołać getareas lub other bezpośrednio dla kraju, którego nie ma na liście.
• Jeśli potrzebujesz określonej kolejności, posortuj listę samodzielnie.

Jeśli żaden kraj nie spełnia warunków, response ma wartość null, a status.code ma wartość 200.

Żądanie

Wymagane: uwierzytelnianie HTTP Basic lub token Bearer (zob. Uwierzytelnianie i odpowiedzi API). W przypadku nieudanego uwierzytelnienia zwracana jest odpowiedź HTTP 401, zanim rozpocznie się wyszukiwanie.

GET bez treści żądania. Jedynym parametrem jest opcjonalny pid, przesyłany w ciągu zapytania.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getcountries'

Odpowiedź

Standardowa struktura opakowująca odpowiedź. W przypadku powodzenia status.code ma wartość 200, status.msg ma wartość 'Results: N', status.results ma wartość N, a response jest listą krajów bez gwarantowanej kolejności. Pola: countrycode (numer kierunkowy kraju bez '+'); name (nazwa kraju); description (taka sama wartość jak name); isocode (kod ISO 3166-1 alpha-2); is_mobile (0 lub 1, znacznik katalogowy na poziomie kraju, zawsze 0 dla US, chyba że na Twoim koncie włączono dostęp do numerów komórkowych w US); sms_coverage (0 lub 1, znacznik katalogowy na poziomie kraju); latitude i longitude (współrzędne kraju); next_function ('v3/getareas/{isocode}'). Kraj jest uwzględniany na liście tylko wtedy, gdy jest widoczny i dla co najmniej jednego z jego prefiksów są obecnie numery dostępne od ręki w dowolnym źródle zasobów numeracyjnych. Kraje, w których numery są dostępne wyłącznie na zamówienie (brak numerów dostępnych od ręki), nie są uwzględniane na liście. To sprawdzenie dostępności ma szerszy zakres niż filtry stosowane przez getareas, więc dla kraju znajdującego się na liście może tam czasami zostać zwrócony komunikat 'No areas found'. Jeśli żaden kraj nie spełnia warunków, status.code ma wartość 200, status.msg ma wartość 'Results: 0', pole status.results nie występuje, a response ma wartość null.

Przykładowa struktura odpowiedzi; nie przedstawia rzeczywistych danych konta ani aktualnej wyceny.

{
  "status": {
    "code": 200,
    "msg": "Results: 2",
    "results": 2
  },
  "response": [
    {
      "countrycode": "1",
      "name": "United States",
      "description": "United States",
      "isocode": "US",
      "is_mobile": 0,
      "sms_coverage": 1,
      "latitude": "38.0000",
      "longitude": "-97.0000",
      "next_function": "v3/getareas/US"
    },
    {
      "countrycode": "44",
      "name": "United Kingdom",
      "description": "United Kingdom",
      "isocode": "GB",
      "is_mobile": 1,
      "sms_coverage": 0,
      "latitude": "54.0000",
      "longitude": "-2.0000",
      "next_function": "v3/getareas/GB"
    }
  ]
}

Błędy

• 401: Brak uwierzytelnienia lub uwierzytelnienie nie powiodło się. Zwracany ze statusem HTTP 401 (zob. Uwierzytelnianie i odpowiedzi API).

Dostępność i skutki uboczne

• Wyłącznie wyszukiwanie. Nie powoduje rezerwacji, zamówienia ani żadnych zmian.
• Wyniki odzwierciedlają dostępność numerów od ręki w chwili żądania i mogą się zmieniać między wywołaniami.