Valige number ja hind koos
Ostke üks konkreetne number, mis on valitud värskest saadaolevate numbrite otsingust. Kasutage valitud kirje välja info.uuid numbri ID-na ning üht sama kirje välja price[].uuid väärtustest hinna ID-na. Marsruut aktsepteerib ka täielikku salvestatud numbrit, kuid riigi, piirkonna või prefiksi ID ei asenda numbri valimist.
Otsimine või salvestatud hinnateabe lugemine ei broneeri numbrit ega fikseeri selle hinda. Kinnitage valitud liitumistasu, kuutasu, sissetuleva kõne minutihind, sisalduvad minutid ja kanalid ning konto ostuõigused ja registreerimisnõuded. Läbi vaadatud abifunktsioonis on algne baassumma liitumistasu ja kuutasu summa; valitud paketi kõik teenusepakkujast sõltuvad tasud ja tingimused tuleb eraldi kinnitada.
Esitage kaitsekontrollidega ostupäring meetodiga POST
Kasutage lubatud lähte-IP-aadressilt HTTPS-i kaudu aktiveeritud API-kontot. Järgmine käsk teeb ostu, mitte hinnapakkumist ega proovikäivitust. Määrake kõik muutujad sama värske numbri- ja hinnavaliku põhjal. Piirmääraväljadel säilib pärandliidesest pärit eesliide restore_quote_; praegune portaal kasutab neid ka konkreetse numbri kaitsekontrollidega ostmiseks.
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
--data-urlencode "restore_quote_price_id=$PRICE_ID" \
--data-urlencode "restore_quote_setup=$SETUP_PRICE" \
--data-urlencode "restore_quote_monthly=$MONTHLY_PRICE" \
--data-urlencode "restore_quote_per_minute=$PER_MINUTE_PRICE" \
--data-urlencode "restore_quote_channels=$CHANNELS" \
"https://api.multitel.net/v3/rentnumber/$NUMBER_ID/$PRICE_ID"Kasutage näidatud viisil vormiandmetega POST-päringut. Abifunktsioon oskab parsida ka JSON-i ja suvandite ümbrisstruktuuri, kuid see ülevaatus ei kinnita täielikult samaväärset käitumist kõigis hinnapakkumise ja teenusepakkujate töötlusharudes. Ärge kasutage ostmiseks meetodit GET, kuigi sellel pärandkoordinaatoril puudub selgesõnaline päringumeetodi kontroll.
| Väli | Tähendus |
|---|---|
| NUMBER_ID | Otsingust valitud numbri UUID või täielik salvestatud number. Üks number päringu kohta. |
| PRICE_ID | Valitud numbri ja teie kontoga seotud hinna UUID. Esitage see alati sõnaselgelt. |
| restore_quote_price_id | Peab vastama töötluse käigus määratud hinna ID-le. Selle välja esitamine lubab hinnapakkumise kontrollid; see ei ole idempotentsusvõti. |
| restore_quote_setup | Suurim aktsepteeritav liitumistasu lõpliku mittenegatiivse arvväärtusena. |
| restore_quote_monthly | Suurim aktsepteeritav kuutasu lõpliku mittenegatiivse arvväärtusena. |
| restore_quote_per_minute | Suurim aktsepteeritav sissetuleva kõne minutihind lõpliku mittenegatiivse arvväärtusena. |
| restore_quote_channels | Valitud hinnavariandi täpne täisarvuline kanalite arv, mitte taotlus teistsuguse kanalipaketi saamiseks. |
Kui esitate hinnapakkumise hinna ID, esitage alati ka kõik arvulised hinnapakkumise väljad. Muutunud ID, piirmäära ületav hind, puuduv või vigane piirmäär, muutunud kanalite arv või hõivatud hinnapakkumise lukk põhjustab API koodi 409 tagastamise enne päringu edastamist valitud renditeenuse pakkujale. Võrdlused lubavad väikest ujukomaarvude tolerantsi; kasutage kuvatud paketi tegelikke väärtusi, mitte käsitsi ümardatud hinda.
Kaitsekontrollid ei muuda kogu töövoogu proovikäivituseks ega tehinguks. Registreerimisandmete otsingud, identiteedi loomine või muu abifunktsiooni töö võib toimuda enne neid kontrolle. Samuti ei fikseeri need väliste teenusepakkujate numbrivalikut ega asenda kontotaseme ostupiiranguid.
Registreerimine ja aktiveerimine
Vajaduse korral lisage vormiväli RegistrationID, mis sisaldab kliendile kuuluva registreerimisprofiili UUID-d. See ei ole üles laaditud tõendi, tarnija aadressi ega eraldi identiteediobjekti ID. Abifunktsioon otsib profiili autenditud konto piires ning lükkab puuduva või kättesaamatu profiili tagasi.
Mõnd toetatud numbrivalikusse kuuluvat numbrit saab osta enne registreerimise lõpuleviimist; teiste numbrite puhul peab profiil olemas olema enne ostu. Operaatoripõhine valideerimine või teenuse seadistamine võib siiski vajalik olla. Ärge tõlgendage edukat ostu ega eelkontrolli puudumist registreerimiskohustusest vabastamise või kohese aktiveerimisena.
Kui vastuses on väli registration_requirements, määratleb see riigi ja numbritüübi alusel tehtava struktureeritud nõuete päringu. Kohaldatavate nõuete täitmiseks kasutage registreerimiskataloogi ja tõendite esitamise töövoogu. Tagastatud tekst ja metaandmed ei anna iseenesest profiilile heakskiitu.
Vältige paketi märkamatut asendamist
Pärandkoordinaator võib puuduva hinna tuletada numbri vahemällu salvestatud andmetest. Kui sõnaselgelt esitatud hinna ID-d enam ei eksisteeri, võib see kasutada ka vahemällu salvestatud prefiksi uusimat kontohinda ning uuendada vahemällu salvestatud lubatud hinna valikut. Ärge tuginege nendele varuvariantidele kliendi kinnitatud paketi valimisel.
Esitage valitud hind sõnaselgelt koos sellele vastavate hinnapakkumise kaitsekontrolli väljadega. Hinnapakkumise ID kontroll lükkab teisele ID-le ülemineku tagasi enne rendipäringu edastamist. Aegunud hinna konflikti järel värskendage otsingut ja hankige uus kinnitatud valik, selle asemel et ostu läbisurumiseks kaitsekontrollid eemaldada.
Kõigi töötlusharude jaoks ei ole tagatud broneerimisperioodi ega kõikjal jõustatud vahemälu kehtivusaega. Töövoos kontrollitakse uuesti numbri saadavust, konto hinnapiiranguid ja ostureegleid, kuid kogu teenusepakkujast sõltuva käitumise ülevaatus on veel pooleli.
Täpsemad seaded: konto suunamise vaikeväärtused
Ostetav number võib pärida konto olemasolevad häälkõnede sihtkohad, varusihtkohad, SMS-i sihtkoha ja kõnede algatamise magistraali eelistuse. Vaadake need vaikeväärtused enne tellimist üle; suunamissuvandite väljajätmine ei taga seadistamata numbrit. Läbi vaadatud abifunktsioon lubab vaikimisi automaatse pikendamise.
| Suvand | Väärtuse määramise käitumine |
|---|---|
| uri, uri2, uri3 | Väljajäetud väärtuste asemel kasutatakse konto vastavaid vaikeväärtusi. Sõnaselgelt tühjad väärtused tühjendavad abifunktsiooni väärtuse, selle asemel et vaikeväärtust pärida. Kasutage valitud suunamisrežiimile sobivaid kehtivaid sihtkohti. |
| smsuri | Väärtuse väljajätmisel päritakse konto SMS-i sihtkoht; sõnaselgelt tühi väärtus tühjendab selle abifunktsioonis. |
| origintrunk | Tuvastatud ja sõnaselgelt esitatud magistraali ID on eelisjärjekorras. Kui väärtust ei õnnestu tuvastada, võidakse vea tagastamise asemel kasutada konto eelistust või pärandvaikeväärtust. |
| forward_destination, forwarding_destination, type | Suunamisrežiimi mittetühjad rööpnimed selles eelisjärjekorras. Kasutage konto suunamiskonfiguratsioonis toetatud väärtusi, mitte oletuslikku numbrilist režiimi. |
| RegistrationID | Kliendi piires tehtav registreerimisprofiili otsing; see on suunamise sihtkohtadest eraldi. |
| autorenew | Vaikeväärtus on 1. Abifunktsioon kontrollib, kas väärtus on mittetühi, seega ei keela 0 selle ostuvälja kaudu pikendamist usaldusväärselt. Kasutage konto toetatud pikendamise haldamise võimalusi ja kontrollige salvestatud seadistust. |
Need kirjeldavad ühise abifunktsiooni käitumist ega taga, et kõik tarnijad salvestavad iga valikulise seadistuse ühtemoodi. Olemas on ka muid pärandvälju häälkõnede, kõneposti, faksi ja SMS-i jaoks, kuid need vajavad endiselt täielikku teenusepakkujapõhist ülevaatust. Enne kõnede või sõnumite toimimisele lootmist kontrollige ostetud numbri salvestatud konfiguratsiooni konto töövoo kaudu.
Vastus
Väljamõeldud näide lihtsa ostu kohta; väärtused ja funktsioonid sõltuvad valitud paketist.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"number": "12025550123",
"price": {
"per_minute": "0.0100",
"free_minutes": "100",
"setup_price": "2.00",
"monthly_price": "4.00",
"channels": "2",
"overflow": "0"
},
"features": [
"voice"
],
"needs_registration": 0,
"registration_requirements": null
}
}Koordinaator kasutab oma vastuseümbrist väljadega status.code/status.msg ja response; välja status.results olemasolu ei ole tagatud. Vea korral on vastuseloend üldjuhul tühi. Edu korral kontrollige tagastatud numbrit ja hinda ning seejärel võrrelge neid konto numbriloendi ja registreerimisolekuga. Teenusepakkuja heakskiit ei ole tegelik häälkõne-, SMS-i- ega faksitest.
Vead ja ebaselged tulemused
| API kood | Tähendus |
|---|---|
| 403 | Konto hinna- või ostupiirangud, kättesaamatu hinnavalik või ligipääsmatu registreerimisprofiil võivad töötluse blokeerida. |
| 404 | Puuduv või kättesaamatu numbri-, hinna- või prefiksivalik. |
| 409 | Number on juba aktiivne, hinnapakkumise kaitsekontroll ei vasta enam andmetele või mõni teine kaitsekontrollidega toiming hoiab lukku enda käes. |
| 422 | Registreerimisandmed on nõutavad, puudulikud või neid ei saa läbi vaadatud registreerimise töötlusharudes teenusepakkuja süsteemis luua. |
| 500 ja muud teenusepakkuja või konto koodid | Teenusepakkuja, kohaliku töötluse või reeglitega seotud tõrge. Need ei tõenda kõigil juhtudel, et ostu ei toimunud või tasu ei võetud. |
Lugege lisaks HTTP olekule ka API vastuse tegelikku sisu. Väline teenusepakkuja võib renditellimuse vastu võtta enne, kui kohalik teavitus, registreerimine või muu töötlus nurjub. Mõne kohaliku numbrivarust tehtava eraldamise puhul kasutatakse andmebaasitehinguid, kuid väliste teenusepakkujate tellimustele ei ole üldist tagasipööramisvõimalust. Sellel koordinaatoril puudub kliendi idempotentsusvõti.
Kontrollige andmete kooskõla enne uuesti proovimist
- Salvestage kinnitatud number, hind ja hinnapakkumise piirmäärad oma rakenduse tellimuskirjesse enne päringu ühekordset esitamist.
- Pärast päringut, sealhulgas ajalõpu või vea järel, lugege sama konto ostetud numbrite loendit ja numbri üksikasju.
- Kui number on olemas, kontrollige uue ostupäringu esitamise asemel selle hinda, pikendamist, suunamist ja registreerimisolekut.
- Kui tulemus on endiselt ebaselge, laske klienditoel enne uuesti proovimist kontrollida teenusepakkuja tellimuse ja konto arvelduse kooskõla. Üksnes veateatest või pärandlogi edumärkest ei piisa tõendiks.
- Pärast omandi ja aktiveerimise kinnitamist tehke konto tavapärased suunamiskontrollid ja teenusetestid.