च्याट र सन्देशहरू
ChatHub वार्तालाप मेटाडेटा ल्याउन, स्थितिहरू प्रबन्ध गर्न, र ऐतिहासिक सन्देश चेनहरूको समीक्षा गर्न API विधिहरू।
URL: https://chatapi.smsbat.com
१. सबै च्याटहरू प्राप्त गर्नुहोस्
डायनामिक फिल्टरिङ र पृष्ठांकनको साथ च्याटहरूको सूची ल्याउनुहोस्।
अनुरोध
- विधि: प्राप्त गर्नुहोस्
- URL: /api/chat/chats
- प्राधिकरण: वाहक टोकन (आवश्यक)
क्वेरी प्यारामिटरहरू
| प्यारामिटर | प्रकार | विवरण |
|---|---|---|
पृष्ठ |
पूर्णांक |
पृष्ठ नम्बर। पूर्वनिर्धारित: 1 |
प्रति_पृष्ठ |
पूर्णांक |
प्रति पृष्ठ वस्तुहरू। पूर्वनिर्धारित: २० |
खोज |
स्ट्रिङ |
पाठ खोज (जस्तै, नाम, फोन) |
| 'स्रोत' | पूर्णांक |
च्याट स्रोत एनम (जस्तै भाइबर बटको लागि १, टेलिग्रामको लागि २) |
मिति |
मितिसमय |
दुई मितिहरू बीच च्याटहरू ल्याउँछ (URL मा दुई समान प्यारामिटर कुञ्जीहरू आवश्यक छ)। उदाहरण: ?date=2026-01-28&date=2026-01-29 |
tg_user_id |
पूर्णांक |
टेलिग्राम प्रयोगकर्ता आईडी |
फोन |
स्ट्रिङ |
फोन नम्बर |
| 'स्थिति' | पूर्णांक |
0 = नयाँ, 1 = खुला, 2 = प्रतीक्षा गर्दै, 3 = अनपज, 4 = बन्द |
OrganizationId |
पूर्णांक |
संगठन द्वारा संकीर्ण |
operatorId |
पूर्णांक |
तोकिएको अपरेटर द्वारा संकीर्ण |
प्रतिक्रिया (२०० ठीक छ)
{
"total": 124,
"items": [
{
"id": 123,
"theme": "Support Ticket #491",
"operator": {
"id": 21,
"name": "Jane",
"photo": "url_to_photo.png"
},
"chatStatus": 1,
"countUnread": 3
}
]
}
२. च्याट स्थिति परिवर्तन गर्नुहोस्
विशेष च्याट सत्रको तोकिएको स्थिति अद्यावधिक गर्दछ।
अनुरोध
- विधि: राख्नुहोस्
- URL: /api/chat/status
- अधिकार: वाहक टोकन
- हेडर: सामग्री-प्रकार: application/json
शरीर:
स्टेटस एनम मानहरू:
- ०: नयाँ (नयाँ उत्पन्न)
- 1: खोल्नुहोस् (सक्रिय रूपमा अपरेटरद्वारा ह्यान्डल गरिएको)
- २: पर्खिँदै (प्रयोगकर्ताको जवाफ पर्खँदै)
- ३: अनपज (पज गरिएको अवस्था)
- 4: बन्द (संग्रहित)
३. च्याट मेटाउनुहोस्
आफ्नो अद्वितीय ID मार्फत च्याट स्थायी रूपमा मेटाउँछ।
अनुरोध
- विधि: मेटाउनुहोस्
- URL: /api/chat/chats/{id}
- अधिकार: वाहक टोकन
प्रतिक्रिया (२०० ठीक छ)
सफलतापूर्वक मेटिएको पुष्टि गर्न HTTP 200 फर्काउँछ। शरीर सामान्यतया खाली वा कडा रूपमा "ठीक छ" छ।
४. च्याट सन्देशहरू पुन: प्राप्त गर्नुहोस्
एक विशेष च्याट भित्र ऐतिहासिक रूपमा पठाइएका र प्राप्त गरिएका सबै सन्देशहरू डम्प गर्दछ।
अनुरोध
- विधि: प्राप्त गर्नुहोस्
- URL: /api/chat/chats/{chatId}/messages
- अधिकार: वाहक टोकन
प्रतिक्रिया (२०० ठीक छ)
[
{
"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
}
]
०: अपरेटर
- 1: ग्राहक
- २: प्रणाली बट
- 3: भाइबर व्यापार खाता
सन्देशका प्रकारहरू:
- ०: पाठ
- 1: फोटो
- 2: फाइल
५. सन्देशको स्थिति अपडेट गर्नुहोस्
नयाँ डेलिभरी स्थितिहरूसँग सक्रिय च्याट भित्र सन्देश (वा धेरै सन्देशहरू) चिन्ह लगाउँछ।
अनुरोध
- विधि: राख्नुहोस्
- URL: /api/chat/messages/status
- अधिकार: वाहक टोकन
- हेडर: सामग्री-प्रकार: application/json
शरीर:
(स्थिति३ ले पठाइएको सन्देश आईडीहरूलाई "पढ्नुहोस्" भनी चिन्ह लगाउँदछ)