SMSBAT API
Az SMSBAT egy RESTful API platform különféle típusú üzenetek küldésére, beleértve a Viber körhinta, a Viber vélemény párbeszédablakot, a Viber promóciót (képek, videók), a Viber üzleti chateket, az OTP értesítéseket (Viber OTP, Flash Call) és ezek tartalék változatait.
Alap URL
Az SMSBAT API-ra irányuló kérelmek egy lokalizációval rendelkező végponthoz kerülnek továbbításra. Előzetesen kérje a címet menedzserétől.
Példa: "https://restapi.smsbat.com" (a tényleges URL régiótól függően változhat)
Hitelesítés
Az SMSBAT API három hitelesítési módszert támogat:
1. módszer: HTTP Basic Auth
Használja felhasználónevét és jelszavát:
curl -X POST https://restapi.smsbat.com/bat/messagelist \
-u "username:password" \
-H "Content-Type: application/json" \
-d @request.json
2. módszer: API-kulcs fejléce
Használja az "X-Authorization-Key" fejlécet:
curl -X POST https://restapi.smsbat.com/bat/messagelist \
-H "X-Authorization-Key: your-api-key" \
-H "Content-Type: application/json" \
-d @request.json
3. módszer: API-kulcs jelszóként
Használja a „@” karaktert felhasználónévként és az API-kulcsot jelszóként:
curl -X POST https://restapi.smsbat.com/bat/messagelist \
-u "@:your-api-key" \
-H "Content-Type: application/json" \
-d @request.json
Elérhető végpontok
| Módszer | Végpont | Leírás |
|---|---|---|
| POST | /bat/üzenetlista |
Üzenetek küldése |
| GET | /bat/message/{messageId} |
Üzenet állapotának ellenőrzése |
Üzenettípusok
Az SMSBAT API a következő üzenettípusokat támogatja:
- SMS - Normál szöveges üzenetek
- Viber Promo - Promóciós üzenetek multimédiával
- Viber Tranzakciós - Tranzakciós értesítések
- Viber Carousel - Interaktív körhintaüzenetek
- Viber Survey - Vélemény párbeszédpanelek
- Viber OTP - Egyszeri jelszóértesítések
- RCS - Gazdag kommunikációs szolgáltatások üzenetei
- Flash Call - Csendes hívásellenőrzés
Főbb jellemzők
Tartalék üzenetküldés
Ha az elsődleges kézbesítés sikertelen, az SMSBAT automatikusan visszatér az alternatív csatornákra:
Multimédiás támogatás
Üzenetek küldése a következővel:
- Képek (JPG, PNG)
- Videók (MP4)
- PDF-ek
- Gombok és akciólinkek
Üzenetállapot-követés
Kövesse nyomon a kézbesítés állapotát valós időben:
- Elküldve
- Szállítva
- Olvass
- Nem sikerült
- Lejárt
Visszahívások
Bejövő Viber-üzenet-visszahívások fogadása a kétirányú kommunikációhoz.
Gyorsindítás
- Üzenet küldése – További információ az első üzenet elküldéséről
- Állapot ellenőrzése – Az üzenet kézbesítési állapotának nyomon követése
- Üzenettípusok – Fedezze fel a különböző üzenettípusokat
Formátum kérése
Minden kérelem JSON formátumot használ a következő szerkezettel:
{
"messages": [
{
"recipient": "+380XXXXXXXXX",
"type": "viber",
"text": "Your message here",
// ... additional parameters
}
]
}
Válaszformátum
A sikeres válaszok visszaküldése:
{
"messages": [
{
"messageId": "unique-message-id",
"recipient": "+380XXXXXXXXX",
"status": "sent"
}
]
}
Hibakezelés
HTTP állapotkódok:
- "200 OK" - A kérés sikeres
400 hibás kérés- Érvénytelen kérésformátum401 Jogosulatlan- A hitelesítés nem sikerült429 Túl sok kérés- Túllépte a sebességkorlátot- "500 Belső szerverhiba" - Szerverhiba
Következő lépések
- Üzenet küldése - Üzenetek küldése
- Viber-üzenetek - További információ a Viber-üzenettípusokról
- SMS-üzenetek - SMS-üzenetek küldése
- RCS-üzenetek - Gazdag kommunikációs szolgáltatások
- Flash Call - Telefonos ellenőrzés
- Állapot ellenőrzése - Kövesse nyomon a kézbesítés állapotát