Izstrādātājiem

POST/v3/rentnumber/{number_id}/{price_id}

Iegādājieties izvēlēto tālruņa numuru

Iesniedziet vienu apstiprinātu numuru un cenu ar cenas piedāvājuma aizsargpārbaudēm, pēc tam pirms atkārtota mēģinājuma pārbaudiet īpašumtiesības un aktivizāciju.

Šajā lapā
  1. Izvēlieties numuru un cenu kopā
  2. Nosūtiet iegādes pieprasījumu ar aizsargpārbaudēm, izmantojot POST
  3. Reģistrācija un aktivizācija
  4. Izvairieties no plāna aizstāšanas bez brīdinājuma
  5. Papildu iestatījumi: konta maršrutēšanas noklusējuma vērtības
  6. Atbilde
  7. Kļūdas un neskaidri rezultāti
  8. Pirms atkārtota mēģinājuma noskaidrojiet faktisko stāvokli

Izvēlieties numuru un cenu kopā

Iegādājieties vienu konkrētu numuru, kas izvēlēts no tikko veiktas pieejamo numuru meklēšanas rezultātiem. Izmantojiet izvēlētā ieraksta info.uuid kā numura ID un vienu no tā paša ieraksta price[].uuid vērtībām kā cenas ID. Maršruts pieņem arī pilnu saglabāto numuru, taču valsts, reģiona vai prefiksa ID neaizstāj numura izvēli.

Meklēšana vai saglabāto cenu datu nolasīšana nerezervē numuru un nefiksē tā cenu. Pārbaudiet izvēlēto pieslēgšanas maksu, mēneša maksu, ienākošo zvanu minūtes tarifu, iekļautās minūtes un kanālus, kā arī konta iegādes atļaujas un reģistrācijas prasības. Pārskatītajā palīgmodulī sākotnējā pamatsumma ir pieslēgšanas maksa kopā ar mēneša maksu; izvēlētajam plānam jāapstiprina visas konkrētā pakalpojumu sniedzēja maksas un nosacījumi.

Nosūtiet iegādes pieprasījumu ar aizsargpārbaudēm, izmantojot POST

Izmantojiet iespējotu API kontu, savienojoties ar HTTPS no atļautas avota IP adreses. Tālāk redzamā komanda veic iegādi, nevis sagatavo cenas piedāvājumu vai izmēģinājuma izpildi. Iestatiet visus mainīgos no vienas un tās pašas tikko veiktās numura un cenas izvēles. Ierobežojumu laukos saglabāts mantotais restore_quote_ prefikss; pašreizējais portāls tos izmanto arī konkrētu numuru iegādei ar aizsargpārbaudēm.

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"

Izmantojiet veidlapas datu POST pieprasījumu, kā parādīts piemērā. Palīgmodulis nodrošina arī JSON un opciju ietvara parsēšanu, taču šajā pārskatā nav apstiprināta pilnīga līdzvērtība visos cenas piedāvājumu un pakalpojumu sniedzēju apstrādes ceļos. Neizmantojiet GET iegādei, lai gan šim mantotajam koordinatoram nav tiešas metodes aizsargpārbaudes.

Iegādes ceļa un cenas piedāvājuma lauki
LauksNozīme
NUMBER_IDMeklēšanā izvēlētā numura UUID vai pilns saglabātais numurs. Katrā pieprasījumā viens numurs.
PRICE_IDCenas UUID, kas saistīts ar izvēlēto numuru un jūsu kontu. Vienmēr norādiet to tieši.
restore_quote_price_idJāsakrīt ar noteikto cenas ID. Norādot šo lauku, tiek iespējotas cenas piedāvājuma pārbaudes; tā nav idempotences atslēga.
restore_quote_setupMaksimālā pieņemamā pieslēgšanas maksa, norādīta kā galīga, nenegatīva skaitliska vērtība.
restore_quote_monthlyMaksimālā pieņemamā mēneša maksa, norādīta kā galīga, nenegatīva skaitliska vērtība.
restore_quote_per_minuteMaksimālais pieņemamais ienākošo zvanu minūtes tarifs, norādīts kā galīga, nenegatīva skaitliska vērtība.
restore_quote_channelsPrecīzs izvēlētās cenas opcijas kanālu skaits veselā skaitlī, nevis pieprasījums pēc cita kanālu plāna.

Ikreiz, kad norādāt cenas piedāvājuma cenas ID, norādiet arī visus skaitliskos cenas piedāvājuma laukus. Mainīts ID, cena virs ierobežojuma, trūkstošs vai nederīgs ierobežojums, mainīts kanālu skaits vai aizņemta cenas piedāvājuma slēdzene izraisa API koda 409 atgriešanu, pirms pieprasījums tiek nosūtīts izvēlētajam nomas pakalpojumu sniedzējam. Salīdzinājumos ir pieļaujama neliela peldošā komata precizitātes novirze; izmantojiet faktiskās attēlotās plāna vērtības, nevis manuāli noapaļotu cenu.

Aizsargpārbaudes nepārvērš visu darbplūsmu par izmēģinājuma izpildi vai transakciju. Reģistrācijas datu meklēšana, identitātes izveide vai citas palīgmoduļa darbības var notikt pirms šīm pārbaudēm. Tās arī nefiksē ārējo numuru pieejamību un neaizstāj konta līmeņa iegādes ierobežojumus.

Reģistrācija un aktivizācija

Ja nepieciešams, pievienojiet RegistrationID veidlapas lauku ar klientam piederošā reģistrācijas profila UUID. Tas nav augšupielādēta apliecinājuma, piegādātāja adreses vai atsevišķas identitātes entītijas ID. Palīgmodulis atrod profilu autentificētā konta ietvaros un noraida trūkstošus vai nepieejamus profilus.

Daļu atbalstīto numuru var iegādāties pirms reģistrācijas pabeigšanas; citiem numuriem profils nepieciešams jau pirms iegādes. Joprojām var būt vajadzīga konkrētā operatora validācija vai pakalpojuma nodrošināšana. Neuzskatiet veiksmīgu iegādi vai neveiktu sākotnējo pārbaudi par atbrīvojumu no reģistrācijas vai tūlītēju aktivizāciju.

Ja atbildē ir ietverts registration_requirements lauks, tas identificē strukturēto prasību meklējumu ar valsti un numura veidu. Izmantojiet reģistrācijas katalogu un apliecinājumu iesniegšanas darbplūsmu, lai izpildītu piemērojamās prasības. Atgrieztais teksts un metadati paši par sevi neapstiprina profilu.

Izvairieties no plāna aizstāšanas bez brīdinājuma

Mantotais koordinators var noteikt nenorādītu cenu no kešatmiņā saglabātiem numura datiem. Ja tieši norādītais cenas ID vairs nepastāv, tas var arī izmantot jaunāko konta cenu kešatmiņā saglabātajam prefiksam un atjaunināt kešatmiņā saglabāto atļautās cenas izvēli. Nepaļaujieties uz šiem rezerves variantiem, lai izvēlētos klienta apstiprināto plānu.

Tieši norādiet izvēlēto cenu un atbilstošos cenas piedāvājuma aizsargpārbaudes laukus. Cenas piedāvājuma ID aizsargpārbaude noraida pāreju uz citu ID, pirms tiek nosūtīts nomas pieprasījums. Pēc novecojušas cenas konflikta atkārtojiet meklēšanu un saņemiet apstiprinājumu jaunai izvēlei, nevis noņemiet aizsargpārbaudes, lai piespiedu kārtā veiktu iegādi.

Nav garantēta rezervācijas perioda vai visos apstrādes ceļos vienoti piemērota kešatmiņas derīguma termiņa. Darbplūsmā atkārtoti pārbauda numura pieejamību, konta cenu ierobežojumus un iegādes noteikumus, taču pilnīga katram pakalpojumu sniedzējam specifiskās darbības pārskatīšana vēl turpinās.

Papildu iestatījumi: konta maršrutēšanas noklusējuma vērtības

Iegādājoties numuru, var tikt pārmantoti konta esošie balss zvanu galamērķi, rezerves galamērķi, SMS galamērķis un ienākošo zvanu savienojuma maģistrāles preference. Pirms pasūtīšanas pārskatiet šīs noklusējuma vērtības; maršrutēšanas opciju nenorādīšana negarantē, ka numurs būs nekonfigurēts. Pārskatītais palīgmodulis pēc noklusējuma iespējo automātisko atjaunošanu.

Kopīgā palīgmoduļa atpazītās maršrutēšanas opcijas
OpcijaVērtības noteikšanas darbība
uri, uri2, uri3Nenorādītas vērtības pārmanto atbilstošās konta noklusējuma vērtības. Tieši norādītas tukšas vērtības notīra vērtību palīgmodulī, nevis pārmanto to. Izmantojiet derīgus galamērķus, kas atbilst izvēlētajam maršrutēšanas režīmam.
smsuriNenorādīta vērtība pārmanto konta SMS galamērķi; tieši norādīta tukša vērtība to notīra palīgmodulī.
origintrunkAtpazītam, tieši norādītam maģistrāles ID ir prioritāte. Ja vērtību neizdodas noteikt, kļūdas atgriešanas vietā var tikt izmantota konta preference vai mantotā noklusējuma vērtība.
forward_destination, forwarding_destination, typeNetukši maršrutēšanas režīma aizstājējvārdi norādītajā prioritātes secībā. Izmantojiet atbalstītas vērtības no konta maršrutēšanas konfigurācijas, nevis minētu režīma skaitlisko vērtību.
RegistrationIDReģistrācijas profila meklēšana attiecīgā klienta ietvaros; tā ir nodalīta no maršrutēšanas galamērķiem.
autorenewNoklusējuma vērtība ir 1. Palīgmodulis pārbauda, vai vērtība nav tukša, tāpēc 0 šajā iegādes laukā neļauj droši atspējot atjaunošanu. Izmantojiet atbalstīto konta atjaunošanas pārvaldību un pārbaudiet saglabāto iestatījumu.

Šāda ir kopīgā palīgmoduļa darbības semantika, nevis garantija, ka katrs piegādātājs vienādi saglabā katru neobligāto iestatījumu. Pastāv arī citi mantotie balss zvanu, balss pasta, faksa un SMS lauki, taču tiem joprojām nepieciešama pilnīga katram pakalpojumu sniedzējam specifiska pārskatīšana. Pirms paļaujaties uz zvaniem vai ziņojumiem, konta darbplūsmā pārbaudiet iegādātā numura saglabāto konfigurāciju.

Atbilde

Izdomāts vienkāršas iegādes piemērs; vērtības un iespējas atšķiras atkarībā no izvēlētā plāna.

{
  "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
  }
}

Koordinators izmanto savu status.code/status.msg un response atbildes ietvaru, negarantējot status.results lauka esamību. Kļūdas gadījumā atbildes saraksts parasti ir tukšs. Veiksmes gadījumā pārbaudiet atgriezto numuru un cenu, pēc tam salīdziniet konta numuru uzskaiti un reģistrācijas stāvokli ar faktisko situāciju. Pakalpojumu sniedzēja apstiprinājums nav reāls balss zvanu, SMS vai faksa tests.

Kļūdas un neskaidri rezultāti

Galvenie koordinatora rezultātu kodi
API kodsNozīme
403Konta cenu vai iegādes ierobežojumi, nepieejama cenas izvēle vai nepieejams reģistrācijas profils var bloķēt apstrādi.
404Trūkstoša vai nepieejama numura, cenas vai prefiksa izvēle.
409Numurs jau ir aktīvs, cenas piedāvājuma aizsargpārbaudes vērtība vairs neatbilst vai slēdzeni tur cita aizsargāta darbība.
422Reģistrācijas informācija ir nepieciešama, ir nepilnīga vai to nevar nodrošināt pārskatītajos reģistrācijas apstrādes ceļos.
500 un citi pakalpojumu sniedzēja vai konta kodiPakalpojumu sniedzēja, lokālās apstrādes vai noteikumu piemērošanas kļūme. Šie kodi nav universāls pierādījums tam, ka iegāde nav notikusi vai maksa nav iekasēta.

Izlasiet faktisko API atbildes saturu un HTTP statusu. Ārējs pakalpojumu sniedzējs var pieņemt nomas pasūtījumu, pirms rodas kļūme lokālajā paziņošanā, reģistrācijā vai citā apstrādē. Dažos lokālās numuru uzskaites piešķiršanas procesos tiek izmantotas datubāzes transakcijas, taču ārējo pakalpojumu sniedzēju pasūtījumiem nav universālas atrites. Šis koordinators nenodrošina klienta idempotences atslēgu.

Pirms atkārtota mēģinājuma noskaidrojiet faktisko stāvokli

  1. Pirms pieprasījuma vienreizējas iesniegšanas saglabājiet apstiprināto numuru, cenu un cenas piedāvājuma ierobežojumus savas lietotnes pasūtījuma ierakstā.
  2. Pēc pieprasījuma, arī pēc noildzes vai kļūdas, nolasiet tā paša konta iegādāto numuru sarakstu un numura informāciju.
  3. Ja numurs pastāv, pārbaudiet tā cenu, atjaunošanas iestatījumus, maršrutēšanu un reģistrācijas stāvokli, nevis iesniedziet vēl vienu iegādes pieprasījumu.
  4. Ja rezultāts joprojām ir neskaidrs, pirms atkārtota mēģinājuma lūdziet atbalsta dienestam pārbaudīt pakalpojumu sniedzēja pasūtījuma un konta norēķinu faktisko stāvokli un savstarpējo atbilstību. Kļūdas ziņojums vai mantotā žurnāla veiksmes atzīme vien nav pietiekams pierādījums.
  5. Pēc īpašumtiesību un aktivizācijas apstiprināšanas veiciet konta parastās maršrutēšanas pārbaudes un pakalpojumu testus.