Chomhrá agus Teachtaireacht
Modhanna API chun meiteashonraí comhrá ChatHub a fháil, stádas a bhainistiú, agus slabhraí teachtaireachta stairiúla a athbhreithniú.
URL: https://chatapi.smsbat.com
1. Faigh Gach Comhrá
Faigh liosta de na comhráite le scagadh dinimiciúil agus uimhriú.
Iarratas
- Modh: FAIGH
- URL: /api/comhrá/comhrá
- Údarú: Bearer Token (Riachtanach)
Paraiméadair Iarratas
| Paraiméadar | Cineál | Cur Síos |
|---|---|---|
leathanach |
slánuimhir |
Uimhir an leathanaigh. Réamhshocrú: 1 |
in aghaidh_leathanach |
slánuimhir |
Míreanna in aghaidh an leathanaigh. Réamhshocrú: 20 |
cuardach |
teaghrán |
Cuardach téacs (m.sh., ainm, guthán) |
foinse |
slánuimhir |
Foinse Comhrá Enum (m.sh. 1 le haghaidh Viber Bot, 2 le haghaidh Telegram) |
dáta |
dáta |
Fetches comhráite idir dhá dháta (tá dhá eochair pharaiméadar comhionann san URL). Mar shampla: ?date=2026-01-28&date=2026-01-29 |
tg_úsáideoir_id |
slánuimhir |
Aitheantas Úsáideora Telegram |
fón |
teaghrán |
Uimhir Theileafóin |
stádas |
slánuimhir |
0 = Nua, 1 = Oscailte, 2 = Ag feitheamh, 3 = Ar Sos, 4 = Dúnta |
eagraíochtId |
slánuimhir |
Caol le heagraíocht |
operatorId |
slánuimhir |
Caol le hoibreoir sannta |
Freagra (200 ceart go leor) _CÓD_BLOCK_0__
2. Athraigh Stádas Comhrá
Nuashonraítear stádas sannta seisiún comhrá ar leith.
Iarratas
- Modh: A CHUR
- URL: /api/comhrá/stádas
- Údarú: Bearer Token
- Ceanntásca: Cineál Ábhar: iarratas/json
Comhlacht: _CÓD_BLOCK_1__
Stádas Luachanna Enum:
- 0: Nua (Nua-ghinte)
- 1: Oscailte (Láimhseáil go gníomhach ag an oibreoir)
- 2: Ag feitheamh (Ag feitheamh le freagra úsáideora)
- 3: OnPause (Staid ar sos)
- 4: Dúnta (Cartlannaithe)
3. Scrios Comhrá
Scriosann sé comhrá go buan trína aitheantas uathúil.
Iarratas
- Modh: Scrios
- URL: /api/chat/chats/{id}
- Údarú: Bearer Token
Freagra (200 ceart go leor)
Filleann sé HTTP 200 chun scriosadh rathúil a dhearbhú. Is gnách go mbíonn an corp folamh nó go docht "OK".
4. Aisghabh Teachtaireachtaí Comhrá
Dumpálann sé gach teachtaireacht a seoladh agus a fuarthas go stairiúil laistigh de chomhrá ar leith.
Iarratas
- Modh: FAIGH
- URL: /api/chat/chats/{chatId}/messages
- Údarú: Bearer Token
Freagra (200 ceart go leor)
_CÓD_BLOCK_2__
Údair:
- 0: Oibreoir
- 1: Cliant
- 2: Bot an Chórais
- 3: Cuntas Gnó Viber
Cineálacha na dTeachtaireachtaí:
- 0: Téacs
- 1: Grianghraf
- 2: Comhad
5. Nuashonraigh Stádas na dTeachtaireachtaí
Marcáil teachtaireacht (nó ilteachtaireachtaí) taobh istigh de chomhrá gníomhach le stádas seachadta nua.
Iarratas
- Modh: A CHUR
- URL: /api/comhrá/teachtaireachtaí/stádas
- Údarú: Bearer Token
- Ceanntásca: Cineál Ábhar: iarratas/json
Comhlacht:
_CÓD_BLOCK_3__
(Marcanna Stádas 3 IDanna na dteachtaireachtaí seolta mar "Léigh")