Izvēlieties atsevišķu prefiksu
Izmantojiet valstu un pārklājuma apgabalu meklēšanas izsaukumus, pēc tam getprefixes bez grupēšanas. Nokopējiet izvēlētā prefiksa uuid. Ja returns_numbers ir 0, numurs šim prefiksam tiek piešķirts pasūtīšanas brīdī; izmantojiet atgriezto next_function, nevis pieprasiet atsevišķu numuru sarakstu.
Pārlūkojiet ierobežota lieluma rezultātu kopu
Parastai meklēšanai izmantojiet compact=1 un norādiet vēlamo rezultātu kopas lielumu gan ceļā, gan quantity vaicājuma parametrā, kā parādīts tālāk. Lapas vai kursora parametra nav. Kompaktais rezultāts ir izlase; atkārtots pieprasījums negarantē nākamo lapu bez pārklāšanās ar iepriekšējo. Tukšs vai neliels rezultāts nenorāda kopējo pieejamo numuru skaitu.
Atrodiet viegli iegaumējamu ciparu kombināciju
Norādiet number_filter_mode=contains vai ends_with kopā ar number_filter_value. Vērtībā jābūt 1–15 cipariem. Pirms filtra piemērošanas meklēšana var izgūt ierobežotas numuru kandidātu kopas, tāpēc citi atbilstošie pieejamie numuri var palikt neatrasti. Ja nepieciešams atbalstīts avots obligātās meklēšanas veikšanai, saņemiet pid atlasītāju no MultiTEL un izmantojiet filter_required=1; ja atlase nav norādīta vai netiek atbalstīta, tiek atgriezta API kļūda.
Pārskatiet izvēlēto numuru
Nolasiet number, info.uuid, izvēlēto price[].uuid, pieejamo funkciju nosaukumus un reģistrācijas prasības no tā paša rezultāta. price masīvā var būt vairāki plāni ar atšķirīgu kanālu skaitu un tarifiem. Naudas summu lauki un daudzumi var būt kodēti kā virknes. Neobligātie metadati, tostarp info.state, dažādos avotos atšķiras; nepieprasiet vienotu universālu štata datu struktūru un neizseciniet cenas no ID.
Apstrādē bez straumēšanas numuru kandidātiem tiek noņemti dublikāti un tiek sadalīts to piešķīrums starp avotiem, pirms izvēlētā kopa tiek sakārtota pēc pirmā plāna mēneša maksas. Citos apstrādes ceļos straumēšana var sākties agrāk, tāpēc visiem pieprasījumiem netiek garantēta vienota kopējā kārtošana vai dublikātu noņemšana. Kārtošana arī nepierāda, ka atgrieztajā izlasē ir lētākais numurs visā katalogā.
Pasūtiet atsevišķi un apstipriniet rezultātu
Meklēšana neko neiegādājas un nerezervē. Saglabājiet atgrieztos numura un plāna identifikatorus pasūtīšanai tajā pašā kontā. Pirms pasūtījuma iesniegšanas pārskatiet faktisko plānu, prasības un maksas. Reģistrācijas prasības var aizkavēt aktivizēšanu; meklēšanas rezultāts nenosaka fiksētu aktivizēšanas termiņu.
Pieprasījums
Izmantojiet iespējotu MultiTEL API kontu: kontam ar paroli izmantojiet HTTP Basic akreditācijas datus, savukārt kontam ar pilnvaru — Authorization: Bearer. Ir spēkā konta atļaujas un tā IP ierobežojumi. Skatiet vispārīgos autentifikācijas norādījumus.
Ceļa parametri un URL vaicājuma parametri. Publiskajai meklēšanas darbplūsmai izmantojiet GET. Apstrādātājs pieņem arī noteiktas veidlapas vai pieprasījuma vērtības, taču tas nav meklēšanas API ar JSON pieprasījuma pamatdaļu.
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"| Nosaukums | Tips | Obligāts | Apraksts |
|---|---|---|---|
prefix_id | string | Jā | Atsevišķa prefiksa ID, kas atgriezts negrupētā getprefixes atbildē. Nokopējiet to precīzi; neaizstājiet to ar valsts, pārklājuma apgabala, grupēta prefiksa vai tarifu plāna ID. |
quantity | integer | Nē | Izgūstamais skaits, pēc noklusējuma 1. Vērtības, kas nav pozitīvas, tiek aizstātas ar 1. Ceļa parametrs quantity viens pats nav uzticams kopējā rezultātu skaita ierobežojums: meklēšana, kas nav piesaistīta konkrētam avotam un kurai nav vaicājuma parametra quantity, var paplašināt izgūšanu un pirms citas apstrādes atgriezt līdz 50 ierakstiem no katra avota. Parastai pārlūkošanai ar ierobežotu rezultātu skaitu izmantojiet compact=1 un atkārtojiet vēlamo skaitu vaicājumā, kā norādīts piemērā. |
| Nosaukums | Tips | Obligāts | Apraksts |
|---|---|---|---|
quantity | integer | Nē | Pieprasītais galīgās rezultātu kopas lielums. Netukšas vērtības tiek pārveidotas par veseliem skaitļiem ar minimālo vērtību 1. Apstrādē bez straumēšanas, kas nav piesaistīta konkrētam avotam, tas ierobežo galīgo piešķirto rezultātu skaitu. Tas neuzliek pakalpojumam pienākumu atrast tik daudz numuru. Kompaktas meklēšanas, kas piesaistītas konkrētam avotam, šī ierobežojuma vietā var atgriezt avota kompakto rezultātu kopu. |
compact | string | Nē | Izmantojiet 1, true vai on, lai saņemtu mazāku atbildi bez straumēšanas, kurā pirms galīgās rezultātu piešķiršanas ir līdz 10 ierakstiem no katra avota. Rezultāti ir pašlaik izgūto pieejamo numuru izlase, nevis pilns katalogs. |
number_filter_mode | string | Nē | Neobligāts ciparu kombinācijas meklēšanas režīms: contains vai ends_with. Norādiet arī number_filter_value. Rezultāti tiek pārbaudīti pēc normalizētiem tālruņa numura cipariem; meklēšana nepārskata visus pieejamos numurus, lai garantētu visas iespējamās atbilstības. |
number_filter_value | string | Nē | No 1 līdz 15 cipariem, bez atstarpēm, + vai pieturzīmēm. Sākuma nullēm ir nozīme; nosūtiet vērtību kā tekstu. |
filter_required | string | Nē | Papildu iestatījums: 1, true, yes vai on nosaka, ka filtra režīmam nepieciešams atbalstīts, skaidri atlasīts pieejamo numuru avots. Pretējā gadījumā API atgriež status.code 422. Parastai kataloga pārlūkošanai tas nav nepieciešams. |
pid | string | Nē | MultiTEL nodrošināts papildu pieejamo numuru atlasītājs. Tiek pieņemtas skaitliskas vērtības un atbalstītas 32 rakstzīmju heksadecimālās formas; neatpazītas vērtības tiek ignorētas bez paziņojuma. Parastai lietošanai nenorādiet. Neatvasiniet atlasītājus no cenu ID un nepieņemiet, ka patvaļīgs atlasītājs ierobežo pieejamos numurus tikai ar konkrēto atlasi. |
Atbilde
Viens JSON objekts, kas satur status un response. Veiksmīgas izpildes gadījumā status.code ir 200 un response ir numuru ierakstu masīvs. status.results ir atgrieztā masīva elementu skaits; straumētai atbildei status.msg var būt Results: N vai OK. Bez compact=1 dažas meklēšanas raksta response masīvu pakāpeniski un noslēdz atbildi ar status, tāpēc sagaidiet visu JSON pamatdaļu. Tas nav JSON formāts ar ierakstiem, kas atdalīti ar jaunām rindām. Pārbaudiet status.code arī tad, ja HTTP pārsūtīšana ir veiksmīga. Tālāk ir parādīti tipiskie lauki; avotiem raksturīgie metadati un neobligātie lauki atšķiras. Neizseciniet nozīmi no identifikatoru satura un saglabājiet numuru kopā ar tā izvēlēto price[].uuid.
Atbildes struktūras ilustrācija; tie nav reāli konta dati vai aktuāls cenas piedāvājums.
{
"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"
}
]
}Kļūdas
- 401: Autentifikācija neizdevās. Ja akreditācijas dati ir nederīgi vai trūkst vai piekļuve API kontam ir noraidīta, meklēšanas rezultāti netiek sniegti.
- 404: Invalid prefix ID, Invalid country, Invalid area vai No numbers found. Izlasiet status.msg; kļūdas atbilde nav numuru masīvs.
- 400: NUMBER_FILTER_INVALID laukā response.code: nederīgs režīms, vērtība, kas neatbilst 1–15 ciparu prasībai, vai filter_required, ja nav norādīts gan režīms, gan vērtība.
- 422: NUMBER_FILTER_UNSUPPORTED laukā response.code: vai nu numurs šim prefiksam tiek piešķirts pasūtīšanas brīdī (reason=order_only_prefix un next_function norāda pasūtīšanas maršrutu), vai arī skaidri atlasītais avots nevar atbalstīt obligāto filtru.
Pieejamība un blakusefekti
- Šis apstrādātājs meklē un sagatavo cenu piedāvājumus; tas neiesniedz numura pasūtījumu un neietur maksu par numura iegādi. Tas var atjaunināt kataloga kešatmiņas, noņemt novecojušus pieejamo numuru kešatmiņas ierakstus, saglabāt konkrētam kontam paredzētus tarifu plānus un veikt ierakstus meklēšanas žurnālos.
- Pieejamība atspoguļo situāciju konkrētā brīdī un nav rezervācija. Vēlāks pasūtījums var neizdoties vai uzrādīt atšķirīgu pieejamību. Pirms atkārtota iegādes mēģinājuma pārbaudiet un saskaņojiet pasūtījuma rezultātu.
- Cenas ir noteiktas konkrētam kontam. Saglabājiet izvēlētā plāna ID lietošanai tajā pašā kontā un atsevišķi pārskatiet pasūtījuma noteikumus un maksas; šis galapunkts viens pats neapliecina, ka cena paliks spēkā līdz vēlākam pasūtījumam.
- Piemērā norādītais numurs un cenas ir izdomāti atbildes struktūras piemēri, nevis aktuāls cenas piedāvājums. Iespējas, kanālu skaits, līguma termiņš un reģistrācijas informācija jānolasa no faktiski izvēlētā rezultāta.
- Dažos reģistrācijas aprakstos ir formatēts teksts vai saites. Attēlojot atgrieztās virknes savā lietotnē, apstrādājiet tās kā neuzticamus datus.
- Mobilo numuru pieejamība un pazīmes ir atkarīgas no konta atbilstības nosacījumiem un pieejamo numuru krājuma. Kataloga prefikss vai is_mobile pazīme viena pati neapliecina konkrēta numura mobilās iespējas.