Vali üksik prefiks
Kasuta riikide ja katvusalade leidmise päringuid ning seejärel funktsiooni getprefixes ilma rühmitamiseta. Kopeeri valitud prefiksi uuid. Kui returns_numbers on 0, määratakse selle prefiksi number tellimisel; kasuta tagastatud välja next_function selle asemel, et nõuda üksikute numbrite loendit.
Sirvi piiratud suurusega tulemikogumit
Tavalise otsingu puhul kasuta compact=1 ning määra soovitud tulemikogumi suurus nii URL-i tees kui ka päringuparameetri quantity väärtuses, nagu allpool näidatud. Lehe- ega kursoriparameetrit ei ole. Kompaktne tulemus on valim; päringu kordamine ei taga järgmist lehte, mille kirjed varasematega ei kattu. Ära tõlgenda tühja või väikest tulemust kõigi saadaolevate numbrite koguarvuna.
Leia meeldejääv numbrimuster
Määra number_filter_mode=contains või ends_with koos parameetriga number_filter_value. Väärtus peab sisaldama 1–15 numbrit. Otsing võib enne filtri rakendamist laadida piiratud hulga võimalikke vasteid, mistõttu võivad teised sobivad saadaolevad numbrid leidmata jääda. Kui vajad nõutud otsingu tegemiseks seda toetavat allikat, hangi valija pid MultiTEL-ilt ja kasuta filter_required=1; puuduva või toetamata valiku korral tagastab API vea.
Vaata valitud number üle
Vaata välju number, info.uuid, valitud hinnapaketi välja price[].uuid, saadaolevate funktsioonide nimesid ja registreerimisnõudeid samast tulemusest. Massiiv price võib pakkuda mitut paketti, mille kanalite arvud ja tariifid erinevad. Rahalised väljad ja kogused võivad olla kodeeritud stringidena. Valikulised metaandmed, sealhulgas info.state, erinevad allikati; ära eelda üht universaalset osariigiandmete struktuuri ega tuleta hindu ID põhjal.
Ilma voogedastuseta töötluse korral eemaldatakse võimalikest vastetest duplikaadid ja jaotatakse tulemused allikate vahel, enne kui valitud tulemikogum esimese hinnapaketi kuutasu järgi sorditakse. Muude töötlusviiside korral võib voogedastus alata varem, mistõttu ei kehti kõigi päringute puhul üldine järjestuse ega duplikaatide eemaldamise garantii. Sortimine ei tõenda ka seda, et tagastatud valim sisaldab kogu kataloogi odavaimat numbrit.
Esita tellimus eraldi ja kontrolli tulemust
Otsing ei osta ega broneeri midagi. Säilita tagastatud numbri ja hinnapaketi identifikaatorid sama konto kaudu tellimiseks. Enne tellimuse esitamist vaata üle tegelik hinnapakett, nõuded ja tasud. Registreerimisnõuded võivad aktiveerimist edasi lükata; otsingutulemus ei määra kindlat aktiveerimistähtaega.
Päring
Kasuta lubatud juurdepääsuga MultiTEL-i API kontot: parooliga konto puhul HTTP Basic autentimisandmeid või tõendiga konto puhul päist Authorization: Bearer. Kehtivad konto õigused ja IP-piirangud. Vaata üldist autentimisjuhendit.
URL-i teeparameetrid ja päringuparameetrid. Avaliku otsinguvoo jaoks kasuta meetodit GET. Töötleja võtab vastu ka teatud vormi- ja päringuväärtusi, kuid see ei ole JSON-kehaga otsingu-API.
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"| Nimi | Tüüp | Kohustuslik | Kirjeldus |
|---|---|---|---|
prefix_id | string | Jah | Rühmitamata getprefixes vastuses tagastatud üksiku prefiksi ID. Kopeeri see täpselt; ära asenda seda riigi, katvusala, rühmitatud prefiksi ega hinnapaketi ID-ga. |
quantity | integer | Ei | Laaditavate kirjete sihtarv, vaikimisi 1. Null ja negatiivsed väärtused asendatakse väärtusega 1. Ainuüksi teeparameeter quantity ei piira usaldusväärselt tulemuste koguarvu: kindla allikaga sidumata otsing ilma päringuparameetrita quantity võib laiendada laaditavat hulka ja tagastada enne edasist töötlust kuni 50 kirjet allika kohta. Tavaliseks piiratud mahuga sirvimiseks kasuta compact=1 ning korda soovitud kogust päringuparameetris, nagu näites. |
| Nimi | Tüüp | Kohustuslik | Kirjeldus |
|---|---|---|---|
quantity | integer | Ei | Soovitud lõpliku tulemikogumi suurus. Mittetühjad väärtused teisendatakse täisarvudeks, mille vähim väärtus on 1. Kindla allikaga sidumata ja ilma voogedastuseta töötluse korral piirab see lõplikku tulemuste jaotust. See ei sunni teenust leidma nii palju numbreid. Kindla allikaga seotud kompaktsed otsingud võivad selle piirangu järgimise asemel tagastada allika kompaktse tulemikogumi. |
compact | string | Ei | Väiksema, ilma voogedastuseta vastuse saamiseks kasuta väärtust 1, true või on; enne lõplikku jaotust on selles kuni 10 kirjet allika kohta. Tulemused on valim parajasti laaditud saadaolevatest numbritest, mitte täielik kataloog. |
number_filter_mode | string | Ei | Valikuline numbrimustri režiim: contains või ends_with. Määra ka number_filter_value. Tulemusi kontrollitakse telefoninumbrite normaliseeritud numbrijadade alusel; otsing ei käi läbi kõiki saadaolevaid numbreid, et tagada kõigi võimalike vastete leidmine. |
number_filter_value | string | Ei | Vähemalt 1 ja kõige rohkem 15 numbrit, ilma tühikute, märgi + või kirjavahemärkideta. Algusnullid on olulised; saada väärtus tekstina. |
filter_required | string | Ei | Täpsem seadistus: väärtus 1, true, yes või on nõuab filtrirežiimi toetavat, selgesõnaliselt valitud numbriallikat. Vastasel juhul tagastab API välja status.code väärtuseks 422. Tavaliseks kataloogi sirvimiseks ei ole see vajalik. |
pid | string | Ei | MultiTEL-i antud numbriallika valija täpsemaks kasutuseks. Lubatud on arvulised ja toetatud 32 märgi pikkused kuueteistkümnendsüsteemi kujud; tundmatuid väärtusi eiratakse sellest teatamata. Tavakasutuses jäta see määramata. Ära tuleta valijaid hinna-ID-dest ega eelda, et suvaline valija piirab saadaolevad numbrid üksnes kindla allikaga. |
Vastus
Üks JSON-objekt, mis sisaldab välju status ja response. Õnnestumise korral on status.code väärtus 200 ja response on numbrikirjete massiiv. status.results näitab tagastatud massiivi kirjete arvu; status.msg väärtus võib olla Results: N või voogedastatava vastuse korral OK. Ilma seadistuseta compact=1 kirjutavad mõned otsingud massiivi response järk-järgult ja lõpetavad väljaga status, seega oota ära kogu JSON-keha. See ei ole reavahetustega eraldatud JSON. Kontrolli välja status.code ka siis, kui HTTP-edastus õnnestub. Tüüpilised väljad on näidatud allpool; allikapõhised metaandmed ja valikulised väljad varieeruvad. Käsitle iga identifikaatorit läbipaistmatu väärtusena ning säilita number koos selle valitud hinnapaketi väljaga price[].uuid.
Vastuse struktuuri näide; see ei ole konto tegelik teave ega kehtiv hinnapakkumine.
{
"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"
}
]
}Vead
- 401: Autentimine ebaõnnestus. Kehtetute või puuduvate autentimisandmete ning API kontole juurdepääsu keelamise korral otsingutulemusi ei tagastata.
- 404: Invalid prefix ID, Invalid country, Invalid area või No numbers found. Vaata välja status.msg; veavastus ei ole numbrite massiiv.
- 400: NUMBER_FILTER_INVALID väljal response.code: kehtetu režiim, väärtus, mis ei koosne 1–15 numbrist, või filter_required ilma mõlema nõutud parameetrita: režiimi ja väärtuseta.
- 422: NUMBER_FILTER_UNSUPPORTED väljal response.code: kas määratakse selle prefiksi number alles tellimisel (reason=order_only_prefix ja next_function näitab tellimise marsruuti) või ei toeta selgesõnaliselt valitud allikas nõutud filtrit.
Saadavus ja kõrvalmõjud
- See töötleja otsib numbreid ja koostab hinnapakkumisi; see ei esita numbritellimust ega võta numbri ostmise tasu kontolt maha. See võib värskendada kataloogi vahemälusid, eemaldada vahemälust aegunud saadavuskirjeid, salvestada kontopõhiseid hinnapakette ja kirjutada otsingulogisid.
- Saadavus kajastab konkreetset ajahetke ega ole broneering. Järgnev tellimus võib ebaõnnestuda või näidata teistsugust saadavust. Enne ostu uuesti proovimist kontrolli ja kooskõlasta tellimuse tulemus.
- Hinnad on kontopõhised. Säilita valitud hinnapaketi ID sama konto jaoks ning vaata tellimistingimused ja tasud eraldi üle; ainuüksi see lõpp-punkt ei tõenda, et hind kehtib ka hilisema tellimuse ajal.
- Näites esitatud number ja hinnad on väljamõeldud vastusestruktuuri näited, mitte kehtiv hinnapakkumine. Võimalused, kanalite arvud, lepinguperiood ja registreerimisteave tuleb vaadata tegelikust valitud tulemusest.
- Mõned registreerimiskirjeldused sisaldavad vormindatud teksti või linke. Käsitle tagastatud stringe oma rakenduses kuvamisel ebausaldusväärsete andmetena.
- Mobiilinumbrite saadavus ja vastavad tunnused sõltuvad konto sobivusest ning saadaolevatest numbritest. Ainuüksi kataloogiprefiks või tunnus is_mobile ei tõenda konkreetse numbri mobiilsidetoimingute võimalusi.