Help Center Messagio API kompatibilnost

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:

ParametarVrstaObaveznoOpis
korisnikstringDaVaš SMSBAT nalog za prijavu ili identifikator korisnika.
znakstringDaAPI tajna ili potpis registrovan za ime pošiljaoca.
odstringDaRegistrirano alfa ime pošiljaoca.
metod_slanjastringDaVrsta kanala. Koristite viber za obične Viber Business poruke ili viber_otp za Viber OTP šablone.
telefonstringDaTelefonski 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:

ParametarVrstaObaveznoOpis
txtstringDaTekst poruke.

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=Hello+from+SMSBAT%21

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:

ParametarVrstaObaveznoOpis
txtstringDaTekst naslova vrtuljka.
vrtuljak[N].naslovstringDaNaslov kartice N (počevši od 0).
carousel[N].image_urlstringDaURL javne HTTPS slike kartice N.
vrtuljak[N].primary_labelstringDaNaslov glavnog dugmeta kartice N.
vrtuljak[N].primary_urlstringDaURL linka glavnog dugmeta kartice N.
vrtuljak[N].sekundarna_oznakastringNeNaslov sekundarnog dugmeta kartice N.
vrtuljak[N].sekundarni_urlstringNeURL 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

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.

<response>
  <code>-1</code>
  <tech_message>PARAM ERROR (sign)</tech_message>
</response>

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:
    msg_id=MESSAGE_GUID&status=delivered
    
  • Viđeno/pročitano:
    msg_id=MESSAGE_GUID&status=delivered&type=seen
    
  • Neisporučeno / Neuspješno:
    msg_id=MESSAGE_GUID&status=undelivered&status_extended=REASON
    

Opis polja:

  • msg_id: SMSBAT jedinstveni ID poruke (GUID) vraćen u odgovoru SendMessage.
  • status: ishod isporuke (isporučeno, neisporučeno ili nepoznat status).
  • tip: Postavite na viđen kada 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:

msg_id=ORIGINAL_SURVEY_MESSAGE_GUID&text=SELECTED_OPTION_TEXT

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 biti null ako je poslao samo medije).
  • mediji: Direktni URL za preuzimanje bilo kojeg medijskog priloga koji je poslao korisnik (može biti null ako je samo tekst).
  • telefon: telefonski broj pošiljaoca u međunarodnom formatu.
  • sender_bm_id: Viber Business ID pošiljaoca.