Help Center Core Restapi

Core Restapi

Treoir # SMSBAT RESTful API

Treoir iomlán ar an SMSBAT RESTful API - gach rud atá uait.

Nuashonraithe: 29 Lúnasa, 2025

Ligeann SMSBAT RESTful API duit cineálacha éagsúla teachtaireachtaí a sheoladh: Viber-carousel, Viber-survey, Viber-promo (íomhánna, físeáin), comhráite gnó Viber, teachtaireachtaí OTP (Viber OTP, Flash Call), agus a gcuid leaganacha cúltaca.

**Tabhair faoi deara **: Is é seo an API HTTP aontaithe le haghaidh teachtaireachtaí amach. Más gá duit comhtháthú le róbónna isteach (Viber Bot / Telegram Bot), féach le do thoil don API Cascade.

1. Prótacal

  • Prótacal: HTTPS
  • Comhlacht Iarratais: Réad JSON ina bhfuil sraith teachtaireachtaí.
  • Modhanna:
    • GET chun sonraí a fháil (stádas teachtaireachta, cothromaíocht, etc.)
    • POST chun rudaí a chruthú (m.sh. craoladh/seoladh a thionscnamh)
    • PATCH chun rudaí a mhodhnú

2. Údarú

Cuirimid roinnt modhanna údaraithe ar fáil duit ar mhaithe leat:

  • Fíordheimhniú Bunúsach HTTP (logáil isteach agus pasfhocal ó do dheais).
  • Ceanntásc HTTP Saincheaptha X-Authorization-Key ina bhfuil Comhartha API.
  • Réimse phasfhocal Fíordheimhnithe Bunús HTTP a bhfuil an Chomhartha API aige (pas @ mar an logáil isteach).

Is féidir API Token a ghiniúint sa Phainéal faoi Próifíl Úsáideora.

Samplaí Iarratais

Le Údar Bunúsach: CÓD_BLOCK_0_

Le X-Údarú-Eochair: CÓD_BLOCK_1_

3. Teachtaireachtaí a Sheoladh

San ardán SMSBAT, meastar gur “Craolachán” (teachtaireachtaí) aon seoladh teachtaireachtaí (fiú teachtaireacht amháin).

Críochphointe

  • Modh: POST
  • URL: https://api.smsbat.com/bat/messagelist
  • Ceanntásca: Cineál Ábhar: iarratas/json

Struchtúr Bunúsach Pá-Ualach: CÓD_BLOCK_2_

Réimsí Riachtanach le haghaidh Gach Réad Teachtaireachta:

  • ó: Alfa-ainm an tseoltóra fíoraithe.
  • go: Uimhir theileafóin an fhaighteora (formáid E.164).
  • cineál: Cineál teachtaireachta enum.
  • text: Príomhthéacs na teachtaireachta (roghnach mura dteastaíonn téacs ón gcineál).

Luachanna cineál tacaithe:

  • sms
  • viber_service (nó viber_trans)
  • viber_promo
  • viber_carousel
  • suirbhé_viber
  • viber_otp
  • seisiún_viber
  • flashcall_callback
  • flashcall

Réimsí Coitianta Roghnacha:

  • customerMessageId: Aitheantas teaghrán laistigh de do chóras féin (a úsáidtear chun glaonna ar ais a rianú). Caithfidh sé a bheith uathúil in aghaidh na teachtaireachta.
  • dtSend: ISO8601 Dáta/Am seolta sceidealta amach anseo.
  • dtExpire: ISO8601 Dáta/Am an spriocdháta seachadta.
  • ttl: Am le Beo i soicindí. (Mura gcuirtear dtExpire ar fáil, ríomhann an API léarscáiliú réamhshocraithe ón cineál).

TTLanna réamhshocraithe (Soicind):

  • sms - 86400 (24h)
  • viber_trans / viber_service - 345600
  • viber_promo - 604800
  • seisiún_viber - 604800

4. Routing Fallback (Cascading)

Is féidir leat scuaine cúltaca a shonrú chun seachadadh na teachtaireachta a chinntiú má theipeann ar an bpríomhchainéal nó má théann sé in éag.

CÓD_BLOCK_3_ Spreagann cúlchistí nuair a dhiúltaíonn an soláthraí don phríomhtheachtaireacht nó nuair a théann an TTL in éag.

5. Forbhreathnú ar Chineálacha Teachtaireachta & Sonraí teachtaireachta

Éilíonn cineálacha casta teachtaireachta cumraíochtaí breise a instealladh isteach san airí messageData.

5.1 Cur Chun Cinn Viber (viber_promo)

Íomhá Amháin CÓD_BLOCK_4_

Téacs + Cnaipe CÓD_BLOCK_5_

Íomhá + Téacs + Cnaipe Comhcheanglaíonn sé img, cnaipe Téacs, agus cnaipe Gníomh.

Ualach Físeáin: CÓD_BLOCK_6_ (Is féidir leat airíonna Físeáin a chomhcheangal freisin le cnaipe Téacs agus cnaipe Gníomh).

5.2 Viber Idirbheart / Seirbhís (viber_trans, viber_service)

Má tá teimpléad ceadaithe agat ina bhfuil comhad ceangailte: CÓD_BLOCK_7_

Teastaíonn eagar carousel.items taobh istigh de messageData.

Teorainneacha:

  • Fad na míreanna: idir 2 agus 5 mhír
  • Teideal: 2 go 38 carachtar
  • imageUrl: Méid molta JPEG/PNG 215x185

CÓD_BLOCK_8_

5.4 Suirbhé / Liosta Viber (viber_survey)

Cruthaíonn pobalbhreith idirghníomhach laistigh den radharc comhrá. CÓD_BLOCK_9_ Feidhmíonn airí téacs na teachtaireachta mar theideal an tsuirbhé (Uasmhéid 85 charachtair). Is féidir leat pas a fháil idir 2 agus 5 rogha, gach ceann ar a mhéad 50 chars.

5.5 Viber OTP (viber_otp)

Úsáideann sé teimpléid áitiúla Viber réamhchláraithe ar fud an domhain. CÓD_BLOCK_10_ Tá paraiméadair teimpléid (bioráin, business_platform_name) fíor-íogair ó thaobh cásanna de. Tacaíonn an API le leaganacha éagsúla teanga cód ISO (EN, ES, RU, TR, UK, etc.).

5.6 Glao Splanc (splancghlao)

Ní mór digití deiridh na huimhreach diailithe (an cód ginte) a chur tríd an bparaiméadar téacs. Má fhágtar téacs ar lár, déantar an cód a randamach agus ní mór duit é a bhaint as comhlacht sioncronach 200 OK Response (teachtaireachtaí/téacs) an API.

CÓD_BLOCK_11_