Vælg land og nummertype
Vælg et registreringsland, og brug derefter et navn, der returneres af get_document_number_types. Send dette navn som number_type, ikke et type-id eller en generel kategori til nummersøgning.
Læs de returnerede instruktioner
Gem krav- og relations-id'erne til den relevante arbejdsgang for identitet og dokumenter. Dette kald returnerer krav; det validerer eller indsender ikke dine filer. Følg de returnerede instruktioner og eventuelle krav, der gælder specifikt for det valgte nummer.
Fortolk ikke en fejl som en fritagelse
Fejlen om et ugyldigt land eller manglende krav om registreringsdokumenter for landet kombinerer to betingelser. Den er ikke bevis for, at registrering er unødvendig. Et mislykket opslag eller et tomt resultat udgør heller ikke en godkendelse af en kunde eller et nummer. Kontakt support, hvis resultatet er uklart.
Anmodning
Brug legitimationsoplysningerne til din aktiverede API-konto via HTTPS. Grundlæggende godkendelse og aktiverede bearer-tokens til API-konti understøttes; kontoens begrænsninger gælder.
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"| Navn | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
country | tegnstreng | Ja | Landets ISO-kode fra get_document_countries. |
number_type | tegnstreng | Ja | Typenavn fra get_document_number_types, f.eks. Local; der skelnes ikke mellem store og små bogstaver ved sammenligning. Angiv navnet, ikke dets id. |
Svar
Kontrollér status.code i JSON-indholdet samt HTTP-statussen. response er en enkelt kravressource med id, type og attributes samt relationships, når disse returneres. Id'er i ressourcen og relationsdataene er uigennemsigtige og skal ikke fortolkes. HTML-tags er fjernet fra den valgfrie tekst i restriction_message; behandl den resterende tekst som tekst, ikke som betroet HTML. Behandlingsfunktionen returnerer den første kravressource, så du må ikke antage, at dette svar er en udtømmende liste. Tilgængeligheden af attributter og relationer afhænger af land og type; eksemplet er ikke et komplet, fast skema.
Illustration af svarstrukturen; ikke aktuelle kontodata eller et gældende pristilbud.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"id": "REQUIREMENT_ID_FROM_RESPONSE",
"type": "RESOURCE_TYPE_FROM_RESPONSE",
"attributes": {
"restriction_message": "Example country-specific instructions."
}
}
}Fejl
- 400: Validering af land og number_type mislykkedes: angiv begge påkrævede værdier. Valideringsteksten kan indeholde formatering.
- 400: Invalid country ISO or No country registration documents required.: denne tvetydige meddelelse er ikke i sig selv bevis for fritagelse fra registrering.
- 400: Invalid number type: brug et returneret typenavn. Den ældre fejlmeddelelse angiver Global, Local, Mobile, National, Shared Cost og Toll Free.
- 500: Unable to load registration requirements for the specified country and number type.: kravene blev ikke returneret korrekt. Prøv igen senere, eller kontakt support.
Tilgængelighed og sideeffekter
- Dette opslag i kataloget eller registreringskravene opretter ikke en identitet, uploader ikke dokumentation, registrerer ikke et nummer og afgiver ikke en ordre.
- Et vellykket katalogsvar er ikke en godkendelse af dine dokumenter eller en bekræftelse på, at et valgt nummer kan aktiveres.