Dokumentacija REST API-ja

REST API-ji za telefonske brojeve

Pronađite dostupne zemlje i brojeve, pregledajte cjelovitu ponudu i upravljajte brojevima koje posjedujete.

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-jaOsnovni URLAutentifikacija i rezultat
Komunikacije v3https://api.multitel.net/v3Odobrene Basic vjerodajnice; prikladni dodijeljeni tokeni samo za operacije koje ih podržavaju. JSON status i response.
Registracija za hitne pozivehttps://api.multi.tel/emergencyOdobrene Basic vjerodajnice ili posebno dodijeljen bearer pristup. JSON code, message i data.
REST integracije portalaHost i operacija prikazani u referenci za programere vašeg računaKoristite 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.

Čitanje kataloga dostupnih država

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multitel.net/v3/getcountries"

v3 odgovor sadrži status i polje response. Unosi država uključuju isocode, name, countrycode, informacije o mogućnostima i next_function. Dostupnost ovisi o računu i zalihama; država nije obećanje da je svaki prefiks ili vrsta broja na zalihi.

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

Od pretraživanja do aktivacije

  1. Odaberite državu, po potrebi podjedinicu, područje i vrstu broja pomoću odgovarajućih geografskih operacija.
  2. Pročitajte cijene postavljanja, mjesečne cijene i cijene korištenja odabranog broja, kanale, uključene količine i zahtjeve za registraciju.
  3. Pošaljite potrebne dokumente krajnjeg korisnika i pratite njihov status. Broj može ostati na čekanju do odobrenja.
  4. Naručite jednom s točnim odabirom zaliha i cijene. Ako je odgovor nejasan, provjerite svoje zalihe prije slanja nove narudžbe.
  5. Zasebno konfigurirajte glasovno usmjeravanje i isporuku poruka, a zatim testirajte cijelu predviđenu rutu.

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.