Ontwikkelaars

GET/v3/get_document_number_types/{country}

Nummertypen voor registratie opvragen

Vind de namen van nummertypen die momenteel in de registratiecatalogus voor een land voorkomen.

Op deze pagina
  1. Kies een type aan de hand van de geretourneerde naam
  2. Groepsaantallen zijn geen nummervoorraad
  3. Verzoek
  4. Antwoord
  5. Fouten
  6. Beschikbaarheid en neveneffecten

Kies een type aan de hand van de geretourneerde naam

Gebruik een land uit get_document_countries. Geef de geretourneerde typenaam door aan get_requirements. Een type-ID uit de catalogus is geen prefix-ID, nummer-ID of ID van een bewijsstukcategorie.

Groepsaantallen zijn geen nummervoorraad

available_groups telt de groepsrecords die deze catalogusopvraag retourneert. Het telt geen telefoonnummers die kunnen worden gekocht, reserveert geen voorraad en garandeert niet dat de catalogus alle pagina's van de achterliggende bron heeft opgehaald. Doorzoek de relevante nummervoorraad en beoordeel afzonderlijk een offerte.

Verzoek

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

GET met elke gedocumenteerde parameter in het URL-pad.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_document_number_types/$COUNTRY_ISO"
Padparameters
NaamTypeVerplichtBeschrijving
countrystringJaISO-landcode van twee letters uit de catalogus van registratielanden. Witruimte aan het begin en einde wordt verwijderd en de code wordt omgezet naar hoofdletters.

Antwoord

Controleer zowel status.code in de JSON-body als de HTTP-status. response is een array met id, name en available_groups. Gebruik name als number_type bij het aanroepen van get_requirements; stuur niet id in plaats daarvan. available_groups is het aantal groepsrecords dat voor dat type wordt geretourneerd, niet het aantal telefoonnummers in voorraad of een volledig totaal over alle pagina's. Typen waarvoor geen groepen worden geretourneerd, worden weggelaten. De voorkeursvolgorde is Local, Mobile, National, Toll Free, Shared Cost, Global, gevolgd door andere namen uit de catalogus.

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

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "NUMBER_TYPE_ID_FROM_RESPONSE",
      "name": "Local",
      "available_groups": 3
    }
  ]
}

Fouten

  • 400: country is required: geef de ISO-code van het registratieland op.
  • 400: Invalid country ISO or no available DID registration country found: selecteer een land uit de huidige registratiecatalogus; dit toont niet aan dat er geen documenten vereist zijn.

Beschikbaarheid en neveneffecten

  • Deze opvraag van de catalogus of vereisten maakt geen identiteit aan, uploadt geen bewijsstuk, registreert geen nummer en plaatst geen bestelling.
  • Een succesvol antwoord van de catalogus houdt geen goedkeuring van uw documenten in en bevestigt niet dat een geselecteerd nummer kan worden geactiveerd.