कस्टम इंटिग्रेशन और चैनलों के लिए ग्राहक सहायता API
Deskwoot की कस्टमर सपोर्ट API बातचीत, कॉन्टैक्ट, मैसेज, एजेंट, labels और custom attributes कवर करती है। Shared inbox के ऊपर कस्टम चैनल, ऐप के अंदर चैट या अलर्ट रूटिंग बनाएँ।
अवलोकन
कई helpdesk API को बाद की बात मानते हैं और वही endpoints छोड़ देते हैं जिनकी आपको ज़रूरत है। Deskwoot की कस्टमर सपोर्ट API, Enterprise प्लान के साथ आती है और बातचीत, मैसेज, कॉन्टैक्ट, inbox, labels, टीम, webhooks और बहुत कुछ कवर करती है, OpenAPI spec में दस्तावेज़ के साथ।
REST और webhooks: बातचीत, कॉन्टैक्ट, मैसेज, labels, टीम, custom attributes और बहुत कुछ REST से मिलता है। Webhooks बातचीत बनने, असाइन होने या सुलझने, नए मैसेज, कॉन्टैक्ट बदलाव और CSAT रेटिंग जैसे इवेंट आपके secret से साइन करके आपके URL पर भेजते हैं, ताकि आपका कोड बार बार पूछने की जगह इवेंट पर काम करे। टिकट चालू हों तो टिकट इवेंट भी वहाँ जा सकते हैं।
ऑथेंटिकेशन: scopes वाले API टोकन। हर इंटीग्रेशन को सिर्फ़ उतना दें जितना उसे चाहिए, जैसे सिर्फ़ पढ़ने का एक्सेस, या वह अलग scope जो ग्राहकों के मैसेज API inbox में डाल सकता है।
कस्टम चैनल: एक REST API inbox बनाएँ, हर मैसेज पर अपनी ID के साथ ग्राहकों के मैसेज उसमें भेजें, और एक callback URL सेट करें। दोबारा भेजी गई request कभी डुप्लिकेट नहीं बनाती, और एजेंट और Fynn के जवाब आपके callback URL पर जाते हैं, इसलिए आपके ऐप के अंदर की चैट या कोई भी ऐसा चैनल जो पहले से नहीं है, बाकी चैनलों की तरह काम करता है।
आम पैटर्न: 1) मोबाइल ऐप के अंदर चैट, जहाँ आपका बैकएंड मैसेज API inbox में भेजता है, 2) आपकी साइट का कॉन्टैक्ट फ़ॉर्म जो API से बातचीत खोलता है, 3) डिवाइस या सिस्टम अलर्ट जो बातचीत के रूप में inbox में आते हैं, 4) कॉन्टैक्ट और बातचीत का डेटा अपने सिस्टम के साथ सिंक करना।
API सहायता के साथ आपको क्या मिलता है
REST और webhooks
बातचीत, कॉन्टैक्ट और मैसेज पढ़ें और लिखें, और इवेंट के लिए webhooks पाएँ।
सुरक्षित retries
हर inbound मैसेज में आपकी अपनी ID होती है, इसलिए दोबारा भेजी गई request कभी डुप्लिकेट नहीं बनाती।
Scopes वाले API टोकन
हर टोकन को सिर्फ़ वही scopes मिलते हैं जो इंटीग्रेशन को चाहिए।
OpenAPI spec
पूरा reference /docs/api पर है, Postman, Insomnia या आपके अपने client generator के लिए OpenAPI फ़ाइल के साथ।
जवाबों के लिए callbacks
API inbox पर callback URL सेट करें, और एजेंट और Fynn के जवाब आपके सिस्टम पर भेजे जाते हैं।
शुरुआत कैसे करें
API को 3 चरणों में जोड़ें।
- Enterprise प्लान पर Settings → API Tokens में एक API टोकन बनाएँ।
- एक REST API inbox बनाएँ और ग्राहकों के मैसेज उसके inbound endpoint पर भेजें।
- जवाब पाने के लिए callback URL सेट करें।
