Dokumentacija REST API-ja
Pošaljite svoj prvi MultiTEL API zahtjev
Počnite zahtjevom samo za čitanje, razumite odgovor, a zatim odaberite referencu za uslugu koju želite izgraditi.
Odaberite API i vjerodajnicu zajedno
Odobreni računi s profilima „Razvojni programeri i automatizacija”, „Poslovni” i „Pružatelji komunikacijskih usluga” mogu integrirati omogućene usluge. Pojedinačni programer ne mora se predstavljati kao tvrtka. SMS/MMS iz aplikacija zahtijeva odgovarajuće odobrenje za slanje i registraciju. Usluga „Pojedinci i obitelji” nema korisnicima dostupan API za slanje poruka.
| Obitelj API-ja | Osnovni URL | Autentifikacija i rezultat |
|---|---|---|
| Komunikacije v3 | https://api.multitel.net/v3 | Odobrene Basic vjerodajnice; prikladni dodijeljeni tokeni samo za operacije koje ih podržavaju. JSON status i response. |
| Registracija za hitne pozive | https://api.multi.tel/emergency | Odobrene Basic vjerodajnice ili posebno dodijeljen bearer pristup. JSON code, message i data. |
| REST integracije portala | Host i operacija prikazani u referenci za programere vašeg računa | Koristite dokumentiranu vjerodajnicu, opsege ovlasti i shemu te operacije. Zahtjevi iz sesije preglednika koriste zasebno sučelje. |
Prije korištenja primjera postavite MULTITEL_API_USERNAME i MULTITEL_API_PASSWORD putem konfiguracije tajni na vašem poslužitelju. Nikada ih ne ugrađujte u javni JavaScript preglednika, URL-ove ni upravljanje izvornim kodom. Namjenskim vjerodajnicama upravlja se u postavkama API integracije.
Prvi zahtjev: očitajte svoje stanje
Ovo čitanje ne kupuje uslugu niti pokreće poziv ili poruku.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getbalance"API za komunikacije v3 vraća rezultat aplikacije unutar JSON tijela. Prije čitanja response provjerite HTTP status i status.code; odbijeni zahtjev možda nema objekt odgovora. Vrijednosti koda mogu biti nizovi znakova ili brojevi.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "25.0000",
"currency": "USD",
"terms": "Prepaid"
}
}Ovo je izmišljeni primjer, a ne stvarno stanje računa. Novčane vrijednosti tretirajte kao decimalne iznose. Pri dijagnosticiranju odbijenog zahtjeva sačuvajte poruku odgovora poslužitelja, uz uklonjene vjerodajnice.
Ispravno koristite podatke o naplati
Odgovor o stanju sadrži trenutno stanje, valutu i uvjete plaćanja. Ne daje cijenu budućeg poziva niti potpuni račun. Za ta pitanja koristite odgovarajuće operacije za cijene i potrošnju. Postojeći brojevi mogu imati drukčije planove od današnjeg kataloga.
Odaberite svoju sljedeću integraciju
REST API za LRN upit usmjeravanja
Saznajte broj usmjeravanja i dostupne podatke o operateru za sjevernoamerički telefonski broj po fiksnoj cijeni.
Pročitajte vodič za integraciju →REST API-ji za telefonske brojeve
Pronađite dostupne zemlje i brojeve, pregledajte cjelovitu ponudu i upravljajte brojevima koje posjedujete.
Pročitajte vodič za integraciju →REST API-ji za SMS i MMS
Šaljite odobrene poruke aplikacije te obrađujte prihvaćanje, događaje isporuke, segmentaciju i naknade.
Pročitajte vodič za integraciju →REST API-ji za hitne pozive
Registrirajte broj i adresu usluge, pratite status aktivacije i održavajte zapis ažurnim kada se lokacija promijeni.
Pročitajte vodič za integraciju →REST API-ji za račun i naplatu
Očitajte stanje i podatke o naplati dostupne vašoj odobrenoj integraciji.
Pročitajte vodič za integraciju →CNAM upiti i upiti usmjeravanja
Očitajte imena pozivatelja, upoznajte razine upita i koristite informacije o usmjeravanju brojeva.
CNAM REST referenca →Hosted PBX
Počnite s dostupnim uslužnim planovima i tenantom koji namjeravate konfigurirati.
API uslužnih planova za Hosted PBX →Postupanje s pogreškama i ponovnim pokušajima
- Neuspjela autentifikacija ili dozvola
- Provjerite je li API vjerodajnica omogućena, koja je usluga dopuštena i koja ograničenja vrijede za izvornu IP adresu. Kolačić sesije portala nije vjerodajnica za integraciju.
- Nedovoljno sredstava ili neispunjeno odobrenje
- Riješite stanje računa, odobrenje za slanje ili zahtjev za dokumentom prije ponavljanja operacije.
- Nema rezultata
- Prazan inventar ili nedostajuće ime pozivatelja tretirajte kao uobičajen ishod. Ne pretpostavljajte da sintaktički ispravan broj ima sve usluge.
- Istek vremena čekanja na mreži ili kvar usluge
- Za čitanja koristite ograničen broj ponovnih pokušaja s odgodom (backoff). Za kupnju, slanje ili registraciju najprije provjerite stanje operacije; ponavljanje prihvaćenog zahtjeva može udvostručiti naplativu radnju.
Podrška za idempotentnost ovisi o pojedinoj obitelji API-ja. Emergency API podržava ključeve za ponovne pokušaje; to ne čini proizvoljne v3 zahtjeve idempotentnima. Za podršku sačuvajte vremenske oznake, vraćene ID-ove i odgovore iz kojih su uklonjeni osjetljivi podaci.
Nastavite s referencom za svoj račun
Referenca u koju ste prijavljeni filtrira operacije prema vašim dozvolama i omogućenim uslugama. Koristite njezin točan host, vrstu vjerodajnica, polja zahtjeva i shemu odgovora. Konzole mogu izvršavati operacije uživo, uključujući kupnje i poruke.