Välj land och nummertyp
Välj ett registreringsland och använd sedan ett namn som returneras av get_document_number_types. Skicka namnet som number_type, inte ett typ-ID eller en allmän kategori för nummersökning.
Läs instruktionerna som returneras
Spara kravens och relationernas ID:n för det aktuella arbetsflödet för identitet och dokument. Det här anropet returnerar krav; det validerar eller skickar inte in dina filer. Följ instruktionerna som returneras och eventuella krav som gäller specifikt för det valda numret.
Tolka inte ett fel som ett undantag från registreringskraven
Felet om ett ogiltigt land eller att inga registreringsdokument krävs för landet kombinerar två villkor. Det bevisar inte att registrering är onödig. En misslyckad sökning eller ett tomt resultat innebär inte heller att en kund eller ett nummer har godkänts. Kontakta supporten om resultatet är oklart.
Begäran
Använd inloggningsuppgifterna för ditt aktiverade API-konto via HTTPS. Basic-autentisering och aktiverade bearer-token för API-konton stöds; kontobegränsningar gäller.
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"| Namn | Typ | Obligatorisk | Beskrivning |
|---|---|---|---|
country | sträng | Ja | Landets ISO-kod från get_document_countries. |
number_type | sträng | Ja | Typnamn från get_document_number_types, till exempel Local; matchningen gör ingen skillnad på stora och små bokstäver. Ange namnet, inte dess ID. |
Svar
Kontrollera status.code i JSON-kroppen samt HTTP-statusen. response är en enskild kravresurs med id, type och attributes, samt relationships när dessa returneras. ID:n i resursen och relationsdata är opaka och ska inte tolkas. HTML-taggar har tagits bort från den valfria texten i restriction_message; behandla den återstående texten som text, inte som betrodd HTML. Hanteraren returnerar den första kravresursen, så dra inte slutsatsen att svaret är en uttömmande lista. Vilka attribut och relationer som är tillgängliga beror på land och typ; exemplet är inte ett fullständigt, fast schema.
Exempel på svarsstruktur; inte aktuella kontodata eller en aktuell offert.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"id": "REQUIREMENT_ID_FROM_RESPONSE",
"type": "RESOURCE_TYPE_FROM_RESPONSE",
"attributes": {
"restriction_message": "Example country-specific instructions."
}
}
}Fel
- 400: Valideringen av land och number_type misslyckades: ange båda de obligatoriska värdena. Valideringstexten kan innehålla formatering.
- 400: Invalid country ISO or No country registration documents required.: det här tvetydiga meddelandet bevisar inte i sig att ett undantag från registreringskraven gäller.
- 400: Invalid number type: använd ett typnamn som returnerats. Det äldre felmeddelandet listar Global, Local, Mobile, National, Shared Cost och Toll Free.
- 500: Unable to load registration requirements for the specified country and number type.: kraven kunde inte returneras. Försök igen senare eller kontakta supporten.
Tillgänglighet och sidoeffekter
- Den här sökningen i katalogen eller bland kraven skapar ingen identitet, laddar inte upp något styrkande dokument, registrerar inget nummer och lägger ingen beställning.
- Ett lyckat katalogsvar innebär inte att dina dokument har godkänts eller att det har bekräftats att ett valt nummer kan aktiveras.