Valige riik ja numbritüüp
Valige registreerimisriik ja kasutage seejärel nime, mille tagastab get_document_number_types. Saatke see nimi parameetri väärtusena: number_type, mitte tüübi ID-d ega üldist numbrite otsingukategooriat.
Lugege tagastatud juhiseid
Säilitage nõude ja seoste ID-d vastava identiteedi- või dokumenditöövoo jaoks. See päring tagastab nõuded; see ei valideeri ega esita teie faile. Järgige tagastatud juhiseid ja kõiki valitud numbrile kehtivaid erinõudeid.
Ärge tõlgendage viga registreerimisnõuetest vabastusena
Veateade kehtetu riigi või riigis registreerimisdokumentide mittevajalikkuse kohta ühendab kaks tingimust. See ei tõenda, et registreerimine pole vajalik. Ka ebaõnnestunud otsing või tühi tulemus ei tähenda kliendi ega numbri heakskiitmist. Kui tulemus on ebaselge, võtke ühendust kasutajatoega.
Päring
Kasutage oma lubatud API konto autentimisandmeid HTTPS-i kaudu. Toetatud on põhiautentimine ja API konto lubatud esitajapääsmikud; kehtivad konto piirangud.
POST sisutüübiga application/json või 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"| Nimi | Tüüp | Kohustuslik | Kirjeldus |
|---|---|---|---|
country | sõne | Jah | Riigi ISO-kood, mille tagastab get_document_countries. |
number_type | sõne | Jah | Tüübi nimi, mille tagastab get_document_number_types, näiteks Local; võrdlemisel ei eristata suur- ja väiketähti. Esitage nimi, mitte selle ID. |
Vastus
Kontrollige nii välja status.code JSON-kehas kui ka HTTP olekut. response on üks nõuete ressurss väljadega id, type ja attributes ning väljaga relationships, kui see tagastatakse. Ressursi- ja seoseandmetes olevate ID-de sisust ei saa tähendust tuletada. Valikulise välja restriction_message tekstist on HTML-märgendid eemaldatud; käsitlege allesjäänud sisu tekstina, mitte usaldusväärse HTML-ina. Käsitleja tagastab esimese nõuete ressursi, seega ärge järeldage, et vastus on ammendav loend. Atribuutide ja seoste olemasolu sõltub riigist ja tüübist; näide ei ole täielik muutumatu skeem.
Vastuse struktuuri illustreeriv näide; see ei sisalda tegelikke jooksvaid kontoandmeid ega kehtivat hinnapakkumist.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"id": "REQUIREMENT_ID_FROM_RESPONSE",
"type": "RESOURCE_TYPE_FROM_RESPONSE",
"attributes": {
"restriction_message": "Example country-specific instructions."
}
}
}Vead
- 400: Riigi ja parameetri number_type valideerimine ebaõnnestus: esitage mõlemad kohustuslikud väärtused. Valideerimisteate tekst võib sisaldada vormindust.
- 400: Invalid country ISO or No country registration documents required.: see mitmetähenduslik teade ei tõenda iseenesest registreerimisnõuetest vabastust.
- 400: Invalid number type: kasutage tagastatud tüübi nime. Varasem veateade loetleb tüübid Global, Local, Mobile, National, Shared Cost ja Toll Free.
- 500: Unable to load registration requirements for the specified country and number type.: nõuete tagastamine ei õnnestunud. Proovige hiljem uuesti või võtke ühendust kasutajatoega.
Kättesaadavus ja kõrvalmõjud
- See kataloogi- või nõuete päring ei loo identiteedikirjet, laadi üles tõendusdokumenti, registreeri numbrit ega esita tellimust.
- Edukas kataloogivastus ei tähenda teie dokumentide heakskiitmist ega kinnita, et valitud numbri saab aktiveerida.