Keri sisuni

SMSBAT API

SMSBAT on RESTful API platvorm erinevat tüüpi sõnumite saatmiseks, sealhulgas Viberi karussell, Viberi arvamusdialoog, Viberi reklaam (pildid, video), Viberi ärivestlus, OTP-teated (Viber OTP, Flash Call) ja nende varuvariandid.

Baas-URL

Taotlused SMSBAT API-le edastatakse lokaliseerimisega lõpp-punkti. Küsige aadressi eelnevalt oma haldurilt.

Näide: „https://restapi.smsbat.com” (tegelik URL võib olenevalt teie piirkonnast erineda)

Autentimine

SMSBAT API toetab kolme autentimismeetodit:

1. meetod: HTTP põhiautent

Kasutage oma kasutajanime ja parooli mandaati:

curl -X POST https://restapi.smsbat.com/bat/messagelist \
  -u "username:password" \
  -H "Content-Type: application/json" \
  -d @request.json

2. meetod: API võtme päis

Kasutage päist "X-Authorization-Key":

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. meetod: API võti paroolina

Kasutage kasutajanimena @ ja paroolina API võtit:

curl -X POST https://restapi.smsbat.com/bat/messagelist \
  -u "@:your-api-key" \
  -H "Content-Type: application/json" \
  -d @request.json

Saadaolevad lõpp-punktid

Meetod Lõpp-punkt Kirjeldus
POSTITUS /nahkhiir/messagelist Saada sõnumeid
SAADA /bat/message/{messageId} Kontrollige sõnumi olekut

Sõnumitüübid

SMSBAT API toetab järgmisi sõnumitüüpe:

  • SMS - standardsed tekstisõnumid
  • Viber Promo - rikasmeediaga reklaamsõnumid
  • Viber Transactional - tehinguteatised
  • Viberi karussell - interaktiivsed karussellisõnumid
  • Viber Survey - Arvamusdialoogi teated
  • Viber OTP - ühekordsed parooliteatised
  • RCS - rikkalikud sideteenuste sõnumid
  • Flash Call - vaikse kõne kinnitamine

Põhifunktsioonid

Varusõnumid

Kui esmane kohaletoimetamine ebaõnnestub, läheb SMSBAT automaatselt tagasi alternatiivsetele kanalitele:

Viber → SMS → Email

Rikasmeedia tugi

Saada sõnumeid:

  • pildid (JPG, PNG)
  • videod (MP4)
  • PDF-id
  • nupud ja tegevuslingid

Sõnumi oleku jälgimine

Jälgige kohaletoimetamise olekut reaalajas:

  • Saadetud
  • Tarnitud
  • Loe
  • Ebaõnnestunud
  • Aegunud

Tagasihelistamine

Võtke vastu sissetulevate Viberi sõnumite tagasihelistamised kahesuunaliseks suhtluseks.

Kiire algus

  1. Saada sõnum – vaadake, kuidas oma esimest sõnumit saata
  2. Kontrolli olekut – jälgi sõnumi edastamise olekut
  3. Sõnumitüübid – uurige erinevaid sõnumitüüpe

Taotle vormingut

Kõik päringud kasutavad JSON-vormingut järgmise struktuuriga:

{
  "messages": [
    {
      "recipient": "+380XXXXXXXXX",
      "type": "viber",
      "text": "Your message here",
      // ... additional parameters
    }
  ]
}

Vastusevorming

Edukad vastused tagastatakse:

{
  "messages": [
    {
      "messageId": "unique-message-id",
      "recipient": "+380XXXXXXXXX",
      "status": "sent"
    }
  ]
}

Vigade käsitlemine

HTTP olekukoodid:

  • "200 OK" - taotlus õnnestus – „400 vigane taotlus” – taotluse vorming on kehtetu
  • "401 Volitamata" - Autentimine ebaõnnestus
  • "429 liiga palju taotlust" - määra piirang ületatud
  • "500 sisemine serveri viga" - serveri viga

Järgmised sammud