Messagio API kompatibilnost
SMSBAT podržava sloj kompatibilnosti sa Messagio API. Ovo vam omogućava da migrirate postojeće Viber integracije dizajnirane za Messagio direktno u SMSBAT bez potrebe da prepisujete svoju strukturu korisnog opterećenja ili mijenjate logiku integracije.
Postavke veze
Za usmjeravanje zahtjeva putem SMSBAT-a, ažurirajte osnovni URL i vjerodajnice za autentifikaciju u svojoj integraciji:
- Osnovni URL:
https://restapi.smsbat.com - Krajnja točka:
POST /api/SendMessage - Format zahtjeva:
application/x-www-form-urlencoded(Podaci obrasca)
Autentifikacija i vjerodajnice
Zahtjevi se provjeravaju korištenjem parametara koji se šalju direktno unutar podataka obrasca tijela zahtjeva:
| Parametar | Vrsta | Obavezno | Opis |
|---|---|---|---|
korisnik |
string | Da | Vaš SMSBAT nalog za prijavu ili identifikator korisnika. |
znak |
string | Da | API tajna ili potpis registrovan za ime pošiljaoca. |
od |
string | Da | Registrirano alfa ime pošiljaoca. |
metod_slanja |
string | Da | Vrsta kanala. Koristite viber za obične Viber Business poruke ili viber_otp za Viber OTP šablone. |
telefon |
string | Da | Telefonski broj primaoca u međunarodnom formatu (npr. 380501234567). |
Vrste Viber poruka
Odaberite karticu ispod da vidite specifične parametre i zatražite korisno opterećenje za različite strukture Viber poruka:
Šalje jednostavnu tekstualnu poruku.
Dodatni parametri:
| Parametar | Vrsta | Obavezno | Opis |
|---|---|---|---|
txt |
string | Da | Tekst poruke. |
Zatražite primjer tereta:
Šalje tekstualnu poruku sa interaktivnim dugmetom poziva na akciju.
Dodatni parametri:
| Parametar | Vrsta | Obavezno | Opis |
|---|---|---|---|
txt |
string | Da | Tekst poruke. |
button_text |
string | Da | Tekst prikazan na dugmetu. |
button_link |
string | Da | Odredišni URL kada se klikne na dugme. |
Zatražite primjer tereta:
Šalje javnu datoteku slike.
Dodatni parametri:
| Parametar | Vrsta | Obavezno | Opis |
|---|---|---|---|
link_slike |
string | Da | Javni HTTPS URL slike. |
txt |
string | Ne | Opcioni tekst natpisa za prikaz ispod slike. |
Zatražite primjer tereta:
Šalje obogaćenu karticu koja sadrži tekst, sliku i dugme.
Dodatni parametri:
| Parametar | Vrsta | Obavezno | Opis |
|---|---|---|---|
txt |
string | Da | Tekst natpisa. |
link_slike |
string | Da | Javni HTTPS URL slike. |
button_text |
string | Da | Tekst prikazan na dugmetu. |
button_link |
string | Da | Odredišni URL kada se klikne na dugme. |
Zatražite primjer tereta:
POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded
sending_method=viber&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&txt=Hot+deals+inside%21&image_link=https%3A%2F%2Fwww.example.com%2Fimage.png&button_text=Open&button_link=https%3A%2F%2Fwww.example.com
Šalje video datoteku s opcijskim tekstualnim naslovom i dugmadima za radnju.
Dodatni parametri:
| Parametar | Vrsta | Obavezno | Opis |
|---|---|---|---|
video.url |
string | Da | Javni HTTPS URL video datoteke. |
video.thumbnail |
string | Da | Javni HTTPS URL slike za pregled videa. |
video.size_mb |
cijeli broj | Da | Približna veličina video datoteke u megabajtima. |
video.duration_sec |
cijeli broj | Da | Trajanje videa u sekundama. |
txt |
string | Ne | Opcijski tekst opisa. |
button_text |
string | Ne | Opcioni tekst dugmeta (može služiti kao naslov ili link). |
button_link |
string | Ne | URL linka opcionog dugmeta. |
Zatražite primjer tereta:
POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded
sending_method=viber&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&txt=Watch+this+tutorial%21&video.url=https%3A%2F%2Fwww.example.com%2Fvideo.mp4&video.thumbnail=https%3A%2F%2Fwww.example.com%2Fvideo-thumbnail.png&video.size_mb=1&video.duration_sec=3&button_text=Open&button_link=https%3A%2F%2Fwww.example.com
Šalje Viber jednokratne lozinke (OTP) koristeći unaprijed odobreni šablon.
Napomena
Kada šaljete OTP poruke, morate postaviti sending_method na viber_otp.
Dodatni parametri:
| Parametar | Vrsta | Obavezno | Opis |
| :--- | :--- | :--- | :--- |
| `template.id` | string | **Da** | Unaprijed odobreni Viber OTP šablon ID. |
| `template.lang` | string | **Da** | Kod jezika šablona (npr. `en`, `uk`). |
| `template.params.pin` | string | **Da** | OTP pin vrijednost za ubacivanje u šablon. |
| `template.params.business_platform_name` | string | **Da** | Rezervoar naziva preduzeća u predlošku. |
| `template.params.code_validity_time` | string | **Da** | Period važenja PIN-a u minutama. |
**Zatražite primjer tereta:**
```http
POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded
sending_method=viber_otp&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&template.id=otp_template_123&template.lang=en&template.params.pin=123456&template.params.business_platform_name=SMSBAT&template.params.code_validity_time=7
```
Šalje interaktivnu karticu sa porukom koja sadrži više slajdova (kartica) kroz koje korisnik može prevlačiti.
Dodatni parametri:
| Parametar | Vrsta | Obavezno | Opis |
|---|---|---|---|
txt |
string | Da | Tekst naslova vrtuljka. |
vrtuljak[N].naslov |
string | Da | Naslov kartice N (počevši od 0). |
carousel[N].image_url |
string | Da | URL javne HTTPS slike kartice N. |
vrtuljak[N].primary_label |
string | Da | Naslov glavnog dugmeta kartice N. |
vrtuljak[N].primary_url |
string | Da | URL linka glavnog dugmeta kartice N. |
vrtuljak[N].sekundarna_oznaka |
string | Ne | Naslov sekundarnog dugmeta kartice N. |
vrtuljak[N].sekundarni_url |
string | Ne | URL veze sekundarnog dugmeta kartice N. |
Zatražite primjer tereta:
POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded
sending_method=viber&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&txt=Top+picks+for+you&carousel%5B0%5D.title=First+Offer&carousel%5B0%5D.image_url=https%3A%2F%2Fwww.example.com%2Fitem-1.png&carousel%5B0%5D.primary_label=Open&carousel%5B0%5D.primary_url=https%3A%2F%2Fwww.example.com%2Fitem-1&carousel%5B0%5D.secondary_label=Details&carousel%5B0%5D.secondary_url=https%3A%2F%2Fwww.example.com%2Fitem-1%2Fdetails&carousel%5B1%5D.title=Second+Offer&carousel%5B1%5D.image_url=https%3A%2F%2Fwww.example.com%2Fitem-2.png&carousel%5B1%5D.primary_label=Open&carousel%5B1%5D.primary_url=https%3A%2F%2Fwww.example.com%2Fitem-2
Šalje poruku koja sadrži interaktivnu anketu ili anketno pitanje.
Dodatni parametri:
| Parametar | Vrsta | Obavezno | Opis |
|---|---|---|---|
txt |
string | Da | Tekst anketnog pitanja. |
opcije_ankete[N] |
string | Da | Tekst opcije ankete za stavku N (indeks počinje od 0). Potrebne su najmanje 2 opcije. |
tip_opcije |
cijeli broj | Da | Tip selektora: 1 (radio dugmad) ili 2 (obična dugmad). |
Zatražite primjer tereta:
POST /api/SendMessage HTTP/1.1
Host: restapi.smsbat.com
Content-Type: application/x-www-form-urlencoded
sending_method=viber&from=MySender&user=myuser&phone=380501234567&sign=api_secret_signature&txt=Please+rate+our+service&survey_options%5B0%5D=Excellent&survey_options%5B1%5D=Good&survey_options%5B2%5D=Average&option_type=1
Format odgovora
Krajnja tačka kompatibilnosti Messagio API-ja vraća odgovore u XML formatu sa statusnim kodom HTTP 200 OK.
Prihvaćen (uspješan) odgovor
<response>
<code>0</code>
<tech_message>OK</tech_message>
<msg_id phone="380501234567">MESSAGE_GUID</msg_id>
</response>
Odgovori na greške
Ako provjera valjanosti parametara zahtjeva ne uspije ili provjera autentičnosti ne uspije, odgovor će vratiti kod koji nije nula.
Povratni pozivi
URL-ovi povratnog poziva moraju biti implementirani i hostirani na vašoj platformi. SMSBAT šalje HTTP povratne pozive da ažurira vaš sistem u vezi sa događajima isporuke, odgovorima na ankete i odgovorima korisnika.
1. Povratni poziv statusa isporuke
Šalje se kada poruka prođe status (isporučena, pročitana, neuspješna).
- Tip sadržaja:
application/x-www-form-urlencoded - Metoda:
POST
Zahtjev za formate tereta:
- Isporučeno:
- Viđeno/pročitano:
- Neisporučeno / Neuspješno:
Opis polja:
msg_id: SMSBAT jedinstveni ID poruke (GUID) vraćen u odgovoru SendMessage.status: ishod isporuke (isporučeno,neisporučenoilinepoznat status).tip: Postavite naviđenkada je primalac pregledao poruku.status_extended: Specifičan tehnički razlog neisporučenog statusa (npr.VIBER_EXPIRED,VIBER_BLOCKED_BY_USER,VIBER_USER_NOT_FOUND,VIBER_NO_DEVICE).
2. Anketa Odgovori Povratni poziv
Pokreće se kada korisnik odabere opciju odgovora u poruci Viber ankete.
- Tip sadržaja:
application/x-www-form-urlencoded - Metoda:
POST
Format zahtjeva za teret:
3. Povratni poziv dolazne korisničke poruke
Pokreće se kada korisnik pošalje tekstualni ili medijski odgovor nazad na vašu Viber Business uslugu.
- Tip sadržaja:
application/json - Metoda:
POST
Format zahtjeva za teret:
{
"msg_id": "INBOUND_MESSAGE_GUID",
"text": "Hello, I have a question",
"media": "https://example.com/user-attachment.png",
"phone": "380501234567",
"sender_bm_id": "12345"
}
Opis polja:
msg_id: Jedinstveni ID poruke generiran za ulazni odgovor.tekst: Tekstualni sadržaj koji je poslao korisnik (može bitinullako je poslao samo medije).mediji: Direktni URL za preuzimanje bilo kojeg medijskog priloga koji je poslao korisnik (može bitinullako je samo tekst).telefon: telefonski broj pošiljaoca u međunarodnom formatu.sender_bm_id: Viber Business ID pošiljaoca.