Skip to content

SMSBAT ChatHub API

ChatHub REST API ले Viber व्यापार च्याटहरू, ग्राहक कुराकानीहरू, र ग्राहक समर्थन स्वचालन कार्यप्रवाहहरू प्रबन्ध गर्दछ।

आधार URL

https://chatapi.smsbat.com

स्वगर कागजात

अन्तरक्रियात्मक API दस्तावेज उपलब्ध छ:

https://chatapi.smsbat.com/index.html

प्रमाणीकरण

ChatHub ले JWT टोकनहरूसँग बेयरर टोकन-आधारित प्रमाणीकरण प्रणाली प्रयोग गर्दछ। टोकनहरू दुई तरिकामा पास गर्न सकिन्छ:

विधि १: प्राधिकरण हेडर

curl -X GET https://chatapi.smsbat.com/api/company/organization \
  -H "Authorization: Bearer your-jwt-token"

विधि २: एक्स-प्राधिकरण-कुञ्जी हेडर

curl -X GET https://chatapi.smsbat.com/api/company/organization \
  -H "X-Authorization-Key: your-jwt-token"

प्रमाणीकरण प्रवाह

ChatHub ले दुई-स्तर टोकन प्रणाली प्रयोग गर्दछ:

  1. कम्पनी टोकन - संगठन-स्तर पहुँच टोकन
  2. अपरेटर टोकन - व्यक्तिगत अपरेटर पहुँच टोकन

कार्यप्रवाह

graph LR
    A[Get Company Token] --> B[List Organizations]
    B --> C[List/Add Operators]
    C --> D[Get Operator Token]
    D --> E[Integrate Widget]

मुख्य अन्तिम बिन्दुहरू

विधि अन्तिम बिन्दु विवरण
पोस्ट /api/company/get-token कम्पनी प्राधिकरण टोकन प्राप्त
प्राप्त गर्नुहोस् /api/company/organization संगठन सूची पुन: प्राप्त गर्नुहोस्
प्राप्त गर्नुहोस् /api/operator संगठन द्वारा सूची अपरेटर
पोस्ट /api/operator/synchronize नयाँ अपरेटरहरू थप्नुहोस्
पोस्ट /api/operator/status अपरेटर स्थिति परिवर्तन
पोस्ट /api/operator/get-token अपरेटर टोकनहरू उत्पन्न गर्नुहोस् (अधिकतम 24 घन्टा समाप्ति)
पोस्ट /api/operator/validate-token टोकन वैधता प्रमाणित गर्नुहोस्

मुख्य विशेषताहरू

कम्पनी टोकन व्यवस्थापन

API पहुँचको लागि संगठन-स्तर टोकनहरू प्राप्त गर्नुहोस् र व्यवस्थापन गर्नुहोस्।

संगठन व्यवस्थापन

  • सबै संगठनहरू सूचीबद्ध गर्नुहोस्
  • संगठन विवरणहरू प्राप्त गर्नुहोस्
  • संगठन सेटिङहरू प्रबन्ध गर्नुहोस्

अपरेटर व्यवस्थापन

  • संगठन द्वारा अपरेटरहरूको सूची
  • नयाँ अपरेटरहरू थप्नुहोस्
  • अपरेटर स्थिति परिवर्तन गर्नुहोस् (सक्रिय/निष्क्रिय/मेटिएको)
  • अपरेटर-विशेष टोकनहरू उत्पन्न गर्नुहोस् (अधिकतम 24 घण्टा)
  • अपरेटर टोकनहरू मान्य गर्नुहोस्

विजेट एकीकरण

वास्तविक-समय ग्राहक समर्थनको लागि वेब अनुप्रयोगहरूमा ChatHub विजेट एकीकृत गर्नुहोस्।

द्रुत सुरुवात

  1. प्रमाणीकरण - आफ्नो कम्पनी र अपरेटर टोकन प्राप्त गर्नुहोस्
  2. संगठनहरू - संगठनहरू प्रबन्ध गर्नुहोस्
  3. अपरेटरहरू - अपरेटरहरू थप्नुहोस् र व्यवस्थापन गर्नुहोस्
  4. विजेट एकीकरण - च्याट विजेट एकीकृत गर्नुहोस्

अनुरोध ढाँचा

सबै अनुरोधहरू JSON ढाँचा प्रयोग गर्नुहोस्:

{
  "login": "your-login",
  "password": "your-password"
}

प्रतिक्रिया ढाँचा

सफल प्रतिक्रियाहरू फिर्ता:

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expiration": "2025-01-24T12:00:00Z"
}

त्रुटि ह्यान्डलिंग

HTTP स्थिति कोडहरू:

  • `२०० ठीक छ' - अनुरोध सफल भयो
  • `400 खराब अनुरोध' - अमान्य अनुरोध ढाँचा
  • ४०१ अनाधिकृत - प्रमाणीकरण असफल भयो
  • `४०३ निषेधित' - अपर्याप्त अनुमतिहरू
  • `404 फेला परेन' - स्रोत फेला परेन
  • ५०० आन्तरिक सर्भर त्रुटि - सर्भर त्रुटि

टोकन म्याद समाप्ति

टोकनको म्याद सकिने समय हुन्छ। जब टोकन म्याद समाप्त हुन्छ:

  1. API ले 401 अनाधिकृत फर्काउनेछ
  2. प्रमाणीकरण अन्त्य बिन्दु प्रयोग गरेर नयाँ टोकन अनुरोध गर्नुहोस्
  3. नयाँ टोकनको साथ आफ्नो आवेदन अद्यावधिक गर्नुहोस्

अर्को चरणहरू