Messagio Compatibility
Comhoiriúnacht # Messagio API
Tacaíonn SMSBAT le ciseal comhoiriúnachta leis an Messagio API. Ligeann sé seo duit do chomhtháthú Viber atá deartha le haghaidh Messagio a aistriú go díreach chuig SMSBAT gan a bheith ort do struchtúr pálasta a athscríobh nó loighic an chomhtháthaithe a athrú.
Socruithe Ceangail
Chun iarratais a chur trí SMSBAT, nuashonraigh an bunUR agus na dintiúir fíordheimhnithe i do chomhtháthú:
- Bun-URL:
https://restapi.smsbat.com - Críochphointe:
POST /api/SendMessage - Formáid Iarratais:
iarratas/x-www-form-urlencoded(Sonraí Foirme)
Fíordheimhniú & Dintiúir
Fíordheimhnítear iarratais trí úsáid a bhaint as paraiméadair a sheoltar go díreach laistigh de shonraí fhoirm an chomhlachta iarratais:
| Paraiméadar | Cineál | Ag Teastáil | Cur Síos |
|---|---|---|---|
úsáideoir |
teaghrán | Tá | Do logáil isteach chuntais SMSBAT nó aitheantóir úsáideora. |
comhartha |
teaghrán | Tá | Rún API nó síniú cláraithe d'ainm an tseoltóra. |
ó |
teaghrán | Tá | Ainm alfa an tseoltóra cláraithe. |
modh_seolta |
teaghrán | Tá | Cineál cainéal. Bain úsáid as viber le haghaidh teachtaireachtaí rialta Viber Business nó viber_otp le haghaidh teimpléid Viber OTP. |
fón |
teaghrán | Tá | Uimhir theileafóin an fhaighteora i bhformáid idirnáisiúnta (m.sh., 380501234567). |
Cineálacha Teachtaireachta Viber
Roghnaigh cluaisín thíos chun na paraiméadair shonracha a fheiceáil agus ualaí pála a iarraidh le haghaidh struchtúir teachtaireachta éagsúla Viber:
Seoltar teachtaireacht téacs simplí.
Paraiméadair Bhreise:
| Paraiméadar | Cineál | Ag Teastáil | Cur Síos |
|---|---|---|---|
txt |
teaghrán | Tá | Téacs teachtaireachta. |
Iarr Sampla Ualach Pá: _CÓD_BLOCK_0__
Seoltar teachtaireacht téacs le cnaipe idirghníomhach glao-chun gnímh.
Paraiméadair Bhreise:
| Paraiméadar | Cineál | Ag Teastáil | Cur Síos |
|---|---|---|---|
txt |
teaghrán | Tá | Téacs teachtaireachta. |
cnaipe_téacs |
teaghrán | Tá | Téacs ar taispeáint ar an gcnaipe. |
cnaipe_nasc |
teaghrán | Tá | URL an chinn scríbe nuair a chliceáiltear an cnaipe. |
Iarr Sampla Ualach Pá: _CÓD_BLOCK_1__
Seoltar comhad íomhá poiblí.
Paraiméadair Bhreise:
| Paraiméadar | Cineál | Ag Teastáil | Cur Síos |
|---|---|---|---|
íomhá_nasc |
teaghrán | Tá | URL poiblí HTTPS na híomhá. |
txt |
teaghrán | Níl | Téacs fotheideal roghnach le taispeáint faoin íomhá. |
Iarr Sampla Ualach Pá: _CÓD_BLOCK_2__
Seoltar cárta saibhir ina bhfuil téacs, íomhá, agus cnaipe.
Paraiméadair Bhreise:
| Paraiméadar | Cineál | Ag Teastáil | Cur Síos |
|---|---|---|---|
txt |
teaghrán | Tá | Téacs fotheideal. |
íomhá_nasc |
teaghrán | Tá | URL poiblí HTTPS na híomhá. |
cnaipe_téacs |
teaghrán | Tá | Téacs ar taispeáint ar an gcnaipe. |
cnaipe_nasc |
teaghrán | Tá | URL an chinn scríbe nuair a chliceáiltear an cnaipe. |
Iarr Sampla Ualach Pá: _CÓD_BLOCK_3__
Seoltar comhad físe le fotheideal téacs roghnach agus cnaipí gníomhaíochta.
Paraiméadair Bhreise:
| Paraiméadar | Cineál | Ag Teastáil | Cur Síos |
|---|---|---|---|
físeán.url |
teaghrán | Tá | URL poiblí HTTPS an chomhaid físe. |
físeán.múnóg |
teaghrán | Tá | URL poiblí HTTPS den íomhá réamhamhairc físeáin. |
físeán.size_mb |
slánuimhir | Tá | Neasmhéid comhaid físe i Meigibheart. |
físeán.duration_sec |
slánuimhir | Tá | Fad físeáin i soicindí. |
txt |
teaghrán | Níl | Téacs cur síos roghnach. |
cnaipe_téacs |
teaghrán | Níl | Téacs cnaipe roghnach (is féidir feidhmiú mar theideal nó mar nasc). |
cnaipe_nasc |
teaghrán | Níl | URL nasc cnaipe roghnach. |
Iarr Sampla Ualach Pá: _CÓD_BLOCK_4__
Seolann Viber Pasfhocail Aonuaire (OTP) ag baint úsáide as teimpléad réamhcheadaithe.
Nóta
Agus teachtaireachtaí OTP á seoladh agat, ní mór duit modh_seolta a shocrú go viber_otp.
Paraiméadair Bhreise:
| Paraiméadar | Cineál | Ag Teastáil | Cur Síos |
| :--- | :--- | :--- | :--- |
| `teimpléad.id` | teaghrán | **Tá** | Aitheantas teimpléid Viber OTP réamhcheadaithe. |
| `teimpléad.lang` | teaghrán | **Tá** | Cód teanga teimpléid (m.sh., `en`, `uk`). |
| `teimpléad.params.pin` | teaghrán | **Tá** | An luach bioráin OTP a instealladh isteach sa teimpléad. |
| `teimpléad.params.business_platform_name` | teaghrán | **Tá** | Ainm sealbhóir an ghnó sa teimpléad. |
| `teimpléad.params.code_validity_time` | teaghrán | **Tá** | Tréimhse bailíochta PIN i nóiméid. |
**Iarr Sampla Ualach Pá:**
_CÓD_BLOCK_5__
Seoltar cárta teachtaireachta idirghníomhach ina bhfuil iliomad sleamhnáin (cártaí) ar féidir leis an úsáideoir dul tríd.
Paraiméadair Bhreise:
| Paraiméadar | Cineál | Ag Teastáil | Cur Síos |
|---|---|---|---|
txt |
teaghrán | Tá | Teideal téacs an timpealláin. |
carousel[N].title |
teaghrán | Tá | Teideal an chárta N (ag tosú ag 0). |
carousel[N].image_url |
teaghrán | Tá | URL íomhá poiblí HTTPS den chárta N. |
carousel[N].primary_label |
teaghrán | Tá | Teideal an phríomhchnaipe den chárta N. |
carousel[N].primary_url |
teaghrán | Tá | Nasc príomhchnaipe URL an chárta N. |
carousel[N].secondary_label |
teaghrán | Níl | Fotheideal cnaipe tánaisteach den chárta N. |
carousel[N].secondary_url |
teaghrán | Níl | Nasc cnaipe tánaisteach URL an chárta N. |
Iarr Sampla Ualach Pá: _CÓD_BLOCK_6__
Seoltar teachtaireacht ina bhfuil vótaíocht idirghníomhach nó ceist suirbhé.
Paraiméadair Bhreise:
| Paraiméadar | Cineál | Ag Teastáil | Cur Síos |
|---|---|---|---|
txt |
teaghrán | Tá | Téacs ceiste suirbhé. |
suirbhé_roghanna[N] |
teaghrán | Tá | Téacs rogha suirbhé le haghaidh mír N (innéacs ag tosú ag 0). Tá 2 rogha ar a laghad ag teastáil. |
cineál_rogha |
slánuimhir | Tá | Cineál roghnóir: 1 (RadioButtons) nó 2 (Cnaipí rialta). |
Iarr Sampla Ualach Pá: _CÓD_BLOCK_7__
Formáid Freagartha
Tugann críochphointe comhoiriúnachta Messagio API freagraí ar ais i formáid XML le cód stádais HTTP 200 OK.
Freagra Glactha (D'éirigh leis).
_CÓD_BLOCK_8__
Freagraí Earráide
Má theipeann ar bhailíochtú paraiméadair iarratais nó má theipeann ar fhíordheimhniú, seolfaidh an freagra cód neamh-nialais.
_CÓD_BLOCK_9__
_CÓD_BLOCK_10__
aisghlaonna
Ní mór URLanna aisghlao a chur i bhfeidhm agus a óstáil ar d'ardán. Seolann SMSBAT aisghlaonna HTTP chun do chóras a nuashonrú maidir le himeachtaí seachadta, freagraí suirbhéanna agus freagraí úsáideoirí.
1. Aisghlao ar Stádas Seachadta
Seolta nuair a aistríonn teachtaireacht stádas (seachadadh, léite, theip).
- Cineál Ábhar:
iarratas/x-www-form-urlencoded - Modh:
POST
Iarr formáidí pálasta:
- Seachadta: _CÓD_BLOCK_11__
- Le feiceáil/Léamh: _CÓD_BLOCK_12__
- Neamhsheachadta / Theip: _CÓD_BLOCK_13__
Cur síos ar na Réimsí:
msg_id: Aitheantas uathúil teachtaireachta SMSBAT (GUID) curtha ar ais sa fhreagra SendMessage.stádas: Toradh seachadta (seachadta,neamhsheachadta, nóstádas anaithnid).cineál: Socraithe gofeicthenuair a bheidh an teachtaireacht feicthe ag an bhfaighteoir.status_extended: Cúis theicniúil shonrach le stádas neamhsheachadta (m.sh.VIBER_EXPIRED,VIBER_BLOCKED_BY_USER,VIBER_USER_NOT_FOUND,VIBER_NO_DEVICE).
2. Freagra an tSuirbhé Aisghlao
Spreagtha nuair a roghnaíonn úsáideoir rogha freagartha i dteachtaireacht Suirbhé Viber.
- Cineál Ábhar:
iarratas/x-www-form-urlencoded - Modh:
POST
Iarr Formáid Ualach Pá: _CÓD_BLOCK_14__
3. Aisghlao Teachtaireacht Úsáideora Isteach
Spreagtar seo nuair a sheolann úsáideoir freagra téacs nó meán ar ais chuig do sheirbhís Viber Business.
- Cineál Ábhar:
iarratas/json - Modh:
POST
Iarr Formáid Ualach Pá: _CÓD_BLOCK_15__
Cur síos ar na Réimsí:
msg_id: Aitheantas uathúil na teachtaireachta a gineadh don fhreagra isteach.text: Ábhar téacs a sheol an t-úsáideoir (is féidir é a bheith marnullmá sheol siad meáin amháin).media: URL díreach chun aon iatáin meán a sheol an t-úsáideoir a íoslódáil (is féidir é a bheith marnullmás téacs amháin é).fón: Uimhir theileafóin an tseoltóra i bhformáid idirnáisiúnta.sender_bm_id: Aitheantas an tseoltóra Viber Business.