Lista prefix för ett område

Innan du börjar

Välj ett område med getareas. Kopiera områdets ID från svaret eller från det returnerade värdet i next_function. För ett område i USA eller Kanada använder du getstates om du vill begränsa resultaten till en delstat eller provins.

Läs resultatet

Kontrollera status.code i JSON-kroppen samt HTTP-statusen. Vid lyckade anrop finns resultaten i arrayen response. Standardsvaret är sorterat efter namn. available är en uppskattning, och katalogflaggor ersätter inte kontrollen av det valda numrets faktiska funktioner och registreringskrav.

Välj nästa steg

Använd ett ogrupperat resultat. När returns_numbers är 1 pekar det returnerade värdet i next_function på en nummersökning. När värdet är 0 tilldelas nummer vid beställningen och sökvägen pekar på en beställningsoperation. Granska operationen och dess krav innan du skickar begäran: en beställningsbegäran kan medföra att ditt konto debiteras. Skicka inte automatiskt anrop till varje returnerad sökväg.

Inget pris ingår här. Granska den aktuella offerten, nödvändiga dokument och beställningsanvisningarna före köp. Behåll de returnerade ID-värdena för enskilda prefix och offerter i stället för att konstruera dem utifrån ett visat telefonprefix.

Avancerade visningsalternativ

compact=1 returnerar ett urval i slumpmässig ordning med högst 100 rader, inte en sida ur en större resultatmängd. Gruppering skapar sammanfattningsrader och syntetiska ID-värden; använd ett vanligt ogrupperat svar för att välja ett enskilt prefix. Använd inte urval eller grupperade resultat för att hävda att utbudet är fullständigt redovisat eller att funktionerna är exakt fastställda.

Begäran

Använd inloggningsuppgifterna för ditt aktiverade API-konto över HTTPS. Autentisering med Basic och aktiverade bearer-token för API-konton stöds; kontobegränsningar gäller.

Använd GET och skicka valfria parametrar i frågesträngen. Förlita dig inte på att formulärdata i begärans kropp används som reservlösning.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/getprefixes/$AREA_ID?state=NY"

Svar

Den vanliga JSON-strukturen med status/response. status.results anger antalet returnerade rader, även vid urval eller gruppering. response innehåller prefixobjekt. Inga prisfält returneras. I det vanliga ogrupperade svaret är uuid prefixets ID; area_uuid och country_uuid är returnerade identifierare; prefix och name är visningsinformation; available är en uppskattning av tillgängligheten snarare än en reservation; needs_registration och restrictions beskriver registreringsinformation; sms_coverage, is_mobile och number_type är indikationer från katalogen, inte en garanti för att ett visst nummer har en viss funktion. number_type kan vara tomt eller innehålla en annan katalogsträng, så kräv inte en fast uppräkning av tillåtna värden. state är en sträng och kan vara tom eller innehålla katalogens formatering. latitude och longitude kan vara tomma. metered och overflow är katalogflaggor, inte penningbelopp. returns_numbers väljer en väg för att lista nummer (1) eller en väg för tilldelning vid beställning (0). next_function identifierar den vägen för nästa steg. Grupperade svar innehåller dessutom sammanslagna funktionsegenskaper, inklusive reservvärden för egenskaper; tolka inte dessa som verifierade funktioner hos varje nummer.

Exempel på svarsstruktur; inte aktuella kontodata eller en aktuell offert.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "uuid": "PREFIX_ID_FROM_RESPONSE",
      "area_uuid": "AREA_ID_FROM_RESPONSE",
      "country_uuid": "COUNTRY_ID_FROM_RESPONSE",
      "prefix": "+1212",
      "name": "Example area",
      "metered": 0,
      "overflow": 0,
      "needs_registration": 0,
      "restrictions": "",
      "state": "NY",
      "country_iso": "US",
      "is_mobile": 0,
      "number_type": "local",
      "latitude": "",
      "longitude": "",
      "available": 12,
      "sms_coverage": 1,
      "returns_numbers": 1,
      "next_function": "v3/getnumbers/PREFIX_ID_FROM_RESPONSE"
    }
  ]
}

Fel

• 404: Invalid area ID: hämta ett aktuellt områdes-ID genom att utforska katalogen.
• 404: State filter is only available for US and CA: utelämna state för andra länder.
• 404: Invalid state: använd en delstat eller provins som returneras av getstates för det här landet.
• 404: No prefixes found: inga matchande katalograder returnerades. Detta bevisar inte att ett visst nummer aldrig kan beställas.
• 500: Fel: 'Failed loading prefixes': uppslagningen i katalogen misslyckades. Försök igen senare och kontakta supporten om felet kvarstår.

Tillgänglighet och sidoeffekter

• Det här är ett steg för att utforska utbudet, inte en orderbekräftelse. Tillgängligheten kan uppdateras genom ytterligare uppslagningar i katalogen, så svarstiden kan variera.
• Priser returneras inte. Hämta den tillämpliga offerten för numret eller beställningen och granska registreringskraven innan du gör en beställning.
• Tolka inte available som ett exakt lagersaldo, noll som ett generellt beställningsförbud eller en lyckad uppslagning som en reservation. Tillgängligheten kan ändras innan beställningen görs.