Kihagyás

Messagio API-kompatibilitás

Az SMSBAT kompatibilitási réteget támogat a Messagio API-val. Ez lehetővé teszi, hogy a Messagio számára tervezett Viber-integrációit közvetlenül az SMSBAT-ba migrálja anélkül, hogy át kellene írnia a rakományszerkezetet vagy módosítania kellene az integrációs logikát.

Csatlakozási beállítások

A kérések SMSBAT-on keresztüli irányításához frissítse az alap URL-t és a hitelesítési adatokat az integrációban:

  • Alap URL: https://restapi.smsbat.com
  • Végpont: POST /api/SendMessage
  • Kérés formátuma: application/x-www-form-urlencoded (Űrlapadatok)

Hitelesítés és hitelesítő adatok

A kérelmek hitelesítése közvetlenül a kérelem törzsadataiban küldött paraméterekkel történik:

Paraméter Típus Kötelező Leírás
"felhasználó" húr Igen Az SMSBAT-fiók bejelentkezési neve vagy felhasználói azonosítója.
jel húr Igen A feladó nevéhez regisztrált API titkos vagy aláírás.
"tól" húr Igen Regisztrált feladó alfa név.
"küldési_módszer" húr Igen Csatorna típusa. Használja a "viber"-t a szokásos Viber Business üzenetekhez vagy a "viber_otp"-t a Viber OTP-sablonokhoz.
"telefon" húr Igen A címzett telefonszáma nemzetközi formátumban (pl. "380501234567").

Viber üzenettípusok

Válasszon egy lapot az alábbiak közül, ha meg szeretné tekinteni a konkrét paramétereket, és lekérheti a hasznos adatokat a különböző Viber üzenetstruktúrákhoz:

Egyszerű szöveges üzenetet küld.

További paraméterek:

Paraméter Típus Kötelező Leírás
"txt" húr Igen Üzenet szövege.

Példa a hasznos terhelés kérésére: 

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

Szöveges üzenetet küld egy interaktív cselekvésre ösztönző gombbal.

További paraméterek:

Paraméter Típus Kötelező Leírás
"txt" húr Igen Üzenet szövege.
gomb_szövege húr Igen A gombon megjelenő szöveg.
gomb_linkje húr Igen Cél URL, amikor a gombra kattintanak.

Példa a hasznos terhelés kérésére: 

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=Check+our+latest+offers%21&button_text=Open&button_link=https%3A%2F%2Fwww.example.com

Nyilvános képfájlt küld.

További paraméterek:

Paraméter Típus Kötelező Leírás
image_link húr Igen A kép nyilvános HTTPS URL-je.
"txt" húr Nem A kép alatt megjelenő opcionális feliratszöveg.

Példa a hasznos terhelés kérésére: 

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&image_link=https%3A%2F%2Fwww.example.com%2Fimage.png

Szöveget, képet és gombot tartalmazó bővített kártyát küld.

További paraméterek:

Paraméter Típus Kötelező Leírás
"txt" húr Igen Felirat szövege.
image_link húr Igen A kép nyilvános HTTPS URL-je.
gomb_szövege húr Igen A gombon megjelenő szöveg.
gomb_linkje húr Igen Cél URL, amikor a gombra kattintanak.

Példa a hasznos terhelés kérésére: 

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

Videofájlt küld opcionális szöveges felirattal és műveleti gombokkal.

További paraméterek:

Paraméter Típus Kötelező Leírás
video.url húr Igen A videofájl nyilvános HTTPS URL-je.
video.thumbnail húr Igen A videó előnézeti képének nyilvános HTTPS URL-je.
video.size_mb egész Igen Hozzávetőleges videofájl mérete megabájtban.
video.duration_sec egész Igen A videó időtartama másodpercben.
"txt" húr Nem Opcionális leírás szöveg.
gomb_szövege húr Nem Opcionális gombszöveg (feliratként vagy linkként működhet).
gomb_linkje húr Nem Opcionális gombhivatkozás URL-je.

Példa a hasznos terhelés kérésére: 

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

Viber egyszeri jelszavakat (OTP) küld egy előre jóváhagyott sablon használatával.

Megjegyzés

OTP-üzenetek küldésekor a sending_method-t viber_otp-re kell állítani.

További paraméterek:

| Paraméter | Típus | Kötelező | Leírás |
| :--- | :--- | :--- | :--- |
| `template.id` | húr | **Igen** | Előre jóváhagyott Viber OTP sablonazonosító. |
| `template.lang` | húr | **Igen** | Sablon nyelvi kódja (pl. "en", "uk"). |
| `template.params.pin` | húr | **Igen** | A sablonba beillesztendő OTP pin értéke. |
| `sablon.params.business_platform_name` | húr | **Igen** | A cégnév helyőrzője a sablonban. |
| `template.params.code_validity_time` | húr | **Igen** | A PIN-kód érvényességi ideje percben. |

**Példa a hasznos terhelés kérésére:**
```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
```

Több diát (kártyát) tartalmazó interaktív üzenetkártyát küld, amelyen a felhasználó lapozhat.

További paraméterek:

Paraméter Típus Kötelező Leírás
"txt" húr Igen A körhinta címszövege.
körhinta[N].cím húr Igen "N" kártya címe (0-tól kezdve).
körhinta[N].image_url húr Igen Az „N” kártya nyilvános HTTPS-képének URL-je.
körhinta[N].elsődleges_címke húr Igen Az „N” kártya fő gombjának felirata.
körhinta[N].elsődleges_url húr Igen Az „N” kártya fő gomb linkjének URL-je.
körhinta[N].másodlagos_címke húr Nem Az „N” kártya másodlagos gombfelirata.
körhinta[N].szekunder_url húr Nem Az „N” kártya másodlagos gomb linkjének URL-je.

Példa a hasznos terhelés kérésére: 

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

Interaktív szavazást vagy felmérési kérdést tartalmazó üzenetet küld.

További paraméterek:

Paraméter Típus Kötelező Leírás
"txt" húr Igen A felmérés kérdésének szövege.
felmérés_lehetőségei[N] húr Igen Felmérés opció szövege az "N" elemhez (0-tól kezdődő index). Legalább 2 lehetőség szükséges.
opció_típusa egész Igen A választó típusa: "1" (rádiógombok) vagy "2" (szokásos gombok).

Példa a hasznos terhelés kérésére: 

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

Válaszformátum

A Messagio API kompatibilitási végpontja XML formátumban ad vissza válaszokat "HTTP 200 OK" állapotkóddal.

Elfogadott (sikeres) válasz

<response>
  <code>0</code>
  <tech_message>OK</tech_message>
  <msg_id phone="380501234567">MESSAGE_GUID</msg_id>
</response>

Hibaválaszok

Ha a kérés paramétereinek érvényesítése sikertelen vagy a hitelesítés sikertelen, a válasz nullától eltérő kódot ad vissza.

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

<response>
  <code>-2</code>
  <tech_message>ERROR(unauthorized)</tech_message>
</response>

Visszahívások

A visszahívási URL-eket az Ön platformján kell megvalósítani és tárolni. Az SMSBAT HTTP-visszahívásokat küld, hogy frissítse a rendszert a kézbesítési eseményekkel, a felmérési válaszokkal és a felhasználói válaszokkal kapcsolatban.

1. Kézbesítési állapot visszahívás

Elküldve, amikor egy üzenet állapota átáll (kézbesítve, elolvasva, sikertelen).

  • Content-Type: application/x-www-form-urlencoded
  • Módszer: 'KÖZZÉTÉTEL'

Rakter formátumok kérése:

Kézbesítve: 

msg_id=MESSAGE_GUID&status=delivered
Látva/olvasva: 
msg_id=MESSAGE_GUID&status=delivered&type=seen
* Nem kézbesített / Sikertelen: 
msg_id=MESSAGE_GUID&status=undelivered&status_extended=REASON

Mezők leírása:

  • msg_id: SMSBAT egyedi üzenetazonosító (GUID) a SendMessage válaszban.
  • status: Kézbesítés eredménye (kézbesítve, nem kézbesített vagy állapot ismeretlen).
  • "type": Állítsa "látott" értékre, ha a címzett megtekintette az üzenetet.
  • "status_extended": A kézbesítetlen állapot konkrét műszaki oka (pl. "VIBER_EXPIRED", "VIBER_BLOCKED_BY_USER", "VIBER_USER_NOT_FOUND", "VIBER_NO_DEVICE").

2. Felmérés válasz Visszahívás

Akkor aktiválódik, amikor a felhasználó választ választ egy Viber Survey üzenetben.

  • Content-Type: application/x-www-form-urlencoded
  • Módszer: 'KÖZZÉTÉTEL'

Payload formátum kérése: 

msg_id=ORIGINAL_SURVEY_MESSAGE_GUID&text=SELECTED_OPTION_TEXT

3. Bejövő felhasználói üzenet visszahívása

Akkor aktiválódik, amikor egy felhasználó szöveges vagy médiaválaszt küld vissza a Viber Business szolgáltatásnak.

  • Content-Type: "alkalmazás/json".
  • Módszer: 'KÖZZÉTÉTEL'

Payload formátum kérése: 

{
  "msg_id": "INBOUND_MESSAGE_GUID",
  "text": "Hello, I have a question",
  "media": "https://example.com/user-attachment.png",
  "phone": "380501234567",
  "sender_bm_id": "12345"
}

Mezők leírása:

  • msg_id: A bejövő válaszhoz létrehozott egyedi üzenetazonosító.
  • "szöveg": a felhasználó által küldött szöveges tartalom (lehet "null", ha csak médiát küldött).
  • "média": Közvetlen URL a felhasználó által küldött médiamellékletek letöltéséhez (lehet "null", ha csak szöveg).
  • "telefon": a feladó telefonszáma nemzetközi formátumban.
  • sender_bm_id: A Viber Business feladóazonosító.