Lista delstater i USA eller provinser i Kanada med nummer i lager

Använd det här valfria steget för USA eller Kanada för att begränsa sökningen till en delstat eller provins. Endast US och CA godtas.

• Varje post beskriver prefix med nummer i lager för den delstaten vid tidpunkten för anropet.
• Följ next_function för att lista delstatens områden. Länken innehåller redan state-filtret men inte pid.
• Vid områdessökningen matchas delstatsinformationen på ett något annorlunda sätt. Om delstatens next_function returnerar No areas found, anropa i stället getareas utan att ange någon delstat.
• Kontrollera status.code innan du läser response. Ett land som inte stöds, eller ett land utan matchande nummer i lager, ger koden 404 utan motsvarande HTTP-status.
• En tom lista med koden 200 betyder att det finns nummer i lager men att delstatsinformation saknas. Anropa getareas utan att ange någon delstat.

Anrop

Krävs: HTTP Basic-autentisering eller en Bearer-token (se Autentisering och API-svar). Vid misslyckad autentisering returneras HTTP 401 innan sökningen utförs.

GET med isocode i sökvägen. Om sökvägssegmentet utelämnas läses i stället ett formulärkodat isocode-fält. Den valfria parametern pid skickas i frågesträngen.

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

Svar

Standardsvarsstruktur. Vid ett lyckat anrop är status.code 200, status.msg tomt och status.results antalet poster. response är en lista sorterad efter name (utan skillnad mellan stora och små bokstäver) och därefter efter koden i state. Fält: state (delstats- eller provinskod hämtad från prefixens delstatsuppgifter, normalt två bokstäver; ovanliga värden skickas vidare oförändrade); name (namnet i katalogen, eller koden om katalogen saknar ett namn för den); country_iso; available (totalt lagersaldo för de räknade prefixen, alltid större än 0); prefix_count (antal räknade prefix med nummer i lager); is_mobile (1 om något räknat prefix har stöd för mobiltelefoni; alltid 0 för US om inte ditt konto har aktiverats för amerikanska mobilnummer); sms_coverage (1 om något räknat prefix har SMS-täckning); returns_numbers (1 om något räknat prefix har flaggan för att returnera nummer eller saknar värde för den); next_function ('v3/getareas/{isocode}?state={state}'). Om det finns prefix med nummer i lager men inget av dem har delstatsinformation blir resultatet status.code 200 med en tom lista och status.results 0.

Exempel på svarsstruktur; inga aktuella kontouppgifter och ingen aktuell offert.

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

Fel

• 500: msg 'ISO Code parameter is required': isocode saknas eller är tomt. Detta är ett fel i anropet som går att rätta till. Ingen motsvarande HTTP-status anges; läs status.code.
• 404: msg 'getstates is only available for US and CA': någon annan landskod har angetts. Ingen motsvarande HTTP-status anges.
• 404: msg 'No states found': inga prefix med nummer i lager matchar lands- och källfiltren. Ingen motsvarande HTTP-status anges.
• 401: Autentisering saknas eller misslyckades. Skickas med HTTP-status 401.

Tillgänglighet och sidoeffekter

• Endast en sökning. Den reserverar, beställer eller ändrar ingenting. available är endast en upplysning och reserverar inga nummer.