Ontwikkelaars

POST/v3/get_requirements

Registratievereisten raadplegen

Haal de registratievereisten op die momenteel worden geretourneerd voor een land en de naam van een nummertype.

Op deze pagina
  1. Selecteer het land en het nummertype
  2. Lees de geretourneerde instructies
  3. Beschouw een fout niet als een vrijstelling
  4. Verzoek
  5. Antwoord
  6. Fouten
  7. Beschikbaarheid en neveneffecten

Selecteer het land en het nummertype

Kies een registratieland en gebruik vervolgens een naam die wordt geretourneerd door get_document_number_types. Verstuur die naam als number_type, niet een type-ID of een algemene categorie voor het zoeken naar nummers.

Lees de geretourneerde instructies

Bewaar de ID's van de vereisten en relaties voor de bijbehorende workflow voor identiteiten en documenten. Deze aanroep retourneert vereisten; uw bestanden worden niet gevalideerd of ingediend. Volg de geretourneerde instructies en alle vereisten die specifiek voor het geselecteerde nummer gelden.

Beschouw een fout niet als een vrijstelling

De foutmelding over een ongeldig land of het ontbreken van vereiste registratiedocumenten voor het land combineert twee situaties. De melding bewijst niet dat registratie overbodig is. Een mislukte zoekopdracht of een leeg resultaat betekent evenmin dat een klant of nummer is goedgekeurd. Neem contact op met de ondersteuning als het resultaat onduidelijk is.

Verzoek

Gebruik de inloggegevens van uw ingeschakelde API-account via HTTPS. Basisauthenticatie en ingeschakelde bearertokens voor het API-account worden ondersteund; accountbeperkingen zijn van toepassing.

POST met application/json of application/x-www-form-urlencoded.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  --request POST \
  --header "Content-Type: application/json" \
  --data '{"country":"US","number_type":"Local"}' \
  "https://api.multitel.net/v3/get_requirements"
Parameters in de verzoekinhoud
NaamTypeVerplichtBeschrijving
countrytekenreeksJaISO-landcode uit get_document_countries.
number_typetekenreeksJaTypenaam uit get_document_number_types, zoals Local; bij het vergelijken wordt geen onderscheid gemaakt tussen hoofdletters en kleine letters. Geef de naam op, niet de bijbehorende ID.

Antwoord

Controleer zowel status.code in de JSON-inhoud als de HTTP-status. response is één resource met vereisten, met id, type en attributes, plus relationships als die worden geretourneerd. ID's in de resource en de relatiegegevens zijn ondoorzichtige waarden. HTML-tags worden verwijderd uit de tekst van het optionele veld restriction_message; behandel de resterende tekst als tekst, niet als vertrouwde HTML. De verwerkingsfunctie retourneert de eerste resource met vereisten; ga er dus niet van uit dat dit antwoord een volledige lijst is. De beschikbaarheid van attributen en relaties hangt af van het land en het type; het voorbeeld is geen volledig, vast schema.

Voorbeeld van de antwoordstructuur; dit zijn geen actuele accountgegevens en dit is geen actuele prijsopgave.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "id": "REQUIREMENT_ID_FROM_RESPONSE",
    "type": "RESOURCE_TYPE_FROM_RESPONSE",
    "attributes": {
      "restriction_message": "Example country-specific instructions."
    }
  }
}

Fouten

  • 400: Validatie van het land en number_type is mislukt: geef beide verplichte waarden op. De validatietekst kan opmaak bevatten.
  • 400: Invalid country ISO or No country registration documents required.: deze dubbelzinnige melding bewijst op zichzelf niet dat er een vrijstelling van registratie geldt.
  • 400: Invalid number type: gebruik een geretourneerde typenaam. De oude foutmelding vermeldt Global, Local, Mobile, National, Shared Cost en Toll Free.
  • 500: Unable to load registration requirements for the specified country and number type.: de vereisten konden niet worden opgehaald. Probeer het later opnieuw of neem contact op met de ondersteuning.

Beschikbaarheid en neveneffecten

  • Deze zoekopdracht in de catalogus of de vereisten maakt geen identiteit aan, uploadt geen bewijsstuk, registreert geen nummer en plaatst geen bestelling.
  • Een geslaagd antwoord van de catalogus betekent niet dat uw documenten zijn goedgekeurd of dat is bevestigd dat een geselecteerd nummer kan worden geactiveerd.