Utviklere

GET/v3/getcountries

Vis land med numre på lager

Returnerer synlige land som for øyeblikket har numre på lager under minst ett nummerprefiks. Hver oppføring inneholder landsnummeret, ISO-koden, flagg på landsnivå for mobilnumre og SMS, koordinater og en next_function-lenke til landets områder.

På denne siden
  1. Forespørsel
  2. Svar
  3. Feil
  4. Tilgjengelighet og sideeffekter

Start søket etter lokale telefonnumre her. Listen inneholder bare land som for øyeblikket har numre på lager. Den reserverer ingenting.

  • Send isocode til getareas, til getstates (bare US og CA) eller til other.
  • next_function peker alltid til v3/getareas/{isocode}. For USA og Canada kan du kalle getstates først for å avgrense etter delstat eller provins.
  • is_mobile og sms_coverage er flagg på landsnivå, ikke garantier for hvert enkelt nummer. For USA er is_mobile lik 0, med mindre kontoen din er aktivert for amerikanske mobilnumre.
  • Land der numre bare er tilgjengelige ved bestilling, vises ikke. Du kan fortsatt kalle getareas eller other direkte for et land som ikke er oppført.
  • Sorter listen selv hvis du trenger en bestemt rekkefølge.

Hvis ingen land oppfyller vilkårene, er response lik null, og status.code er 200.

Forespørsel

Påkrevd: HTTP Basic-autentisering eller et Bearer-token (se Autentisering og API-svar). Mislykket autentisering besvares med HTTP 401 før oppslaget utføres.

GET uten forespørselsinnhold. Den eneste parameteren er den valgfrie pid, som sendes i spørringsstrengen.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getcountries'
Spørringsparametere
NavnTypePåkrevdBeskrivelse
pidstringNeiAvansert og valgfri. Avgrenser listen til land som er merket for én lagerkilde. Bruk bare en verdi fra MultiTEL, i numerisk form eller som en heksadesimal verdi på 32 tegn, og utelat den ved vanlig bruk. pid avgrenser ikke lagerkontrollen som er beskrevet under svaret. Ukjente verdier, null og verdier som dette endepunktet ikke godtar, ignoreres uten feil; listen omfatter da alle støttede kilder.

Svar

Standard svarstruktur. Ved vellykket forespørsel er status.code 200, status.msg er 'Results: N', status.results er N, og response er en liste over land uten garantert rekkefølge. Felter: countrycode (landsnummer uten '+'); name (landets navn); description (samme verdi som name); isocode (ISO 3166-1 alpha-2-kode); is_mobile (0 eller 1, et katalogflagg på landsnivå, alltid 0 for US, med mindre kontoen din er aktivert for mobilnumre i US); sms_coverage (0 eller 1, et katalogflagg på landsnivå); latitude og longitude (landets koordinater); next_function ('v3/getareas/{isocode}'). Et land vises bare hvis det er synlig og minst ett av prefiksene for øyeblikket har numre på lager hos en av lagerkildene. Land der numre utelukkende er tilgjengelige ved bestilling (ingen lagerbeholdning), vises ikke. Denne lagerkontrollen er bredere enn filtrene som getareas bruker, så et oppført land kan av og til returnere 'No areas found' der. Hvis ingen land oppfyller vilkårene, er status.code 200, status.msg er 'Results: 0', feltet status.results finnes ikke, og response er null.

Illustrasjon av svarstrukturen; verken aktuelle kontodata eller et gjeldende pristilbud.

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

Feil

  • 401: Autentisering mangler eller mislyktes. Sendes med HTTP-status 401 (se Autentisering og API-svar).

Tilgjengelighet og sideeffekter

  • Bare oppslag. Det reserverer, bestiller eller endrer ingenting.
  • Resultatene gjenspeiler lagerbeholdningen på forespørselstidspunktet og kan endre seg mellom kall.