Mga Chat at Mensahe
Mga pamamaraan ng API para sa pagkuha ng metadata ng pag-uusap sa ChatHub, pamamahala ng mga status, at pagsusuri sa mga makasaysayang chain ng mensahe.
URL: https://chatapi.smsbat.com
1. Kunin ang Lahat ng Chat
Kumuha ng listahan ng mga chat na may dynamic na pag-filter at pagination.
Kahilingan
- Paraan: GET
- URL:
/api/chat/chats - Awtorisasyon:
Bearer Token(Kinakailangan)
Mga Parameter ng Query
| Parameter | Uri | Paglalarawan |
|---|---|---|
pahina | integer | Numero ng pahina. Default: 1 |
bawat_pahina | integer | Mga item bawat pahina. Default: 20 |
paghahanap | string | Paghahanap ng teksto (hal., pangalan, telepono) |
pinagmulan | integer | Chat Source Enum (hal. 1 para sa Viber Bot, 2 para sa Telegram) |
petsa | datetime | Kinukuha ang mga chat sa pagitan ng dalawang petsa (nangangailangan ng dalawang magkaparehong parameter key sa URL). Hal: ?date=2026-01-28&date=2026-01-29 |
tg_user_id | integer | Telegram User ID |
telepono | string | Numero ng Telepono |
status | integer | 0 = Bago, 1 = Bukas, 2 = Naghihintay, 3 = OnPause, 4 = Sarado |
organizationId | integer | Makitid ayon sa organisasyon |
operatorId | integer | Pakitid ng itinalagang operator |
Tugon (200 OK)
{
"total": 124,
"items": [
{
"id": 123,
"theme": "Support Ticket #491",
"operator": {
"id": 21,
"name": "Jane",
"photo": "url_to_photo.png"
},
"chatStatus": 1,
"countUnread": 3
}
]
}
2. Baguhin ang Katayuan ng Chat
Ina-update ang nakatalagang status ng isang partikular na session ng chat.
Kahilingan
- Paraan: PUT
- URL:
/api/chat/status - Awtorisasyon:
Bearer Token - Mga Header:
Uri ng Nilalaman: application/json
Katawan:
{
"id": 123,
"status": 1
}
Mga Value ng Status Enum:
0: Bago (Bagong nabuo)1: Bukas (Aktibong pinangangasiwaan ng operator)2: Naghihintay (Naghihintay ng tugon ng user)3: OnPause (Naka-pause na estado)4: Sarado (Naka-archive)
3. Magtanggal ng Chat
Permanenteng tinatanggal ang isang chat sa pamamagitan ng natatanging ID nito.
Kahilingan
- Paraan: I-DELETE
- URL:
/api/chat/chats/{id} - Awtorisasyon:
Bearer Token
Tugon (200 OK)
Nagbabalik ng HTTP 200 upang kumpirmahin ang matagumpay na pagtanggal. Karaniwang walang laman ang katawan o mahigpit na "OK".
4. Kunin ang Mga Mensahe sa Chat
Itinatapon ang lahat ng mga mensaheng dating ipinadala at natanggap sa loob ng isang partikular na chat.
Kahilingan
- Paraan: GET
- URL:
/api/chat/chats/{chatId}/messages - Awtorisasyon:
Bearer Token
Tugon (200 OK)
[
{
"id": 1,
"chatId": 123,
"message": "Hello, how can I help?",
"phone": "380936670003",
"author": 0,
"status": 3,
"date": "2025-04-01T09:46:24.687Z",
"operator": {
"id": 21,
"name": "Jane"
},
"messageType": 0
}
]
Mga May-akda:
0: Operator1: Kliyente2: System Bot3: Viber Business Account
Mga Uri ng Mensahe:
0: Teksto1: Larawan2: File
5. I-update ang Katayuan ng Mga Mensahe
Minamarkahan ang isang mensahe (o maraming mensahe) sa loob ng isang aktibong chat na may mga bagong katayuan sa paghahatid.
Kahilingan
- Paraan: PUT
- URL:
/api/chat/messages/status - Awtorisasyon:
Bearer Token - Mga Header:
Uri ng Nilalaman: application/json
Katawan:
{
"status": 3,
"messageIds": [1, 2, 3]
}
(Ang katayuan 3 ay nagmamarka sa mga ipinadalang ID ng mensahe bilang “Basahin”)