अपरेटर प्राधिकरण र गहिरो लिङ्कहरू
यस गाइडले एपीआई मार्फत प्रणालीमा अपरेटरहरूको लागि वैध प्रमाणीकरण टोकन कसरी प्राप्त गर्ने र च्याट प्यानलमा नेभिगेट गर्न गहिरो लिङ्कहरू कसरी प्रयोग गर्ने भनेर वर्णन गर्दछ।
API आधार URL: https://chatapi.smsbat.com/
स्वैगर: https://chatapi.smsbat.com/index.html
नोट: तपाईले कम्पनी-स्तर अनुरोधहरूको लागि
Bearerप्राधिकरणको सट्टा आफ्नो टोकन (ड्यासबोर्डमा तपाइँको प्रोफाइलमा उपलब्ध) को साथX-Authorization-Keyहेडर प्रयोग गर्न सक्नुहुन्छ।
१. कम्पनी टोकन प्राप्त गर्नुहोस्
कम्पनी टोकन प्राप्त गर्नको लागि, कम्पनीको लगइन प्रमाणहरू सहित /api/company/get-token मा HTTP POST अनुरोध पठाउनुहोस्।
अनुरोध
- विधि: पोस्ट
- URL:
https://chatapi.smsbat.com/api/company/get-token - हेडर:
सामग्री-प्रकार: application/json
शरीर:
{
"login": "string",
"password": "string"
}
प्रतिक्रिया
- स्थिति कोड: २०० (ठीक छ)
- मुख्य भाग: स्ट्रिङ टोकन (
"your_token_string")
नोट: पछिका अनुरोधहरूको लागि प्राप्त टोकन बचत गर्नुहोस्।
२. संगठन सूची पुन: प्राप्त गर्नुहोस्
तपाइँको संगठनहरू सूचीबद्ध गर्न कम्पनी टोकन प्रयोग गरेर /api/company/organization मा GET अनुरोध पठाउनुहोस्।
अनुरोध
- विधि: प्राप्त गर्नुहोस्
- URL:
https://chatapi.smsbat.com/api/company/organization - हेडर:
प्राधिकरण: वाहक {टोकन}- ‘स्वीकार गर्नुहोस्: पाठ/सादा’
प्रतिक्रिया
- स्थिति कोड: २०० (ठीक छ)
- शरीर:
[
{
"id": 6,
"name": "string"
}
]
३. संगठनद्वारा अपरेटरहरू पुनःप्राप्त गर्नुहोस्
organizationId प्यारामिटर प्रयोग गरेर /api/operator मा GET अनुरोध पठाउनुहोस्।
अनुरोध
- विधि: प्राप्त गर्नुहोस्
- URL:
https://chatapi.smsbat.com/api/operator?organizationId={id} - हेडर:
प्राधिकरण: वाहक {टोकन}- ‘स्वीकार गर्नुहोस्: पाठ/सादा’
प्रतिक्रिया
- स्थिति कोड: २०० (ठीक छ)
- शरीर:
[
{
"id": 21,
"name": "string",
"status": 1,
"organization": {
"id": 24,
"name": "test_costs"
}
}
]
४. प्रणालीमा अपरेटरहरू थप्नुहोस्
यो अन्तिम बिन्दु पहुँच गर्न र प्रणालीमा अपरेटरहरू सिङ्क्रोनाइज गर्न कम्पनी टोकन प्रयोग गर्नुहोस्।
अनुरोध
- विधि: पोस्ट
- URL:
https://chatapi.smsbat.com/api/operator/synchronize - हेडर:
प्राधिकरण: वाहक {टोकन}- ‘सामग्री-प्रकार: application/json’
शरीर:
[
{
"organizationId": 24,
"name": "string"
}
]
प्रतिक्रिया
- स्थिति कोड: २०० (ठीक छ)
- शरीर:
[
{
"id": 21,
"status": 0,
"name": "string"
}
]
सम्भावित अपरेटर स्थितिहरू:
- सक्रिय:
० - निष्क्रिय:
1 - मेटाइयो:
2
५. अपरेटर टोकन प्राप्त गर्नुहोस्
एक विशिष्ट अपरेटरको लागि टोकन प्राप्त गर्न कम्पनी टोकनसँग अधिकृत गर्नुहोस्।
अनुरोध
- विधि: पोस्ट
- URL:
https://chatapi.smsbat.com/api/operator/get-token - हेडर:
प्राधिकरण: वाहक {टोकन}- ‘सामग्री-प्रकार: application/json’
शरीर:
{
"id": 0,
"expiresAt": "2025-01-20T14:33:34.147Z"
}
expiresAt आवश्यक छ र अपरेटरको सत्र अवधि निर्धारण गर्दछ (अधिकतम +२४ घण्टा)।
प्रतिक्रिया
- स्थिति कोड: २०० (ठीक छ)
- मुख्य भाग: स्ट्रिङ टोकन
६. अपरेटर टोकन मान्य गर्नुहोस्
अपरेटरको टोकनको वैधता प्रमाणित गर्नुहोस्।
अनुरोध
- विधि: पोस्ट
- URL:
https://chatapi.smsbat.com/api/operator/validate-token - हेडर:
प्राधिकरण: वाहक {टोकन}- ‘सामग्री-प्रकार: application/json’
मुख्य भाग: "operator_token_string"
वैध प्रतिक्रिया (२०० ठीक):
{
"isValid": true,
"operatorId": 0,
"clientId": 0,
"expiresAt": "2024-12-28T14:04:15.861Z",
"error": null
}
७. अपरेटर च्याट प्यानलमा गहिरो लिङ्किङ
बाह्य प्रणालीहरू (CRM, ERP, आन्तरिक वेबसाइटहरू) ले प्यारामिटरको रूपमा JWT अपरेटर टोकन पास गरेर गहिरो लिङ्कहरूको लाभ उठाउँदै च्याट प्यानल खोल्न सक्छ। यदि टोकन अमान्य छ वा म्याद सकिएको छ भने, प्रयोगकर्तालाई लगइन इन्टरफेसमा रिडिरेक्ट गरिनेछ।
ढाँचा १: च्याट ID द्वारा
https://chat.smsbat.com/?chat_raw_id=<chat_id>&token=<jwt_token>
ढाँचा २: फोन नम्बर द्वारा
https://chat.smsbat.com/?phone=<phone_number>&token=<jwt_token>
फोन नम्बर E.164 अन्तर्राष्ट्रिय ढाँचामा हुनुपर्छ।
ढाँचा 3: अल्फा नाम र फोन द्वारा
https://chat.smsbat.com/?from=<bm_id>&phone=<phone_number>&token=<jwt_token>
ढाँचा ४: पूरा लक्ष्य विवरणहरू
ठ्याक्कै कुन स्रोतबाट सन्देशहरू अवरोध गर्ने निर्दिष्ट गर्नुहोस्:
https://chat.smsbat.com/?source=<sourceId>&from=<bm_id>&phone=<phone_number>&token=<jwt_token>
च्याट स्रोतहरू:
०- भाइबर1- ViberBot2- TelegramBot3- व्हाट्सएप4- विजेट5- रोजेत्का6- फेसबुक7- इन्स्टाग्राम