Seznam zemí s čísly skladem

Zde začněte s vyhledáváním místních telefonních čísel. Seznam obsahuje pouze země, které mají aktuálně čísla skladem. Nic se tím nerezervuje.

• Předejte isocode funkci getareas, funkci getstates (pouze US a CA) nebo funkci other.
• next_function vždy odkazuje na v3/getareas/{isocode}. U Spojených států a Kanady můžete nejprve zavolat getstates a zúžit tak výběr podle státu nebo provincie.
• is_mobile a sms_coverage jsou příznaky na úrovni země, nikoli záruky pro každé číslo. U Spojených států má is_mobile hodnotu 0, pokud váš účet nemá povolena mobilní čísla v USA.
• Země, v nichž jsou čísla dostupná výhradně na objednávku, se v seznamu neuvádějí. I pro zemi, která v seznamu není, však můžete zavolat getareas nebo other přímo.
• Pokud potřebujete určité pořadí, seřaďte si seznam sami.

Pokud žádná země nesplňuje podmínky, response má hodnotu null a status.code má hodnotu 200.

Požadavek

Vyžadováno: ověřování HTTP Basic nebo token Bearer (viz Ověřování a odpovědi API). Při neúspěšném ověření se vrátí odpověď HTTP 401 ještě před spuštěním vyhledávání.

GET bez těla požadavku. Jediným parametrem je volitelný pid, který se odesílá v řetězci dotazu.

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

Odpověď

Standardní obal odpovědi. Při úspěchu má status.code hodnotu 200, status.msg hodnotu 'Results: N', status.results hodnotu N a response obsahuje seznam zemí bez zaručeného pořadí. Pole: countrycode (mezinárodní telefonní předvolba země bez '+'); name (název země); description (stejná hodnota jako name); isocode (kód ISO 3166-1 alpha-2); is_mobile (0 nebo 1, katalogový příznak na úrovni země, pro US vždy 0, pokud váš účet nemá povolena mobilní čísla v US); sms_coverage (0 nebo 1, katalogový příznak na úrovni země); latitude a longitude (souřadnice země); next_function ('v3/getareas/{isocode}'). Země se v seznamu uvede pouze tehdy, pokud je viditelná a alespoň pod jedním z jejích prefixů jsou aktuálně čísla skladem v některém ze zdrojů zásob. Země, v nichž jsou čísla dostupná výhradně na objednávku (žádná nejsou skladem), se v seznamu neuvádějí. Tato kontrola skladové dostupnosti má širší rozsah než filtry používané funkcí getareas, takže i pro zemi uvedenou v seznamu může tato funkce občas vrátit 'No areas found'. Pokud žádná země nesplňuje podmínky, status.code má hodnotu 200, status.msg má hodnotu 'Results: 0', pole status.results chybí a response má hodnotu null.

Ukázková struktura odpovědi; nejde o aktuální data účtu ani o aktuální cenovou nabídku.

{
  "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"
    }
  ]
}

Chyby

• 401: Ověření chybí nebo selhalo. Odesílá se se stavovým kódem HTTP 401 (viz Ověřování a odpovědi API).

Dostupnost a vedlejší účinky

• Pouze vyhledávání. Nic se tím nerezervuje, neobjednává ani nemění.
• Výsledky odrážejí stav zásob v okamžiku požadavku a mezi jednotlivými voláními se mohou měnit.