Les registreringskrav

Velg land og nummertype

Velg et registreringsland, og bruk deretter et navn som returneres av get_document_number_types. Send dette navnet som number_type, ikke en type-ID eller en generell kategori for nummersøk.

Les instruksjonene som returneres

Ta vare på ID-ene for krav og relasjoner til den aktuelle arbeidsflyten for identitet og dokumenter. Dette kallet returnerer krav; det validerer eller sender ikke inn filene dine. Følg instruksjonene som returneres, og eventuelle krav som gjelder spesielt for det valgte nummeret.

Ikke tolk en feil som et fritak

Feilen om ugyldig land eller at registreringsdokumenter ikke kreves for landet, kombinerer to betingelser. Den beviser ikke at registrering er unødvendig. Et mislykket oppslag eller et tomt resultat innebærer heller ikke at en kunde eller et nummer er godkjent. Kontakt kundestøtte hvis resultatet er uklart.

Forespørsel

Bruk påloggingsopplysningene til den aktiverte API-kontoen din over HTTPS. Grunnleggende autentisering og aktiverte bearer-tokener for API-kontoen støttes; kontobegrensninger gjelder.

POST med application/json eller 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"

Svar

Kontroller status.code i JSON-kroppen i tillegg til HTTP-statusen. response er én enkelt kravressurs med id, type og attributes, samt relationships når dette returneres. ID-ene i ressursen og relasjonsdataene er ugjennomsiktige identifikatorer. HTML-tagger er fjernet fra den valgfrie teksten i restriction_message; behandle den gjenværende teksten som tekst, ikke som pålitelig HTML. Behandlingskoden returnerer den første kravressursen, så ikke trekk den slutningen at dette svaret er en uttømmende liste. Tilgjengeligheten av attributter og relasjoner avhenger av land og type; eksemplet er ikke et fullstendig, fast skjema.

Illustrasjon av svarstrukturen; dette er ikke faktiske kontodata eller et gjeldende pristilbud.

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

Feil

• 400: Validering av land og number_type mislyktes: oppgi begge de påkrevde verdiene. Valideringsteksten kan inneholde formatering.
• 400: Invalid country ISO or No country registration documents required.: denne tvetydige meldingen beviser ikke i seg selv at det foreligger fritak fra registrering.
• 400: Invalid number type: bruk et typenavn som er returnert. Den eldre feilmeldingen lister opp Global, Local, Mobile, National, Shared Cost og Toll Free.
• 500: Unable to load registration requirements for the specified country and number type.: kravene ble ikke returnert som de skulle. Prøv igjen senere, eller kontakt kundestøtte.

Tilgjengelighet og sideeffekter

• Dette oppslaget i katalogen og registreringskravene oppretter ikke en identitet, laster ikke opp dokumentasjon, registrerer ikke et nummer og legger ikke inn en bestilling.
• Et vellykket katalogsvar innebærer ikke at dokumentene dine er godkjent, eller at det er bekreftet at et valgt nummer kan aktiveres.