Messagio API-kompatibilitet

SMSBAT supports a compatibility layer with the Messagio API. Dette giver dig mulighed for at migrere dine eksisterende Viber-integrationer designet til Messagio direkte til SMSBAT uden at skulle omskrive din nyttelaststruktur eller ændre integrationslogik.

Forbindelsesindstillinger

To route requests through SMSBAT, update the base URL and authentication credentials in your integration:

Basis-URL: https://restapi.smsbat.com
Endpunkt: POST /api/SendMessage
Request Format: application/x-www-form-urlencoded (Form Data)

Godkendelse og legitimationsoplysninger

Requests are authenticated using parameters sent directly within the request body form data:

Parameter	Skriv	Påkrævet	Beskrivelse
`bruger`	streng	Ja	Dit SMSBAT-konto login eller bruger-id.
`tegn`	streng	Ja	API secret or signature registered for the sender name.
`fra`	streng	Ja	Registreret afsender alfanavn.
`afsendelsesmetode`	streng	Ja	Kanaltype. Use `viber` for regular Viber Business messages or `viber_otp` for Viber OTP templates.
`telefon`	streng	Ja	Recipient phone number in international format (e.g., `380501234567`).

Viber-meddelelsestyper

Choose a tab below to view the specific parameters and request payloads for different Viber message structures:

SmsTekst + knapBilledmeddelelseTekst + billede + knapVideo MessageOTP Template

Sender en simpel sms.

Yderligere parametre:

Parameter	Skriv	Påkrævet	Beskrivelse
`txt`	streng	Ja	Besked tekst.

Eksempel på anmodning om nyttelast:

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

Sends a text message with an interactive call-to-action button.

Yderligere parametre:

Parameter	Skriv	Påkrævet	Beskrivelse
`txt`	streng	Ja	Besked tekst.
`knaptekst`	streng	Ja	Tekst vist på knappen.
`knaplink`	streng	Ja	Destinations-URL, når der trykkes på knappen.

Eksempel på anmodning om nyttelast:

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

Sender en offentlig billedfil.

Yderligere parametre:

Parameter	Skriv	Påkrævet	Beskrivelse
`image_link`	streng	Ja	Offentlig HTTPS URL for billedet.
`txt`	streng	Nej	Optional caption text to display below the image.

Eksempel på anmodning om nyttelast:

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

Sends a rich card containing text, an image, and a button.

Yderligere parametre:

Parameter	Skriv	Påkrævet	Beskrivelse
`txt`	streng	Yes	Caption text.
`image_link`	streng	Ja	Offentlig HTTPS URL for billedet.
`knaptekst`	streng	Yes	Tekst vist på knappen.
`knaplink`	streng	Ja	Destinations-URL, når der trykkes på knappen.

Eksempel på anmodning om nyttelast:

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

Sends a video file with an optional text caption and action buttons.

Yderligere parametre:

Parameter	Skriv	Påkrævet	Beskrivelse
`video.url`	streng	Yes	Offentlig HTTPS URL for videofilen.
`video.thumbnail`	streng	Ja	Offentlig HTTPS URL for videoeksempelbilledet.
`video.størrelse_mb`	integer	Ja	Omtrentlig videofilstørrelse i megabyte.
`video.duration_sec`	heltal	Ja	Videovarighed i sekunder.
`txt`	streng	Nej	Valgfri beskrivelsestekst.
`button_text`	streng	Nej	Optional button text (can act as a caption or link).
`button_link`	streng	Nej	Valgfri knaplink-URL.

Eksempel på anmodning om nyttelast:

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

Sender Viber One-Time Passwords (OTP) ved hjælp af en forhåndsgodkendt skabelon.

Bemærk

Når du sender engangsbeskeder, skal du indstille sendingsmetode til viber_otp.

Yderligere parametre:

| Parameter | Skriv | Påkrævet | Beskrivelse |
| :--- | :--- | :--- | :--- |
| `skabelon.id` | streng | **Ja** | Forhåndsgodkendt Viber OTP-skabelon-id. |
| `template.lang` | streng | **Ja** | Skabelonsprogkode (f.eks. `en`, `uk`). |
| `template.params.pin` | streng | **Ja** | OTP-pinværdien, der skal indsprøjtes i skabelonen. |
| `template.params.business_platform_name` | streng | **Ja** | Virksomhedsnavnets pladsholder i skabelonen. |
| `template.params.code_validity_time` | streng | **Ja** | PIN-kodens gyldighedsperiode i minutter. |

**Eksempel på anmodning om nyttelast:**
```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
```

KarruselmeddelelseUndersøgelsesmeddelelse

Sender et interaktivt beskedkort, der indeholder flere dias (kort), som brugeren kan stryge igennem.

Yderligere parametre:

Parameter	Skriv	Påkrævet	Beskrivelse
`txt`	streng	Ja	Karrusellens titeltekst.
`karrusel[N].titel`	streng	Ja	Kortets titel "N" (startende ved 0).
`karrusel[N].image_url`	streng	Ja	Offentlig HTTPS-billedwebadresse for kortet "N".
`karrusel[N].primær_label`	streng	Ja	Hovedknaptekst på kortet "N".
`karrusel[N].primær_url`	streng	Ja	Hovedknap-link-URL for kort "N".
`karrusel[N].sekundær_etiket`	streng	Nej	Sekundær knaptekst på kortet "N".
`karrusel[N].sekundær_url`	streng	Nej	Sekundær knaplink-URL for kortet "N".

Eksempel på anmodning om nyttelast:

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

Sender en besked, der indeholder en interaktiv afstemning eller undersøgelsesspørgsmål.

Yderligere parametre:

Parameter	Skriv	Påkrævet	Beskrivelse
`txt`	streng	Ja	Tekst til undersøgelsesspørgsmål.
`survey_options[N]`	streng	Ja	Undersøgelsesindstillingstekst for emne "N" (indeks, der starter ved 0). Der kræves mindst 2 muligheder.
"option_type"	heltal	Ja	Type vælger: `1` (RadioButtons) eller `2` (almindelige knapper).

Eksempel på anmodning om nyttelast:

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

Svarformat

Messagio API-kompatibilitetsslutpunktet returnerer svar i XML-format med en HTTP 200 OK-statuskode.

Accepteret (succes) svar

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

Fejlsvar

Hvis en anmodningsparametervalidering mislykkes, eller godkendelse mislykkes, returnerer svaret en kode, der ikke er nul.

Manglende signaturUautoriseret

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

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

Tilbagekald

Callback-URL'er skal implementeres og hostes på din platform. SMSBAT sender HTTP-tilbagekald for at opdatere dit system vedrørende leveringshændelser, undersøgelsessvar og brugersvar.

1. Leveringsstatus Tilbagekald

Sendt, når en besked skifter status (leveret, læst, mislykkedes).

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

Anmod om nyttelastformater:

Leveret:

msg_id=MESSAGE_GUID&status=delivered

Set/læst:

msg_id=MESSAGE_GUID&status=delivered&type=seen

* Uleveret / Mislykket:

msg_id=MESSAGE_GUID&status=undelivered&status_extended=REASON

Feltbeskrivelse:

msg_id: SMSBAT unikt meddelelses-id (GUID) returneret i SendMessage-svaret.
'status': Leveringsresultat ('leveret', 'ikke leveret' eller 'status ukendt').
type: Indstil til set, når beskeden er blevet set af modtageren.
status_extended: Specifik teknisk årsag til ikke-leveret status (f.eks. "VIBER_EXPIRED", "VIBER_BLOCKED_BY_USER", "VIBER_USER_NOT_FOUND", "VIBER_NO_DEVICE").

2. Undersøgelsessvar Tilbagekald

Udløses, når en bruger vælger en svarmulighed i en Viber Survey-meddelelse.

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

Anmodningsformat for nyttelast:

msg_id=ORIGINAL_SURVEY_MESSAGE_GUID&text=SELECTED_OPTION_TEXT

3. Indgående brugerbesked tilbagekald

Udløses, når en bruger sender en tekst- eller mediesvar tilbage til din Viber Business-tjeneste.

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

Anmodningsformat for nyttelast:

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

Feltbeskrivelse:

msg_id: Det unikke meddelelses-id, der er genereret for det indgående svar.
tekst: Tekstindhold sendt af brugeren (kan være "nul", hvis de kun sendte medier).
medie: Direkte URL til at downloade eventuelle medievedhæftede filer sendt af brugeren (kan være "null", hvis kun tekst).
telefon: Afsenderens telefonnummer i internationalt format.
sender_bm_id: Viber Business-afsender-id'et.