Selectați țara și tipul de număr
Alegeți țara de înregistrare, apoi folosiți o denumire returnată de get_document_number_types. Trimiteți acea denumire ca number_type, nu un ID de tip sau o categorie generală de căutare a numerelor.
Citiți instrucțiunile returnate
Păstrați ID-urile cerințelor și ale relațiilor pentru fluxul de lucru relevant privind identitatea sau documentele. Acest apel returnează cerințe; nu validează și nu depune fișierele dumneavoastră. Urmați instrucțiunile returnate și orice cerințe specifice numărului selectat.
Nu interpretați o eroare ca pe o scutire
Eroarea referitoare la o țară nevalidă sau la lipsa documentelor de înregistrare necesare pentru țară combină două condiții. Nu constituie o dovadă că înregistrarea nu este necesară. Nici eșecul căutării, nici un rezultat gol nu reprezintă aprobarea unui client sau a unui număr. Contactați serviciul de asistență dacă rezultatul este neclar.
Cerere
Folosiți datele de autentificare ale contului API activat, prin HTTPS. Sunt acceptate autentificarea de bază și tokenurile de tip bearer activate pentru contul API; se aplică restricțiile contului.
POST cu application/json sau 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"| Nume | Tip | Obligatoriu | Descriere |
|---|---|---|---|
country | șir de caractere | Da | Codul ISO al țării din get_document_countries. |
number_type | șir de caractere | Da | Denumirea tipului din get_document_number_types, de exemplu Local; compararea nu ține cont de majuscule și minuscule. Furnizați denumirea, nu ID-ul acesteia. |
Răspuns
Verificați status.code în corpul JSON, precum și starea HTTP. response este o singură resursă de cerințe cu id, type și attributes, plus relationships atunci când acestea sunt returnate. ID-urile din datele resursei și ale relațiilor sunt opace. Etichetele HTML sunt eliminate din textul opțional restriction_message; tratați textul rămas ca text, nu ca HTML de încredere. Componenta de procesare returnează prima resursă de cerințe, așadar nu deduceți că acest răspuns este o listă exhaustivă. Disponibilitatea atributelor și a relațiilor depinde de țară și de tip; exemplul nu reprezintă o schemă fixă și completă.
Structură ilustrativă a răspunsului; nu reprezintă date în timp real ale contului sau o ofertă de preț actuală.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"id": "REQUIREMENT_ID_FROM_RESPONSE",
"type": "RESOURCE_TYPE_FROM_RESPONSE",
"attributes": {
"restriction_message": "Example country-specific instructions."
}
}
}Erori
- 400: Validarea țării și a number_type a eșuat: furnizați ambele valori obligatorii. Textul de validare poate conține formatare.
- 400: Invalid country ISO or No country registration documents required.: acest mesaj ambiguu nu dovedește, prin el însuși, existența unei scutiri de la înregistrare.
- 400: Invalid number type: folosiți o denumire de tip returnată. Mesajul de eroare din versiunea veche enumeră Global, Local, Mobile, National, Shared Cost și Toll Free.
- 500: Unable to load registration requirements for the specified country and number type.: cerințele nu au fost returnate cu succes. Încercați din nou mai târziu sau contactați serviciul de asistență.
Disponibilitate și efecte secundare
- Această căutare în catalog sau în cerințe nu creează o identitate, nu încarcă un document justificativ, nu înregistrează un număr și nu plasează o comandă.
- Un răspuns reușit din catalog nu reprezintă aprobarea documentelor dumneavoastră sau confirmarea că un număr selectat poate fi activat.