Raktáron lévő számokkal rendelkező országok listázása

Itt kezdje a helyi telefonszámok keresését. A lista csak azokat az országokat tartalmazza, amelyekben jelenleg vannak raktáron számok. A lekérdezés semmit nem foglal le.

Adja át ezt: isocode ennek: getareas, ennek: getstates (csak US és CA esetén), vagy ennek: other.
next_function mindig erre mutat: v3/getareas/{isocode}. Az Egyesült Államok és Kanada esetén először meghívhatja ezt: getstates, hogy államra vagy tartományra szűkítse a keresést.
is_mobile és sms_coverage országszintű jelzők, és nem jelentenek garanciát minden egyes számra. Az Egyesült Államok esetén is_mobile értéke 0, kivéve, ha a fiókjában engedélyezve vannak az egyesült államokbeli mobilszámok.
Azok az országok nem szerepelnek a listában, amelyekben a lefedettség kizárólag rendelésre biztosított számokra terjed ki. A listában nem szereplő országokhoz is közvetlenül meghívhatja ezt: getareas vagy ezt: other.
Ha meghatározott sorrendre van szüksége, rendezze a listát a saját alkalmazásában.

Ha egyetlen ország sem felel meg a feltételeknek, response értéke null, és status.code értéke 200.

Kérés

Kötelező: HTTP Basic hitelesítés vagy Bearer token (lásd: Hitelesítés és API-válaszok). Sikertelen hitelesítés esetén a rendszer a lekérdezés végrehajtása előtt HTTP 401 választ ad.

GET kérés törzs nélkül. Az egyetlen paraméter a nem kötelező pid, amelyet a lekérdezési karakterláncban kell elküldeni.

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

Lekérdezési paraméterek
Név	Típus	Kötelező	Leírás
`pid`	string	Nem	Haladó, nem kötelező beállítás. Egyetlen készletforráshoz megjelölt országokra szűkíti a listát. Kizárólag a MultiTEL által megadott értéket használjon számalakban vagy 32 karakteres hexadecimális alakban; szokásos használat esetén hagyja el. A pid nem szűkíti a válasz leírásában ismertetett készletellenőrzést. Az ismeretlen értékeket, a nullát és az e végpont által el nem fogadott értékeket a rendszer hiba nélkül figyelmen kívül hagyja; a lista ilyenkor az összes támogatott forrásra kiterjed.

Válasz

Szabványos válaszburkoló. Siker esetén a status.code értéke 200, a status.msg értéke 'Results: N', a status.results értéke N, a response pedig az országok listája, garantált sorrend nélkül. Mezők: countrycode (országhívószám a '+' jel nélkül); name (az ország neve); description (értéke megegyezik a name értékével); isocode (ISO 3166-1 alpha-2 kód); is_mobile (0 vagy 1, országszintű katalógusjelző; US esetén mindig 0, kivéve, ha a fiókjában engedélyezve vannak a US mobilszámai); sms_coverage (0 vagy 1, országszintű katalógusjelző); latitude és longitude (az ország koordinátái); next_function ('v3/getareas/{isocode}'). Egy ország csak akkor szerepel a listában, ha látható, és legalább egy prefixéhez jelenleg tartozik készlet valamelyik készletforrásban. Azok az országok nem szerepelnek, amelyek lefedettsége kizárólag rendelésre biztosított számokra terjed ki, raktárkészlet nélkül. Ez a készletellenőrzés tágabb körű, mint a getareas által alkalmazott szűrők, ezért egy felsorolt ország ott időnként 'No areas found' választ adhat. Ha egyetlen ország sem felel meg, a status.code értéke 200, a status.msg értéke 'Results: 0', a status.results mező hiányzik, a response értéke pedig null.

A válasz szerkezetét szemléltető példa; nem élő fiókadat vagy aktuális árajánlat.

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

Hibák

401: A hitelesítés hiányzik vagy sikertelen. HTTP 401 állapotkóddal érkezik (lásd: Hitelesítés és API-válaszok).

Elérhetőség és mellékhatások

Kizárólag lekérdezés. Semmit nem foglal le, nem rendel meg és nem módosít.
Az eredmények a kérés időpontjában fennálló készletet tükrözik, és a hívások között változhatnak.