GMS Compatibility
Comhoiriúnacht # GMS API
Tacaíonn SMSBAT le ciseal comhoiriúnachta leis an GMS API. Ligeann sé seo duit do chuid comhtháthaithe reatha atá deartha le haghaidh GMS a aistriú go díreach chuig SMSBAT gan a bheith ort do scéimre ródaithe teachtaireachta, struchtúir pálasta nó éisteoirí glaonna ar ais a mhodhnú.
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/GMSMessage/send_message - Formáid Iarratais:
iarratas/json - Fíordheimhniú: Fíordheimhniú Bunúsach HTTP (úsáideann sé do dhintiúir API SMSBAT)
Paraiméadair Iarratas
Glacann an API Comhoiriúnachta GMS le réad JSON a bhfuil na paraiméadair barrleibhéil seo a leanas aige:
| Paraiméadar | Cineál | Ag Teastáil | Cur Síos |
|---|---|---|---|
uimhir_ghutháin |
teaghrán | Tá | Uimhir theileafóin an fhaighteora i bhformáid idirnáisiúnta (m.sh., 380501234567). |
clib |
teaghrán | Tá | Ainm seoltóir cláraithe / ainm alfa. |
cainéil |
eagar | Tá | Liosta cainéal le triail a bhaint as, in ord tosaíochta. Luachanna tacaithe: viber, sms, brú. E.g., ["viber", "sms"]. |
channel_options |
réad | Tá | Léarscáil ina bhfuil roghanna do gach cainéal gníomhach (féach thíos). |
bhreise_id |
teaghrán | Níl | Aitheantas inmheánach do theachtaireachtaí ar thaobh an chustaiméara. |
callback_url |
teaghrán | Níl | URL críochphointe ar do chóras chun aisghlaonna stádas seachadta a fháil. |
rannóg_chód |
teaghrán | Níl | Aitheantóir cód roinnte roghnach (réamhshocraithe go dtí an príomh). |
Socruithe Roghanna Cainéal
Tá cumraíochtaí a bhaineann go sonrach leis an gcainéal san oibiacht channel_options.
Úsáidtear é nuair a liostaítear viber san eagar cainéal.
| Paraiméadar | Cineál | Ag Teastáil | Cur Síos |
|---|---|---|---|
téacs |
teaghrán | Tá | Teachtaireacht comhlacht téacs. |
ttl |
slánuimhir | Tá | Am-Chun Beo i soicindí. |
img |
teaghrán | Níl | URL poiblí HTTPS na híomhá le taispeáint. |
ceannteideal |
teaghrán | Níl | Lipéad téacs cnaipe. |
gníomh |
teaghrán | Níl | URL an chinn scríbe nuair a chliceáiltear an cnaipe. |
suirbhé_roghanna |
eagar | Níl | Sraith teaghráin (2 go 5 mhír) le taispeáint mar roghanna suirbhé. |
carousel_items |
eagar | Níl | Sraith de rudaí sleamhnáin le taispeáint mar timpeallán Viber (féach an struchtúr sa chluaisín). |
Sampla Iarratas Viber: _CÓD_BLOCK_0__
Cumasaíonn sé teachtaireachtaí Viber le cúltaca uathoibríoch SMS má theipeann ar sheachadadh Viber laistigh den TTL.
** Sampla d'Iarratas Tilleadh:** _CÓD_BLOCK_1__
Úsáidtear é nuair a liostaítear sms san eagar cainéal.
| Paraiméadar | Cineál | Ag Teastáil | Cur Síos |
|---|---|---|---|
téacs |
teaghrán | Tá | Teachtaireacht comhlacht téacs. |
alfa_ainm |
teaghrán | Tá | Ainm alfa an tseoltóra. |
ttl |
slánuimhir | Tá | Am-Chun Beo i soicindí. |
ctr |
Boole | Níl | Cumasaigh rianú cliceáil CTR ar naisc sa téacs (fíor/bréagach). |
** Sampla Iarratas SMS:** _CÓD_BLOCK_2__
Úsáidtear é chun pobalbhreith agus suirbhéanna Viber a chruthú.
Rabhadh
Caithfidh idir 2 agus 5 rogha a bheith laistigh de suirbhé_roghanna cumraíocht suirbhé Viber.
Sampla Iarratas Suirbhé: _CÓD_BLOCK_3__
Úsáidte chun cártaí sleamhnáin íomhánna swipeable a sheoladh. Tacaíonn gach sleamhnán íomhá, teideal, agus cnaipí.
** Sampla d'Iarratas Timpealláin:** _CÓD_BLOCK_4__
Úsáidtear é nuair a liostaítear brú san eagar cainéal.
| Paraiméadar | Cineál | Ag Teastáil | Cur Síos |
|---|---|---|---|
teideal |
teaghrán | Tá | Teideal téacs an fhógra bhrú. |
téacs |
teaghrán | Tá | Teachtaireacht comhlacht téacs. |
ttl |
slánuimhir | Tá | Am-Chun Beo i soicindí. |
img |
teaghrán | Níl | URL poiblí HTTPS na híomhá le taispeáint. |
ceannteideal |
teaghrán | Níl | Lipéad téacs cnaipe. |
gníomh |
teaghrán | Níl | URL an chinn scríbe nuair a chliceáiltear an cnaipe. |
ctr |
Boole | Níl | Cumasaigh rianú cliceáil. |
** Brúigh Sampla Iarratas:** _CÓD_BLOCK_5__
Formáid Freagartha
Tugann an críochphointe freagraí ar ais i formáid JSON le cód stádais HTTP 200 OK.
Freagra Rathúil
_CÓD_BLOCK_6__
Freagraí Earráide
Má theipeann ar bhailíochtú nó ar phróiseáil, seolfar freagra earráide ar ais le ErrorCode neamh-null agus ErrorText mionsonraithe.
_CÓD_BLOCK_7__
_CÓD_BLOCK_8__
_CÓD_BLOCK_9__
_CÓD_BLOCK_10__
Formáid Seachadta Aisghlao
Má sonraíodh callback_url san iarratas, seolann SMSBAT nuashonruithe stádais seachadta mar phálasta JSON POST chuig do chríochphointe.
Sampla Iarratas Aisghlao
_CÓD_BLOCK_11__
Cur Síos ar Réimsí Glaoite
| Réimse | Cineál | Cur Síos |
|---|---|---|
uimhir |
teaghrán | Uimhir theileafóin an fhaighteora. |
am |
uimhir | Stampa ama imeachta i milleasoicindí Unix. |
stádas |
uimhir | Aitheantóir stádais simplithe (féach tábla an chóid stádais). |
fostádas |
uimhir | Aitheantóir stádais mionsonraithe (féach tábla cód an fhostáisiúin). |
hiber_status |
uimhir | Cód stádais inmheánach mionsonraithe SMSBAT (féach tábla Stádas Hyber). |
teachtaireacht_id |
teaghrán | Aitheantas teachtaireachta SMSBAT (GUID) ginte nuair a seoladh é. |
bhreise_id |
teaghrán | Aitheantas taobh an chustaiméara curtha ar fáil san iarratas bunaidh. |
seolta_via |
teaghrán | Cainéal a phróiseáil an teachtaireacht: viber, sms, nó rcs. |
meaitseáil_teimpléad_id |
uimhir | Stádas meaitseála teimpléid Viber (má bhaineann). |
Léarscáileanna Stádais
1. Stádas Simplithe (status)
| Cód | Brí |
|---|---|
1 |
Teachtaireacht glactha nó á seachadadh. |
2 |
Seachadadh an teachtaireacht. |
3 |
Earráid phróiseála nó seachadta. |
2. Stádas Mionsonraithe (substatus)
| Cód | Brí |
|---|---|
12 |
Glactar le próiseáil. |
23 |
Seachadadh. |
24 |
Le feiceáil/léamh. |
35 |
Gan a sheachadadh laistigh de TTL (In éag). |
36 |
Earráid seachadta. |
3. Cineál Cainéal (sent_via)
| Cainéal | Cur Síos |
|---|---|
viber |
Stádas arna dtáirgeadh ag Viber cainéal. |
sms |
Stádas arna dtáirgeadh ag cainéal SMS. |
rcs |
Stádas arna tháirgeadh ag cainéal RCS. |
4. Stádas mionsonraithe SMSBAT (hyber_status)
| Cód | Cainéal | Stádas | Fostádas | Brí |
|---|---|---|---|---|
| 23033 | viber |
2 |
23 |
Seachadadh teachtaireacht viber. |
| 24013 | viber |
2 |
24 |
Teachtaireacht Viber léite ag faighteoir (Feicthe). |
| 36013 | viber |
3 |
36 |
Viber earráid inmheánach. |
| 36023 | viber |
3 |
36 |
ID seirbhíse Viber neamhbhailí nó gan a bheith ar fáil. |
| 36033 | viber |
3 |
36 |
Sonraí neamhbhailí pálasta Viber. |
| 36037 | viber |
3 |
36 |
URL íomhá Viber ró-fhada. |
| 36038 | viber |
3 |
36 |
URL íomhá Viber neamhbhailí. |
| 36039 | viber |
3 |
36 |
Viber téacs ró-fhada. |
| 36044 | viber |
3 |
36 |
Téacs Viber saor in aisce. |
| 36053 | viber |
3 |
36 |
Cineál teachtaireachta Viber nach dtacaítear leis. |
| 36063 | viber |
3 |
36 |
Paraiméadair Viber neamhbhailí. |
| 36073 | viber |
3 |
36 |
Teorainn ama soláthraí Viber. |
| 36083 | viber |
3 |
36 |
Seoltóir Viber bac ag an bhfaighteoir. |
| 36093 | viber |
3 |
36 |
Níl faighteoir cláraithe mar úsáideoir Viber. |
| 36103 | viber |
3 |
36 |
Níor aimsíodh aon fheiste Android/iOS le tacaíocht Viber. |
| 36113 | viber |
3 |
36 |
Seoladh IP neamhúdaraithe chun Viber a sheoladh. |
| 36123 | viber |
3 |
36 |
Braitheadh teachtaireacht dhúbailte Viber. |
| 36143 | viber |
3 |
36 |
Earráid billeála viber. |
| 36153 | viber |
3 |
36 |
Teachtaireacht bactha ag liosta dubh ardán. |
| 36163 | viber |
3 |
36 |
Earráid próiseála inmheánach ardán viber. |
| 36173 | viber |
3 |
36 |
Lipéad Viber mícheart nó in easnamh. |
| 36183 | viber |
3 |
36 |
Luach neamhbhailí Viber TTL. |
| 12011 | sms / rcs |
1 |
12 |
Glacadh le SMS/RCS. |
| 36011 | sms / rcs |
1 |
12 |
SMS/RCS isteach. |
| 23011 | sms / rcs |
2 |
23 |
SMS/RCS seachadta. |
| 35015 | sms / rcs |
3 |
35 |
SMS/RCS imithe in éag (nár seachadadh laistigh de TTL). |
| 36021 | sms / rcs |
3 |
36 |
Scriosadh an teachtaireacht SMS/RCS. |
| 36031 | sms / rcs |
3 |
36 |
Ní féidir SMS/RCS a sheachadadh. |
| 36041 | sms / rcs |
3 |
36 |
Stádas seachadta SMS/RCS anaithnid. |
| 36051 | sms / rcs |
3 |
36 |
Teachtaireacht SMS/RCS diúltaithe. |