List amerikanske delstater eller kanadiske provinser med tilgjengelige numre

Bruk dette valgfrie trinnet for USA eller Canada for å avgrense søket etter delstat eller provins. Bare US og CA godtas.

• Hver oppføring beskriver prefikser med tilgjengelige numre for den aktuelle delstaten på tidspunktet for forespørselen.
• Følg next_function for å liste delstatens områder. Lenken inneholder allerede filteret state, men ikke pid.
• Områdeoppslaget sammenligner delstatsinformasjon på en litt annen måte. Hvis delstatens next_function returnerer No areas found, kall getareas uten å angi delstat i stedet.
• Kontroller status.code før du leser response. Et land som ikke støttes, eller et land uten tilgjengelige numre som samsvarer med søket, gir kode 404 uten tilsvarende HTTP-status.
• En tom liste med kode 200 betyr at det finnes tilgjengelige numre, men at delstatsinformasjon mangler. Kall getareas uten å angi delstat.

Forespørsel

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

GET med isocode i stien. Hvis stisegmentet utelates, leses et skjemakodet isocode-felt i stedet. Den valgfrie parameteren pid sendes i spørringsstrengen.

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

Svar

Standard omslagsstruktur. Ved suksess er status.code 200, status.msg er tom, og status.results er antall oppføringer. response er en liste sortert etter name (uten skille mellom store og små bokstaver), deretter etter delstatskoden i state. Felter: state (delstats- eller provinskode hentet fra prefiksenes delstatsdata, vanligvis to bokstaver; uvanlige verdier videreføres uendret); name (navn fra katalogen, eller koden når katalogen ikke har noe navn for den); country_iso; available (totalt antall tilgjengelige numre på tvers av prefiksene som telles, alltid større enn 0); prefix_count (antall opptelte prefikser med tilgjengelige numre); is_mobile (1 hvis minst ett av prefiksene som telles, støtter mobilnumre; alltid 0 for US med mindre kontoen din er aktivert for amerikanske mobilnumre); sms_coverage (1 hvis minst ett av prefiksene som telles, har SMS-dekning); returns_numbers (1 hvis minst ett av prefiksene som telles, har flagget for retur av numre eller mangler en verdi for dette flagget); next_function ('v3/getareas/{isocode}?state={state}'). Hvis det finnes prefikser med tilgjengelige numre, men ingen av dem har delstatsinformasjon, er resultatet status.code 200 med en tom liste og status.results 0.

Eksempel på svarstruktur; dette er verken sanntidsdata fra en konto eller et gjeldende pristilbud.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 2
  },
  "response": [
    {
      "state": "NY",
      "name": "New York",
      "country_iso": "US",
      "available": 120,
      "prefix_count": 8,
      "is_mobile": 0,
      "sms_coverage": 1,
      "returns_numbers": 1,
      "next_function": "v3/getareas/US?state=NY"
    },
    {
      "state": "TX",
      "name": "Texas",
      "country_iso": "US",
      "available": 45,
      "prefix_count": 3,
      "is_mobile": 0,
      "sms_coverage": 0,
      "returns_numbers": 1,
      "next_function": "v3/getareas/US?state=TX"
    }
  ]
}

Feil

• 500: msg 'ISO Code parameter is required': isocode mangler eller er tom. Dette er en feil i forespørselen som kan rettes. Ingen tilsvarende HTTP-status settes; les status.code.
• 404: msg 'getstates is only available for US and CA': enhver annen landskode. Ingen tilsvarende HTTP-status settes.
• 404: msg 'No states found': ingen prefikser med tilgjengelige numre samsvarer med filtrene for land og kilde. Ingen tilsvarende HTTP-status settes.
• 401: Autentisering mangler eller mislyktes. Sendes med HTTP-status 401.

Tilgjengelighet og sideeffekter

• Kun oppslag. Det reserverer, bestiller eller endrer ingenting. available er bare til informasjon og holder ikke av numre.