Vis amerikanske delstater eller canadiske provinser med telefonnumre på lager

Brug dette valgfrie trin for USA eller Canada til at afgrænse søgningen efter delstat eller provins. Kun US og CA accepteres.

• Hver post beskriver de præfikser, der er på lager for den pågældende delstat på tidspunktet for forespørgslen.
• Følg next_function for at få vist delstatens områder. Linket indeholder allerede filteret state, men ikke pid.
• Områdeopslaget sammenholder oplysninger om delstater på en lidt anden måde. Hvis en delstats next_function returnerer No areas found, skal du i stedet kalde getareas uden at angive en delstat.
• Kontrollér status.code før du læser response. Et land, der ikke understøttes, eller et land uden matchende lagerbeholdning returnerer koden 404 uden en tilsvarende HTTP-status.
• En tom liste med koden 200 betyder, at der findes en lagerbeholdning, men at den ikke har oplysninger om delstat. Kald getareas uden at angive en delstat.

Forespørgsel

Påkrævet: HTTP Basic eller et Bearer-token (se Godkendelse og API-svar). Mislykket godkendelse besvares med HTTP 401, før opslaget udføres.

GET med isocode i stien. Hvis stisegmentet udelades, læses i stedet et formularkodet isocode-felt. Den valgfrie parameter pid sendes i forespørgselsstrengen.

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

Svar

Standardstruktur for svar. Ved succes er status.code 200, status.msg er tom, og status.results er antallet af poster. response er en liste sorteret efter name (uden forskel på store og små bogstaver) og derefter efter koden i state. Felter: state (delstats- eller provinskode fra præfiksernes delstatsdata, normalt to bogstaver; usædvanlige værdier videregives uændret); name (navnet i kataloget eller koden, hvis kataloget ikke har et navn til den); country_iso; available (samlet lagerbeholdning på tværs af de optalte præfikser, altid større end 0); prefix_count (antal optalte præfikser på lager); is_mobile (1 hvis mindst ét optalt præfiks understøtter mobiltelefoni; altid 0 for US, medmindre din konto er aktiveret til amerikanske mobilnumre); sms_coverage (1 hvis mindst ét optalt præfiks har SMS-dækning); returns_numbers (1 hvis mindst ét optalt præfiks har flaget for returnering af numre, eller der ikke er angivet nogen værdi for dette flag); next_function ('v3/getareas/{isocode}?state={state}'). Hvis der findes præfikser på lager, men ingen af dem har oplysninger om delstat, er resultatet status.code 200 med en tom liste og status.results 0.

Eksempel på svarstruktur; ikke aktuelle kontodata eller et gældende tilbud.

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

Fejl

• 500: msg 'ISO Code parameter is required': isocode mangler eller er tom. Dette er en fejl i forespørgslen, som kan rettes. Der angives ingen tilsvarende HTTP-status; læs status.code.
• 404: msg 'getstates is only available for US and CA': enhver anden landekode. Der angives ingen tilsvarende HTTP-status.
• 404: msg 'No states found': ingen præfikser på lager matcher filtrene for land og kilde. Der angives ingen tilsvarende HTTP-status.
• 401: Godkendelse mangler eller er mislykket. Sendes med HTTP-status 401.

Tilgængelighed og sideeffekter

• Kun opslag. Det reserverer, bestiller eller ændrer ikke noget. available er kun til information og reserverer ikke numre.