Lees registrasievereistes

Kies die land en nommertipe

Kies 'n registrasieland en gebruik dan 'n naam wat teruggestuur word deur get_document_number_types. Stuur daardie naam as number_type, nie 'n tipe-ID of 'n algemene nommerontdekkingskategorie nie.

Lees die teruggestuurde instruksies

Hou die vereiste- en verhoudings-ID's vir die betrokke identiteits-/dokumentwerkvloei. Hierdie oproep stuur vereistes terug; dit valideer of dien nie jou lêers in nie. Volg die teruggestuurde instruksies en enige vereistes wat spesifiek vir die gekose nommer geld.

Moenie 'n fout as 'n vrystelling vertolk nie

Die fout oor 'n ongeldige land of geen landregistrasiedokumente kombineer twee toestande. Dit is nie bewys dat registrasie onnodig is nie. 'n Opsoekfout of leë resultaat keur ook nie 'n kliënt of 'n nommer goed nie. Kontak ondersteuning as die resultaat onduidelik is.

Versoek

Gebruik jou geaktiveerde API-rekening se aanmeldbewyse oor HTTPS. Basic-verifikasie en geaktiveerde API-rekening-draertokens word ondersteun; rekeningbeperkings geld.

POST met application/json of 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"

Liggaamparameters
Naam	Tipe	Vereis	Beskrywing
`country`	string	Ja	Land-ISO-kode van get_document_countries.
`number_type`	string	Ja	Tipenaam van get_document_number_types, soos Local; passing ignoreer hoofletters. Verskaf die naam, nie sy ID nie.

Antwoord

Kontroleer status.code in die JSON-liggaam sowel as die HTTP-status. response is 'n enkele vereistehulpbron met id, type en attributes, plus relationships wanneer dit teruggestuur word. ID's in die hulpbron- en verhoudingsdata is ondeursigtig. Opsionele restriction_message-teks het HTML-etikette verwyder; hanteer die oorblywende teks as teks, nie as vertroude HTML nie. Die hanteerder stuur die eerste vereistehulpbron terug, moet dus nie aflei dat hierdie antwoord 'n volledige lys is nie. Beskikbaarheid van attribute/verhoudings hang van die land en tipe af; die voorbeeld is nie 'n volledige vaste skema nie.

Illustratiewe antwoordvorm; nie lewendige rekeningdata of 'n huidige kwotasie nie.

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

Foute

400: Validering van land en number_type het misluk: verskaf albei vereiste waardes. Valideringsteks kan formatering bevat.
400: Invalid country ISO or No country registration documents required.: hierdie dubbelsinnige boodskap bewys nie op sigself 'n registrasievrystelling nie.
400: Invalid number type: gebruik 'n teruggestuurde tipenaam. Die verouderde fout lys Global, Local, Mobile, National, Shared Cost en Toll Free.
500: Unable to load registration requirements for the specified country and number type.: vereistes is nie suksesvol teruggestuur nie. Probeer later weer of kontak ondersteuning.

Beskikbaarheid en newe-effekte

Hierdie katalogus-/vereisteopsoek skep nie 'n identiteit, laai nie 'n bewys op, registreer nie 'n nommer en plaas nie 'n bestelling nie.
'n Suksesvolle katalogusantwoord is nie goedkeuring van jou dokumente of bevestiging dat 'n gekose nommer geaktiveer kan word nie.