Messagio API ühilduvus

SMSBAT toetab ühilduvuskihti Messagio API-ga. See võimaldab teil migreerida oma olemasolevad Messagio jaoks loodud Viberi integratsioonid otse SMSBAT-i, ilma et peaksite oma kasuliku koormuse struktuuri ümber kirjutama või integratsiooniloogikat muutma.

Ühenduse seaded

Taotluste suunamiseks SMSBAT-i kaudu värskendage oma integratsioonis põhi-URL-i ja autentimismandaate.

Baas-URL: https://restapi.smsbat.com
Lõpp-punkt: POST /api/Saadasõnum
Taotluse vorming: application/x-www-form-urlencoded (vormi andmed)

Autentimine ja volitused

Taotlused autentitakse parameetrite abil, mis saadetakse otse päringu kehavormi andmetesse:

Parameeter	Tüüp	Nõutav	Kirjeldus
"kasutaja"	string	Jah	Teie SMSBAT konto sisselogimine või kasutaja identifikaator.
`märk`	string	Jah	Saatja nimele registreeritud API saladus või allkiri.
"alates"	string	Jah	Registreeritud saatja alfanimi.
"saatmismeetod"	string	Jah	Kanali tüüp. Kasutage "viber" tavaliste Viber Business sõnumite jaoks või "viber_otp" Viberi OTP mallide jaoks.
`telefon`	string	Jah	Saaja telefoninumber rahvusvahelises vormingus (nt `380501234567`).

Viberi sõnumitüübid

Valige allolev vahekaart, et vaadata konkreetseid parameetreid ja küsida erinevate Viberi sõnumistruktuuride jaoks kasulikke koormusi:

TekstsõnumTekst + nuppPilt sõnumTekst + pilt + nuppVideosõnumOTP mall

Saadab lihtsa tekstisõnumi.

Lisaparameetrid:

Parameeter	Tüüp	Nõutav	Kirjeldus
`txt`	string	Jah	Sõnumi tekst.

Kasuliku koormuse taotlemise näide:

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

Saadab interaktiivse tegevusele kutsuva nupuga tekstsõnumi.

Lisaparameetrid:

Parameeter	Tüüp	Nõutav	Kirjeldus
`txt`	string	Jah	Sõnumi tekst.
nupu_tekst	string	Jah	Nupul kuvatav tekst.
"button_link"	string	Jah	Sihtkoha URL nupul klõpsamisel.

Kasuliku koormuse taotlemise näide:

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

Saadab avaliku pildifaili.

Lisaparameetrid:

Parameeter	Tüüp	Nõutav	Kirjeldus
"image_link"	string	Jah	Kujutise avalik HTTPS-i URL.
`txt`	string	Ei	Pildi all kuvatav valikuline pealdistekst.

Kasuliku koormuse taotlemise näide:

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

Saadab rikkaliku kaardi, mis sisaldab teksti, pilti ja nuppu.

Lisaparameetrid:

Parameeter	Tüüp	Nõutav	Kirjeldus
`txt`	string	Jah	Tiitrite tekst.
"image_link"	string	Jah	Kujutise avalik HTTPS-i URL.
"nupu_tekst"	string	Jah	Nupul kuvatav tekst.
"button_link"	string	Jah	Sihtkoha URL nupul klõpsamisel.

Kasuliku koormuse taotlemise näide:

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

Saadab videofaili koos valikulise tekstipealkirja ja toimingunuppudega.

Lisaparameetrid:

Parameeter	Tüüp	Nõutav	Kirjeldus
`video.url`	string	Jah	Videofaili avalik HTTPS-i URL.
`video.thumbnail`	string	Jah	Video eelvaatepildi avalik HTTPS-i URL.
`video.size_mb`	täisarv	Jah	Ligikaudne videofaili suurus megabaitides.
`video.duration_sec`	täisarv	Jah	Video kestus sekundites.
`txt`	string	Ei	Valikuline kirjeldav tekst.
nupu_tekst	string	Ei	Valikuline nupu tekst (võib toimida pealdise või lingina).
"button_link"	string	Ei	Valikuline nupu lingi URL.

Kasuliku koormuse taotlemise näide:

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

Saadab Viberi ühekordsed paroolid (OTP), kasutades eelnevalt kinnitatud malli.

Tähele

OTP-sõnumite saatmisel peate määrama "saatmismeetodi" väärtuseks "viber_otp".

Lisaparameetrid:

| Parameeter | Tüüp | Nõutav | Kirjeldus |
| :--- | :--- | :--- | :--- |
| `template.id` | string | **Yes** | Eelkinnitatud Viberi OTP malli ID. |
| `template.lang` | string | **Jah** | Malli keelekood (nt "en", "uk"). |
| `template.params.pin` | string | **Jah** | Malli sisestatav OTP pin väärtus. |
| `template.params.business_platform_name` | string | **Yes** | Ettevõtte nime kohatäide mallis. |
| `template.params.code_validity_time` | string | **Jah** | PIN-koodi kehtivusaeg minutites. |

**Kasuliku koormuse taotlemise näide:**
```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
```

Carousel MessageUuringu sõnum

Saadab interaktiivse sõnumikaardi, mis sisaldab mitut slaidi (kaarti), mille kaudu kasutaja saab pühkida.

Lisaparameetrid:

Parameeter	Tüüp	Nõutav	Kirjeldus
`txt`	string	Yes	Karusselli pealkirja tekst.
`karussell[N].pealkiri`	string	Jah	Kaardi pealkiri "N" (alates 0-st).
`karussell[N].image_url`	string	Jah	Kaardi „N” avaliku HTTPS-pildi URL.
`karussell[N].peamine_silt`	string	Jah	Kaardi põhinupu pealkiri "N".
`karussell[N].esmane_url`	string	Jah	Kaardi „N” põhinupu lingi URL.
`karussell[N].sekundaarne_silt`	string	Ei	Kaardi teise nupu pealkiri "N".
`karussell[N].secondary_url`	string	Ei	Kaardi „N” teisese nupu lingi URL.

Kasuliku koormuse taotlemise näide:

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

Saadab sõnumi, mis sisaldab interaktiivset küsitlust või küsitluse küsimust.

Lisaparameetrid:

Parameeter	Tüüp	Required	Description
`txt`	string	Jah	Survey question text.
`survey_options[N]`	string	Jah	Küsitluse valiku tekst üksuse „N” jaoks (indeks alates 0). Vaja on vähemalt 2 valikut.
"valiku_tüüp"	täisarv	Yes	Valija tüüp: „1” (raadionupud) või „2” (tavalised nupud).

Kasuliku koormuse taotlemise näide:

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

Response Format

Messagio API ühilduvuse lõpp-punkt tagastab vastused XML-vormingus olekukoodiga „HTTP 200 OK”.

Aktsepteeritud (edukas) vastus

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

Vea vastused

Kui päringu parameetrite valideerimine ebaõnnestub või autentimine ebaõnnestub, tagastab vastus nullist erineva koodi.

Allkiri puudubVolitamata

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

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

Tagasihelistamine

Tagasihelistamise URL-id peavad olema teie platvormil juurutatud ja hostitud. SMSBAT saadab HTTP tagasihelistamisi, et värskendada teie süsteemi tarnesündmuste, küsitluste vastuste ja kasutajate vastuste osas.

1. Kohaletoimetamise oleku tagasihelistamine

Saadetakse, kui sõnum oleku üleminekul (edastatud, loetud, nurjus).

Sisu tüüp: rakendus/x-www-vorm-urlencoded
Method: POST

Kasuliku koorma vormingute taotlemine:

Tarnitud:

msg_id=MESSAGE_GUID&status=delivered

* Seen/Read:

msg_id=MESSAGE_GUID&status=delivered&type=seen

* Tarnimata / nurjunud:

msg_id=MESSAGE_GUID&status=undelivered&status_extended=REASON

Väljade kirjeldus:

msg_id: SMSBAT kordumatu sõnumi ID (GUID), mis tagastati vastuses SendMessage.
"Olek": kohaletoimetamise tulemus ("tarnitud", "andmata" või "olek teadmata").
"Tüüp": määrake "nähtud", kui adressaat on sõnumit vaadanud.
"status_extended": konkreetne tehniline põhjus oleku edastamata jätmiseks (nt "VIBER_EXPIRED", "VIBER_BLOCKED_BY_USER", "VIBER_USER_NOT_FOUND", "VIBER_NO_DEVICE").

2. Küsitluse vastuse tagasihelistamine

Käivitub, kui kasutaja valib Viber Survey sõnumis vastusevaliku.

Sisu tüüp: rakendus/x-www-vorm-urlencoded
Meetod: 'POSTITA'

Kasuliku koorma vormingu taotlemine:

msg_id=ORIGINAL_SURVEY_MESSAGE_GUID&text=SELECTED_OPTION_TEXT

3. Sissetuleva kasutaja sõnumi tagasihelistamine

Käivitub, kui kasutaja saadab teie teenusele Viber Business tagasi teksti- või meediavastuse.

Content-Type: „rakendus/json”.
Meetod: 'POSTITA'

Kasuliku koorma vormingu taotlemine:

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

Fields Description:

"msg_id": sissetuleva vastuse jaoks loodud kordumatu sõnumi ID.
"tekst": kasutaja saadetud tekstisisu (võib olla "null", kui ta saatis ainult meedia).
„Meedia”: otsene URL kasutaja saadetud meediumimanuste allalaadimiseks (võib olla null, kui ainult tekst).
"telefon": saatja telefoninumber rahvusvahelises vormingus.
"sender_bm_id": Viber Businessi saatja ID.