Kehittäjät

POST/v3/get_requirements

Lue rekisteröintivaatimukset

Hae rekisteröintivaatimukset, jotka tällä hetkellä palautetaan annetulle maalle ja numerotyypin nimelle.

Tällä sivulla
  1. Valitse maa ja numerotyyppi
  2. Lue palautetut ohjeet
  3. Älä tulkitse virhettä vapautukseksi rekisteröintivaatimuksista
  4. Pyyntö
  5. Vastaus
  6. Virheet
  7. Saatavuus ja sivuvaikutukset

Valitse maa ja numerotyyppi

Valitse rekisteröintimaa ja käytä sitten nimeä, jonka palauttaa get_document_number_types. Lähetä nimi parametrina number_type, älä tyypin tunnistetta tai yleistä numerohaun luokkaa.

Lue palautetut ohjeet

Säilytä vaatimusten ja suhteiden tunnisteet asianomaista identiteettien ja asiakirjojen työnkulkua varten. Tämä kutsu palauttaa vaatimukset; se ei validoi tiedostojasi eikä lähetä niitä käsiteltäviksi. Noudata palautettuja ohjeita ja mahdollisia valittua numeroa koskevia erityisvaatimuksia.

Älä tulkitse virhettä vapautukseksi rekisteröintivaatimuksista

Virhe, joka koskee virheellistä maata tai sitä, ettei maassa vaadita rekisteröintiasiakirjoja, yhdistää kaksi ehtoa. Se ei todista, että rekisteröinti olisi tarpeetonta. Myöskään epäonnistunut haku tai tyhjä tulos ei tarkoita asiakkaan tai numeron hyväksymistä. Ota yhteyttä tukeen, jos tulos on epäselvä.

Pyyntö

Käytä aktivoidun API-tilisi tunnuksia HTTPS-yhteyden kautta. Basic-todennusta ja API-tilin aktivoituja bearer-tunnuksia tuetaan; tilikohtaiset rajoitukset ovat voimassa.

POST käyttäen sisältötyyppiä application/json tai 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"
Pyynnön rungon parametrit
NimiTyyppiPakollinenKuvaus
countrymerkkijonoKylläMaan ISO-koodi, jonka palauttaa get_document_countries.
number_typemerkkijonoKylläTyypin nimi, jonka palauttaa get_document_number_types, esimerkiksi Local; vertailussa ei huomioida kirjainkokoa. Anna nimi, älä sen tunnistetta.

Vastaus

Tarkista JSON-rungon status.code sekä HTTP-tilakoodi. response on yksittäinen vaatimusresurssi, joka sisältää kentät id, type ja attributes sekä kentän relationships, jos suhteet palautetaan. Resurssin ja suhdetietojen tunnisteet ovat läpinäkymättömiä, eikä niiden sisällöstä pidä päätellä merkitystä. Valinnaisen kentän restriction_message tekstistä on poistettu HTML-tunnisteet; käsittele jäljelle jäävää tekstiä tekstinä, älä luotettuna HTML-sisältönä. Käsittelijä palauttaa ensimmäisen vaatimusresurssin, joten älä päättele vastauksen olevan kattava luettelo. Attribuuttien ja suhteiden saatavuus riippuu maasta ja tyypistä; esimerkki ei ole täydellinen, kiinteä skeema.

Havainnollistava vastausrakenne; ei reaaliaikaisia tilitietoja eikä voimassa oleva tarjous.

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

Virheet

  • 400: Maan ja parametrin number_type validointi epäonnistui: anna molemmat pakolliset arvot. Validointiteksti voi sisältää muotoiluja.
  • 400: Invalid country ISO or No country registration documents required.: tämä monitulkintainen viesti ei yksinään todista vapautusta rekisteröintivaatimuksista.
  • 400: Invalid number type: käytä palautettua tyypin nimeä. Vanha virheilmoitus luettelee nimet Global, Local, Mobile, National, Shared Cost ja Toll Free.
  • 500: Unable to load registration requirements for the specified country and number type.: vaatimusten palauttaminen ei onnistunut. Yritä myöhemmin uudelleen tai ota yhteyttä tukeen.

Saatavuus ja sivuvaikutukset

  • Tämä luettelo- tai vaatimushaku ei luo identiteettiä, lataa todistusasiakirjaa palveluun, rekisteröi numeroa eikä tee tilausta.
  • Onnistunut luettelovastaus ei tarkoita asiakirjojesi hyväksymistä eikä vahvistusta siitä, että valittu numero voidaan aktivoida.