Messagio API-kompatibilitet

SMSBAT stöder ett kompatibilitetslager med Messagio API. Detta gör att du kan migrera dina befintliga Viber-integrationer designade för Messagio direkt till SMSBAT utan att behöva skriva om din nyttolaststruktur eller ändra integrationslogik.

Anslutningsinställningar

För att dirigera förfrågningar via SMSBAT, uppdatera bas-URL och autentiseringsuppgifter i din integration:

Baswebbadress: https://restapi.smsbat.com
Slutpunkt: POST /api/SendMessage
Request Format: application/x-www-form-urlencoded (formulärdata)

Autentisering och inloggningsuppgifter

Begäranden autentiseras med hjälp av parametrar som skickas direkt i formulärdata för begäran:

Parameter	Skriv	Krävs	Beskrivning
`användare`	sträng	Ja	Din SMSBAT-kontoinloggning eller användaridentifierare.
`tecken`	sträng	Ja	API-hemlighet eller signatur registrerad för avsändarens namn.
`från`	sträng	Ja	Registrerad avsändarens alfanamn.
`sändningsmetod`	sträng	Ja	Kanaltyp. Använd "viber" för vanliga Viber Business-meddelanden eller "viber_otp" för Viber OTP-mallar.
`telefon`	sträng	Ja	Mottagarens telefonnummer i internationellt format (t.ex. "380501234567").

Viber meddelandetyper

Välj en flik nedan för att se de specifika parametrarna och begära nyttolaster för olika Viber-meddelandestrukturer:

SMSText + knappBildmeddelandeText + bild + knappVideomeddelandeOTP-mall

Skickar ett enkelt sms.

Ytterligare parametrar:

Parameter	Skriv	Krävs	Beskrivning
`txt`	sträng	Ja	Meddelandetext.

Exempel på begäran om nyttolast:

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

Skickar ett textmeddelande med en interaktiv uppmaningsknapp.

Ytterligare parametrar:

Parameter	Skriv	Krävs	Beskrivning
`txt`	sträng	Ja	Meddelandetext.
`knapptext`	sträng	Ja	Text som visas på knappen.
`knapplänk`	sträng	Ja	Destinationsadress när knappen klickas.

Exempel på begäran om nyttolast:

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

Skickar en offentlig bildfil.

Ytterligare parametrar:

Parameter	Skriv	Krävs	Beskrivning
`bildlänk`	sträng	Ja	Offentlig HTTPS-URL för bilden.
`txt`	sträng	Nej	Valfri bildtext att visa under bilden.

Exempel på begäran om nyttolast:

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

Skickar ett utökat kort som innehåller text, en bild och en knapp.

Ytterligare parametrar:

Parameter	Skriv	Krävs	Beskrivning
`txt`	sträng	Ja	Bildtext.
`bildlänk`	sträng	Ja	Offentlig HTTPS-URL för bilden.
`knapptext`	sträng	Ja	Text som visas på knappen.
`knapplänk`	sträng	Ja	Destinationsadress när knappen klickas.

Exempel på begäran om nyttolast:

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

Skickar en videofil med valfri texttext och åtgärdsknappar.

Ytterligare parametrar:

Parameter	Skriv	Krävs	Beskrivning
`video.url`	sträng	Ja	Offentlig HTTPS-URL för videofilen.
`video.thumbnail`	sträng	Ja	Offentlig HTTPS-URL för videoförhandsvisningsbilden.
`video.size_mb`	heltal	Ja	Ungefärlig videofilstorlek i megabyte.
`video.duration_sec`	heltal	Ja	Videons längd i sekunder.
`txt`	sträng	Nej	Valfri beskrivningstext.
`knapptext`	sträng	Nej	Valfri knapptext (kan fungera som bildtext eller länk).
`knapplänk`	sträng	Nej	Valfri knapplänk-URL.

Exempel på begäran om nyttolast:

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

Skickar Viber One-Time Passwords (OTP) med en förgodkänd mall.

Notera

När du skickar OTP-meddelanden måste du ställa in sändningsmetod till viber_otp.

Ytterligare parametrar:

| Parameter | Skriv | Krävs | Beskrivning |
| :--- | :--- | :--- | :--- |
| `mall.id` | sträng | **Ja** | Förgodkänt Viber OTP-mall-ID. |
| `template.lang` | sträng | **Ja** | Mallens språkkod (t.ex. "en", "uk"). |
| `template.params.pin` | sträng | **Ja** | OTP-stiftvärdet som ska injiceras i mallen. |
| `template.params.business_platform_name` | sträng | **Ja** | Platshållaren för företagsnamnet i mallen. |
| `template.params.code_validity_time` | sträng | **Ja** | PIN-kodens giltighetstid i minuter. |

**Exempel på begäran om nyttolast:**
```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
```

KarusellmeddelandeEnkätmeddelande

Skickar ett interaktivt meddelandekort som innehåller flera bilder (kort) som användaren kan svepa igenom.

Ytterligare parametrar:

Parameter	Skriv	Krävs	Beskrivning
`txt`	sträng	Ja	Karusellens titeltext.
`karusell[N].titel`	sträng	Ja	Kortets titel "N" (börjar på 0).
`karusell[N].image_url`	sträng	Ja	Offentlig HTTPS-bildadress för kortet "N".
`karusell[N].primär_etikett`	sträng	Ja	Huvudknappstext för kort "N".
`karusell[N].primär_url`	sträng	Ja	Huvudknapplänk URL för kortet "N".
`karusell[N].sekundär_etikett`	sträng	Nej	Sekundär knapptext för kortet "N".
`karusell[N].secondary_url`	sträng	Nej	Sekundär knapplänk URL för kortet "N".

Exempel på begäran om nyttolast:

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

Skickar ett meddelande som innehåller en interaktiv omröstning eller enkätfråga.

Ytterligare parametrar:

Parameter	Skriv	Krävs	Beskrivning
`txt`	sträng	Ja	Enkätfrågas text.
`survey_options[N]`	sträng	Ja	Enkätalternativstext för objekt "N" (index som börjar på 0). Minst 2 alternativ krävs.
`alternativtyp`	heltal	Ja	Typ av väljare: `1` (RadioButtons) eller `2` (vanliga knappar).

Exempel på begäran om nyttolast:

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

Svarsformat

Messagio API-kompatibilitetsslutpunkt returnerar svar i XML-format med en "HTTP 200 OK"-statuskod.

Accepterat (framgångs)svar

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

Felsvar

Om en begäran om parametervalidering misslyckas eller autentiseringen misslyckas, kommer svaret att returnera en kod som inte är noll.

Saknad signaturObehörig

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

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

Återuppringningar

Callback-URL:er måste implementeras och finnas på din plattform. SMSBAT skickar HTTP-återuppringningar för att uppdatera ditt system angående leveranshändelser, enkätsvar och användarsvar.

1. Leveransstatus Återuppringning

Skickas när ett meddelande övergår status (levererat, läst, misslyckats).

Content-Type: application/x-www-form-urlencoded
Metod: "POST".

Begär nyttolastformat:

Levererat:

msg_id=MESSAGE_GUID&status=delivered

Sett/läst:

msg_id=MESSAGE_GUID&status=delivered&type=seen

* Ej levererad / misslyckad:

msg_id=MESSAGE_GUID&status=undelivered&status_extended=REASON

Fältbeskrivning:

msg_id: SMSBAT unikt meddelande-ID (GUID) returneras i SendMessage-svaret.
'status': Leveransresultat ('levererat', 'ej levererat' eller 'status okänd').
typ: Ställ in på seed när meddelandet har setts av mottagaren.
status_extended: Specifik teknisk orsak till ej levererad status (t.ex. "VIBER_EXPIRED", "VIBER_BLOCKED_BY_USER", "VIBER_USER_NOT_FOUND", "VIBER_NO_DEVICE").

2. Enkätsvar Återuppringning

Utlöses när en användare väljer ett svarsalternativ i ett Viber Survey-meddelande.

Content-Type: application/x-www-form-urlencoded
Metod: "POST".

Begär nyttolastformat:

msg_id=ORIGINAL_SURVEY_MESSAGE_GUID&text=SELECTED_OPTION_TEXT

3. Återuppringning av inkommande användarmeddelande

Utlöses när en användare skickar ett text- eller mediasvar tillbaka till din Viber Business-tjänst.

Content-Type: application/json
Metod: "POST".

Begär nyttolastformat:

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

Fältbeskrivning:

msg_id: Det unika meddelande-ID som genereras för det inkommande svaret.
text: Textinnehåll som skickas av användaren (kan vara "null" om de bara skickade media).
media: Direkt URL för att ladda ner eventuella mediebilagor som skickas av användaren (kan vara "null" om endast text).
telefon: Avsändarens telefonnummer i internationellt format.
sender_bm_id: Viber Business avsändar-ID.