Utvecklare

GET/v3/getcountries

Lista länder med nummer i lager

Returnerar synliga länder som för närvarande har minst ett nummerprefix med nummer i lager. Varje post innehåller landsnummer, ISO-kod, flaggor på landsnivå för mobilnummer och SMS, koordinater och en länk via next_function till landets täckningsområden.

På denna sida
  1. Begäran
  2. Svar
  3. Fel
  4. Tillgänglighet och sidoeffekter

Börja här när du söker efter lokala telefonnummer. Listan innehåller endast länder som för närvarande har nummer i lager. Ingenting reserveras.

  • Skicka isocode till getareas, till getstates (endast US och CA) eller till other.
  • next_function pekar alltid på v3/getareas/{isocode}. För USA och Kanada kan du anropa getstates först för att avgränsa efter delstat eller provins.
  • is_mobile och sms_coverage är flaggor på landsnivå och garanterar inte motsvarande egenskaper för varje nummer. För USA gäller att is_mobile är 0 om ditt konto inte har aktiverats för amerikanska mobilnummer.
  • Länder där täckningen enbart omfattar nummer som måste beställas listas inte. Du kan ändå anropa getareas eller other direkt för ett land som inte finns med i listan.
  • Sortera listan själv om du behöver en viss ordning.

Om inget land uppfyller villkoren gäller följande: response är null och status.code är 200.

Begäran

Krävs: HTTP Basic eller en Bearer-token (se Autentisering och API-svar). Misslyckad autentisering besvaras med HTTP 401 innan uppslagningen utförs.

GET utan meddelandekropp. Den enda parametern är den valfria pid, som skickas i frågesträngen.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getcountries'
Frågeparametrar
NamnTypObligatoriskBeskrivning
pidstringNejAvancerad och valfri. Begränsar listan till länder som är markerade för en viss lagerkälla. Använd endast ett värde som tillhandahållits av MultiTEL, i numerisk form eller som ett hexadecimalt värde med 32 tecken, och utelämna parametern vid normal användning. pid begränsar inte den lagerkontroll som beskrivs i svaret. Okända värden, noll och värden som denna ändpunkt inte accepterar ignoreras utan felmeddelande; listan omfattar då alla källor som stöds.

Svar

Standardsvarsstruktur. Vid ett lyckat anrop är status.code 200, status.msg är 'Results: N', status.results är N och response är en lista över länder utan garanterad ordning. Fält: countrycode (landsnummer utan '+'); name (landets namn); description (samma värde som name); isocode (ISO 3166-1 alpha-2-kod); is_mobile (0 eller 1, en katalogflagga på landsnivå, alltid 0 för US om ditt konto inte har aktiverats för mobilnummer i US); sms_coverage (0 eller 1, en katalogflagga på landsnivå); latitude och longitude (landets koordinater); next_function ('v3/getareas/{isocode}'). Ett land listas endast om det är synligt och minst ett av dess prefix för närvarande har nummer i lager hos någon lagerkälla. Länder där täckningen enbart omfattar nummer som måste beställas (inga nummer i lager) listas inte. Denna lagerkontroll är bredare än de filter som getareas tillämpar, så ett listat land kan ibland ge svaret 'No areas found' där. Om inget land uppfyller villkoren är status.code 200, status.msg är 'Results: 0', fältet status.results saknas och response är null.

Exempel på svarsstruktur; detta är varken aktuella kontouppgifter eller en aktuell offert.

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

Fel

  • 401: Autentisering saknas eller misslyckades. Skickas med HTTP-status 401 (se Autentisering och API-svar).

Tillgänglighet och sidoeffekter

  • Endast uppslagning. Ingenting reserveras, beställs eller ändras.
  • Resultaten återspeglar lagersaldot vid tidpunkten för begäran och kan ändras mellan anrop.