Nummerprefixen voor een gebied opvragen

Voordat u begint

Kies een gebied met getareas. Kopieer de gebieds-ID uit het antwoord of uit de geretourneerde next_function. Gebruik voor een gebied in de VS of Canada getstates als u de resultaten tot één staat of provincie wilt beperken.

Het resultaat lezen

Controleer status.code in de JSON-body en controleer ook de HTTP-status. Succesvolle resultaten staan in de response-array. Het antwoord wordt standaard op naam gesorteerd. available is een schatting. Indicatoren in de catalogus vervangen niet de controle van de daadwerkelijke mogelijkheden en registratievereisten van het geselecteerde nummer.

De volgende stap kiezen

Gebruik een ongegroepeerd resultaat. Als returns_numbers gelijk is aan 1, verwijst de geretourneerde next_function naar een zoekopdracht voor nummers. Bij de waarde 0 worden nummers bij het bestellen toegewezen en verwijst het pad naar een bestelbewerking. Controleer de bewerking en de bijbehorende vereisten voordat u het verzoek verstuurt: een bestelverzoek kan kosten op uw account in rekening brengen. Voer niet automatisch voor elk geretourneerd pad een verzoek uit.

Hier wordt geen prijs vermeld. Bekijk vóór aankoop de betreffende prijsopgave, de vereiste documenten en de bestelinstructies. Bewaar de geretourneerde ID's van afzonderlijke prefixen en prijsopgaven in plaats van ze zelf samen te stellen op basis van een weergegeven telefoonprefix.

Geavanceerde weergaveopties

compact=1 retourneert een steekproef van maximaal 100 rijen in willekeurige volgorde, geen pagina uit een grotere resultaatset. Groepering levert samenvattingsrijen en synthetische ID's op; gebruik een normaal, ongegroepeerd antwoord om een afzonderlijk prefix te selecteren. Gebruik steekproeven of gegroepeerde resultaten niet om uitspraken te doen over de volledige voorraad of de exacte mogelijkheden.

Verzoek

Gebruik de inloggegevens van uw ingeschakelde API-account via HTTPS. Authenticatie met Basic en ingeschakelde bearer-tokens voor API-accounts worden ondersteund; accountbeperkingen zijn van toepassing.

Gebruik GET en stuur optionele parameters mee in de querystring. Vertrouw er niet op dat parameters uit een formulierbody als alternatief worden verwerkt.

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

Antwoord

De standaard JSON-structuur met status/response. status.results telt de geretourneerde rijen, ook bij steekproeven of groepering. response bevat prefixobjecten. Er worden geen prijsvelden geretourneerd. In het normale, ongegroepeerde antwoord is uuid de prefix-ID; zijn area_uuid en country_uuid geretourneerde identificatiewaarden; zijn prefix en name informatie voor weergave; is available een schatting van de beschikbaarheid en geen reservering; beschrijven needs_registration en restrictions registratie-informatie; zijn sms_coverage, is_mobile en number_type aanwijzingen uit de catalogus, geen garantie voor een bepaalde mogelijkheid van een nummer. number_type kan leeg zijn of een andere tekenreeks uit de catalogus bevatten, dus vereis geen vaste enumeratie. state is een tekenreeks en kan leeg zijn of opmaak uit de catalogus bevatten. latitude en longitude kunnen leeg zijn. metered en overflow zijn indicatoren uit de catalogus, geen geldbedragen. returns_numbers selecteert een route voor het opvragen van een nummerlijst (1) of een route voor toewijzing bij het bestellen (0). next_function geeft die volgende route aan. Gegroepeerde antwoorden bevatten daarnaast samengevoegde kenmerken, waaronder terugvalwaarden voor kenmerken; beschouw deze niet als geverifieerde mogelijkheden van elk nummer.

Voorbeeld van de antwoordstructuur; geen live accountgegevens of actuele prijsopgave.

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

Fouten

• 404: Invalid area ID: haal een actuele gebieds-ID op via de verkenningsstappen.
• 404: State filter is only available for US and CA: laat state weg voor andere landen.
• 404: Invalid state: gebruik een staat of provincie die door getstates voor dit land is geretourneerd.
• 404: No prefixes found: er zijn geen overeenkomende catalogusrijen geretourneerd. Dit bewijst niet dat een bepaald nummer nooit kan worden besteld.
• 500: Fout: 'Failed loading prefixes': het opzoeken in de catalogus is mislukt. Probeer het later opnieuw en neem contact op met de ondersteuning als het probleem aanhoudt.

Beschikbaarheid en neveneffecten

• Dit is een verkenningsstap, geen bestelbevestiging. De beschikbaarheid kan worden bijgewerkt door aanvullende opzoekingen in de catalogus, waardoor de responstijd kan variëren.
• Er worden geen prijzen geretourneerd. Haal de toepasselijke prijsopgave voor het nummer of de bestelling op en bekijk de registratievereisten voordat u een bestelling plaatst.
• Beschouw available niet als een exact voorraadaantal, nul niet als een algemeen bestelverbod en een geslaagde opzoeking niet als een reservering. De beschikbaarheid kan veranderen voordat u bestelt.