REST API dokumentacija
Telefono numerių REST API
Raskite galimas šalis ir numerius, peržiūrėkite visą pasiūlymą ir valdykite jums priklausančius numerius.
Kartu pasirinkite API ir prisijungimo duomenis
Patvirtintos kūrėjų ir automatizavimo, verslo bei ryšių paslaugų teikėjų paskyros gali integruoti įjungtas paslaugas. Individualiam kūrėjui nereikia apsimesti įmone. Programų SMS/MMS siuntimui reikia atitinkamo siuntimo patvirtinimo ir registracijos. Asmeninių ir šeimos poreikių paslauga neturi klientui prieinamos žinučių siuntimo inicijavimo API.
| API šeima | Bazinis URL | Autentifikavimas ir rezultatas |
|---|---|---|
| Ryšių v3 | https://api.multitel.net/v3 | Patvirtinti Basic prisijungimo duomenys; tinkami suteikti prieigos raktai naudojami tik juos palaikančioms operacijoms. JSON status ir response. |
| Registracija skambinimui pagalbos tarnyboms | https://api.multi.tel/emergency | Patvirtinti Basic prisijungimo duomenys arba specialiai suteikta bearer prieiga. JSON code, message ir data. |
| Portalo REST integracijos | Serveris ir operacija nurodyti jūsų paskyros kūrėjų žinyne | Naudokite tos operacijos dokumentacijoje nurodytus prisijungimo duomenis, prieigos apimtis ir schemą. Naršyklės sesijos užklausos yra atskiras prieigos būdas. |
Prieš naudodami pavyzdžius, nustatykite MULTITEL_API_USERNAME ir MULTITEL_API_PASSWORD serverio paslapčių konfigūracijoje. Niekada jų neįtraukite į viešą naršyklės JavaScript kodą, URL adresus ar versijų valdymo sistemą. Specialūs prisijungimo duomenys valdomi skiltyje API integravimo nustatymai.
Perskaitykite prieinamų šalių katalogą
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getcountries"v3 atsakyme yra status ir response masyvas. Šalių įrašuose pateikiami isocode, name, countrycode, informacija apie galimybes ir next_function. Prieinamumas priklauso nuo paskyros ir numerių pasiūlos; įtraukta šalis negarantuoja, kad yra visų prefiksų ar tipų numerių.
{
"status": {
"code": 200,
"msg": "Results: 1"
},
"response": [
{
"countrycode": "1",
"name": "United States",
"description": "United States",
"isocode": "US",
"is_mobile": 0,
"sms_coverage": 1,
"latitude": "37.0902",
"longitude": "-95.7129",
"next_function": "v3/getareas/US"
}
]
}Nuo paieškos iki aktyvavimo
- Naudodami atitinkamas geografines operacijas, pasirinkite šalį, administracinį vienetą, jei reikalingas, vietovę ir numerio tipą.
- Perskaitykite pasirinkto numerio įjungimo, mėnesio ir naudojimo kainas, kanalų skaičių, įtrauktą naudojimo kiekį ir registracijos reikalavimus.
- Pateikite reikalaujamus galutinio naudotojo dokumentus ir peržiūrėkite jų būseną. Numeris gali likti laukimo būsenoje iki patvirtinimo.
- Pateikite vieną užsakymą su tiksliai pasirinktu numeriu iš pasiūlos ir kaina. Jei atsakymas neaiškus, prieš pateikdami kitą užsakymą, patikrinkite turimų numerių sąrašą.
- Atskirai sukonfigūruokite skambučių maršrutizavimą ir žinučių pristatymą, tada patikrinkite visą numatytą maršrutą.
Klaidų tvarkymas ir pakartotiniai bandymai
- Autentifikavimo arba leidimų klaida
- Patikrinkite, ar API prisijungimo duomenys aktyvūs, kokia paslauga leidžiama ir koks taikomas šaltinio IP apribojimas. Portalo sesijos slapukas nėra integracijai skirti prisijungimo duomenys.
- Nepakankamas likutis arba trūkstamas patvirtinimas
- Prieš kartodami operaciją, išspręskite paskyros likučio, siuntimo patvirtinimo ar reikalaujamo dokumento klausimą.
- Rezultato nėra
- Tuščią numerių pasiūlą arba nerastą skambintojo vardą laikykite įprastu rezultatu. Nemanykite, kad taisyklingo formato numeriui prieinamos visos paslaugos.
- Tinklo laukimo laikas baigėsi arba paslauga sutriko
- Skaitymo užklausoms taikykite ribotą pakartojimų skaičių su didinamais laukimo tarpais. Pirkdami, siųsdami ar registruodami pirmiausia patikrinkite operacijos būseną; pakartojus jau priimtą užklausą, apmokestinamas veiksmas gali būti atliktas dar kartą.
Idempotentiškumo palaikymas priklauso nuo API šeimos. Pagalbos tarnybų API palaiko pakartojimo raktus; tai nereiškia, kad bet kokia v3 užklausa yra idempotentiška. Pagalbai išsaugokite laiko žymas, grąžintus identifikatorius ir atsakymus su pašalintais neskelbtinais duomenimis.
Tęskite savo paskyros žinyne
Prisijungus rodomas žinynas filtruoja operacijas pagal jūsų teises ir įjungtas paslaugas. Naudokite jame nurodytą tikslų pagrindinį kompiuterį (host), prisijungimo duomenų tipą, užklausos laukus ir atsakymo schemą. Konsolėse galima vykdyti realias operacijas, įskaitant pirkimus ir žinučių siuntimą.