Etsi saatavilla olevia puhelinnumeroita

Valitse yksittäinen numeroprefiksi

Käytä maiden ja kattavuusalueiden hakukutsuja ja sen jälkeen kutsua getprefixes ilman ryhmittelyä. Kopioi valitun numeroprefiksin uuid. Jos returns_numbers on 0, numeroprefiksistä annetaan numero tilauksen yhteydessä; käytä palautettua next_function-arvoa sen sijaan, että edellyttäisit yksittäisten numeroiden luetteloa.

Selaa rajattua tuloserää

Käytä tavallisessa haussa asetusta compact=1 ja määritä haluttu eräkoko sekä polussa että quantity-kyselyparametrissa alla olevan esimerkin mukaisesti. Sivu- tai kursoriparametria ei ole. Tiivis tulos on otos; pyynnön toistaminen ei takaa seuraavaa sivua, jonka numerot olisivat kaikki uusia. Älä tulkitse tyhjää tai pientä tulosta koko numerovalikoiman määräksi.

Etsi helposti muistettava numerosarja

Anna number_filter_mode=contains tai ends_with sekä number_filter_value. Arvon on sisällettävä 1–15 numeroa. Haku saattaa noutaa rajattuja ehdokaseriä ennen suodatusta, joten muita vastaavia numeroita voi jäädä löytymättä. Jos tarvitset vaaditun haun toteuttamiseen sitä tukevan lähteen, pyydä pid-valitsin MultiTELiltä ja käytä asetusta filter_required=1; puuttuva tai tuen ulkopuolelle jäävä valinta palauttaa API-virheen.

Tarkista valittu numero

Lue samasta tuloksesta number, info.uuid, valittu price[].uuid, käytettävissä olevien ominaisuuksien nimet ja rekisteröintivaatimukset. price-taulukossa voi olla useita hinnoitteluvaihtoehtoja, joiden kanavamäärät ja hinnat eroavat toisistaan. Rahamääräiset kentät ja määrät voidaan esittää merkkijonoina. Valinnaiset metatiedot, kuten info.state, vaihtelevat lähteittäin; älä edellytä yhtä yhteistä tilatiedon rakennetta äläkä päättele hintoja tunnisteesta.

Suorituspolussa, joka ei käytä suoratoistoa, ehdokkaista poistetaan kaksoiskappaleet ja tulospaikat jaetaan lähteiden kesken ennen kuin valittu erä lajitellaan ensimmäisen hinnoitteluvaihtoehdon kuukausihinnan mukaan. Muut suorituspolut voivat aloittaa suoratoiston aiemmin, joten kaikkia pyyntöjä koskevaa takuuta koko tuloksen järjestyksestä tai kaksoiskappaleiden poistamisesta ei ole. Lajittelu ei myöskään osoita, että palautettu otos sisältäisi koko luettelon halvimman numeron.

Tilaa erikseen ja varmista tulos

Haku ei osta eikä varaa mitään. Säilytä palautetut numeron ja hinnoitteluvaihtoehdon tunnisteet samalla tilillä tehtävää tilausta varten. Tarkista todellinen hinnoitteluvaihtoehto, vaatimukset ja veloitukset ennen tilauksen lähettämistä. Rekisteröintivaatimukset voivat viivästyttää aktivointia; hakutulos ei määritä kiinteää aktivoinnin määräaikaa.

Pyyntö

Käytä käytössä olevaa MultiTEL API -tiliä: salasanatilillä HTTP Basic -tunnuksia tai tunnistepohjaisella tilillä Authorization: Bearer -otsaketta. Tilin käyttöoikeudet ja IP-rajoitukset ovat voimassa. Katso yhteiset tunnistautumisohjeet.

Polkuparametrit ja URL-kyselyparametrit. Käytä julkiseen hakutoimintoon GET-menetelmää. Käsittelijä hyväksyy myös tiettyjä lomake- ja pyyntöarvoja, mutta se ei ole hakurajapinta, joka vastaanottaa haun JSON-muotoisessa pyyntörungossa.

curl --fail-with-body --get \
  --user "${MULTITEL_API_USERNAME}:${MULTITEL_API_PASSWORD}" \
  --data-urlencode "compact=1" \
  --data-urlencode "quantity=10" \
  "https://api.multitel.net/v3/getnumbers/${PREFIX_ID}/10"

Vastaus

Yksi JSON-olio, joka sisältää kentät status ja response. Haun onnistuessa kentän status.code arvo on 200 ja response on numerotietueiden taulukko. status.results kertoo palautetun taulukon tietueiden määrän; kentän status.msg arvo voi olla Results: N tai suoratoistetussa vastauksessa OK. Ilman asetusta compact=1 jotkin haut kirjoittavat response-taulukon vähitellen ja lopuksi kentän status, joten odota koko JSON-runkoa. Tämä ei ole rivinvaihdoilla eroteltua JSONia. Tarkista status.code myös silloin, kun HTTP-siirto onnistuu. Tyypilliset kentät näytetään alla; lähdekohtaiset metatiedot ja valinnaiset kentät vaihtelevat. Käsittele kaikkia tunnisteita arvoina, joiden sisällöstä ei pidä tehdä päätelmiä, ja säilytä numero sekä sen valittu price[].uuid yhdessä.

Havainnollistava vastauksen rakenne; ei todellisia tilitietoja eikä ajantasaista hintatarjousta.

{
  "status": {
    "code": 200,
    "msg": "Results: 1",
    "results": 1
  },
  "response": [
    {
      "number": "12125550123",
      "info": {
        "uuid": "NUMBER_ID_FROM_RESPONSE",
        "prefix_uuid": "PREFIX_ID_FROM_RESPONSE",
        "area_uuid": "AREA_ID_FROM_RESPONSE",
        "country_uuid": "COUNTRY_ID_FROM_RESPONSE",
        "country_iso": "US",
        "prefix": "+1212",
        "name": "Example area",
        "state": "US"
      },
      "price": [
        {
          "uuid": "PRICE_PLAN_ID_FROM_RESPONSE",
          "per_minute": "0.01",
          "per_sms": "0",
          "per_mms": "0",
          "free_minutes": "0",
          "setup_price": "1.00",
          "monthly_price": "2.00",
          "yearly_price": "0",
          "channels": "2"
        }
      ],
      "contract": {
        "term": "1 month",
        "renewal": "monthly",
        "notice": "none"
      },
      "restrictions": {
        "needs_registration": "0",
        "restrictions": ""
      },
      "features": [
        "voice"
      ],
      "overflow": "0"
    }
  ]
}

Virheet

• 401: Tunnistautuminen epäonnistui. Virheelliset tai puuttuvat tunnukset ja evätty pääsy API-tilille eivät tuota hakutuloksia.
• 404: Invalid prefix ID, Invalid country, Invalid area tai No numbers found. Lue status.msg; virhevastaus ei ole numerotaulukko.
• 400: NUMBER_FILTER_INVALID kentässä response.code: virheellinen hakutapa, arvo, joka ei koostu 1–15 numerosta, tai filter_required ilman sekä hakutapaa että arvoa.
• 422: NUMBER_FILTER_UNSUPPORTED kentässä response.code: joko numeroprefiksistä annetaan numero tilauksen yhteydessä (reason=order_only_prefix ja next_function ilmaisee tilausreitin) tai erikseen valittu lähde ei pysty tukemaan vaadittua suodatusta.

Saatavuus ja sivuvaikutukset

• Tämä käsittelijä hakee numeroita ja valmistelee hintatarjouksia; se ei lähetä numerotilausta eikä veloita numeron ostomaksua. Se voi päivittää luettelon välimuisteja, poistaa vanhentuneita numerotietoja välimuistista, tallentaa tilikohtaisia hinnoitteluvaihtoehtoja ja kirjoittaa hakulokeja.
• Saatavuus kuvaa tiettyä hetkeä eikä ole varaus. Myöhempi tilaus voi epäonnistua tai palauttaa erilaisen saatavuustiedon. Selvitä tilauksen toteutunut tulos ennen kuin yrität ostoa uudelleen.
• Hinnat ovat tilikohtaisia. Säilytä valitun hinnoitteluvaihtoehdon tunniste samalla tilillä käytettäväksi ja tarkista tilausehdot ja veloitukset erikseen; tämä rajapintatoiminto ei yksin osoita, että hinta pysyisi voimassa myöhempään tilaukseen asti.
• Esimerkin numero ja hinnat ovat kuvitteellisia esimerkkejä vastauksen rakenteesta, eivät ajantasainen hintatarjous. Ominaisuudet, kanavamäärät, sopimuskausi ja rekisteröintitiedot on luettava todellisesta valitusta tuloksesta.
• Jotkin rekisteröintikuvaukset sisältävät muotoiltua tekstiä tai linkkejä. Käsittele palautettuja merkkijonoja epäluotettavana datana, kun esität niitä omassa sovelluksessasi.
• Matkapuhelinnumeroiden saatavuus ja niitä koskevat liput riippuvat tilin kelpoisuudesta ja numerovalikoimasta. Luettelon numeroprefiksi tai is_mobile-lippu ei yksin osoita tietyn numeron matkapuhelinominaisuuksia.