API डॉक्युमेंटेशन दस्तावेज़ीकरण
API डॉक्युमेंटेशन
API डॉक्युमेंटेशन
SparkTG की API, v2 पर जा रही हैं
ये पेज API v1 के बारे में हैं। SparkTG की सभी API, यूज़रनेम-पासवर्ड की जगह साइन किए गए API टोकन के साथ API v2 पर जा रही हैं: जहाँ v2 उपलब्ध है, वहाँ उसी का उपयोग करें।
API v2 पर जानाAPI डॉक्युमेंटेशन
SparkTG क्लाउड टेलीफोनी API रेफरेंस
SparkTG क्लाउड टेलीफोनी API
परिचय
SparkTG एक क्लाउड टेलीफोनी सर्विस प्रोवाइडर है। क्लाउड टेलीफोनी एक ऑन-डिमांड सर्विस है, जो उत्पाद और सेवाएँ देने वाले संगठनों को मज़बूत टेलीफोनी फ़ीचर्स भरोसेमंद ढंग से उपलब्ध कराती है।
नेटवर्क एक्सेस: ये क्षमताएँ नेटवर्क पर उपलब्ध हैं और मानक तरीकों से एक्सेस की जा सकती हैं। उपभोक्ता कहीं से भी लॉगिन करके अपनी सर्विस को कंट्रोल कर सकते हैं।
रिसोर्स पूलिंग: टेलीकॉम रिसोर्सेज़ को मल्टी-टेनेंट मॉडल के ज़रिए कई उपभोक्ताओं की सेवा के लिए पूल किया जाता है, जिसमें अलग-अलग फ़िज़िकल और वर्चुअल रिसोर्सेज़ उपभोक्ता की मांग के अनुसार डायनामिक रूप से असाइन और री-असाइन होते रहते हैं। इससे उपभोक्ता का इन-हाउस टेलीफोनी सर्विस विकसित करने का खर्च घटता है और वे केवल उतने ही रिसोर्स का भुगतान करते हैं जितना वे उपयोग करते हैं।
इलास्टिसिटी: टेलीफोनी पोर्ट्स को तेज़ी से और इलास्टिक तरीके से प्रोविज़न किया जा सकता है, कुछ मामलों में अपने-आप भी, ताकि ज़रूरत पड़ने पर जल्दी स्केल आउट किया जा सके और ज़रूरत न रहने पर जल्दी रिलीज़ करके स्केल इन किया जा सके।
मापी जाने वाली सर्विस: क्लाउड सिस्टम सर्विस के प्रकार के अनुरूप किसी स्तर पर मीटरिंग क्षमता का उपयोग करके रिसोर्स के उपयोग को अपने-आप नियंत्रित और ऑप्टिमाइज़ करता है (जैसे, इनबाउंड कॉल्स की संख्या, आउटबाउंड कॉल्स की संख्या और स्पैम कॉल्स की संख्या)। रिसोर्स के उपयोग की निगरानी, नियंत्रण और रिपोर्टिंग की जा सकती है, जिससे सर्विस देने वाले और उपयोग करने वाले, दोनों के लिए पारदर्शिता बनी रहती है। इन्हीं उद्देश्यों को ध्यान में रखते हुए, SparkTG अपनी अधिकांश सर्विसेज़ के लिए API ला रहा है, ताकि ग्राहक उन्हें अपने एप्लिकेशन (वेब, डेस्कटॉप या मोबाइल) के साथ आसानी से टेस्ट और इंटीग्रेट कर सकें।
मान्यताएँ
यह डॉक्युमेंट डेवलपर्स के लिए है और इसके लिए SparkTG क्लाउड टेलीफोनी प्लेटफ़ॉर्म की बुनियादी जानकारी आवश्यक है। ग्राहक अपने एप्लिकेशन में API उपयोग कर सकें, इससे पहले SparkTG को प्रत्येक ग्राहक के लिए API सर्विस पहले से प्रोविज़न करनी होगी।
बेसिक ऑथ हेडर देना: हमारी API REST आधारित हैं, जिनमें हम बेसिक ऑथेंटिकेशन का उपयोग करते हैं। बेसिक ऑथ हेडर आपको स्वयं भेजने होंगे। इसके लिए आपको username:password के रूप में एक स्ट्रिंग पास करनी होगी।
क्लाउड टेलीफोनी
ऑन-डिमांड टेलीफोनी सेवा जो संगठनों को भरोसेमंद रूप से सशक्त फ़ीचर्स प्रदान करती है। नेटवर्क के माध्यम से कहीं से भी सुविधाओं का उपयोग करें।
रिसोर्स पूलिंग
डायनामिक रिसोर्स आवंटन के साथ मल्टी-टेनेंट मॉडल। केवल उपयोग के अनुसार भुगतान करें, जिससे इन-हाउस डेवलपमेंट लागत घटती है।
इलास्टिसिटी
स्केल आउट के लिए टेलीफोनी पोर्ट्स स्वचालित रूप से तेज़ी से प्रोविज़न करें और ज़रूरत के अनुसार स्केल इन के लिए जल्दी रिलीज़ करें।
मापी गई सेवा
मीटरिंग क्षमताओं के साथ स्वचालित रिसोर्स नियंत्रण। प्रदाता और उपभोक्ता दोनों के लिए पारदर्शिता के साथ उपयोग की निगरानी करें।
बेसिक ऑथेंटिकेशन
हमारी API REST आधारित हैं, जिनमें हम बेसिक ऑथेंटिकेशन का उपयोग करते हैं। बेसिक ऑथ हेडर आपको स्वयं भेजने होंगे। इसके लिए आपको username:password के रूप में एक स्ट्रिंग पास करनी होगी।
ऑथेंटिकेशन फ़ॉर्मेट:
username:passwordइसे Authorization हेडर में पास करें या curl -u फ़्लैग का उपयोग करें
डेवलपर आवश्यकताएं
• SparkTG क्लाउड टेलीफोनी प्लेटफ़ॉर्म की बुनियादी जानकारी आवश्यक है
• SparkTG को प्रत्येक ग्राहक के लिए API सेवा पहले से प्रोविज़न करनी होगी
• बेसिक ऑथेंटिकेशन सपोर्ट के साथ REST-आधारित API
• वेब, डेस्कटॉप और मोबाइल एप्लिकेशन के साथ संगत
शुरुआत करें
1. API एक्सेस का अनुरोध करें
अपने ग्राहक अकाउंट के लिए API सेवा प्रोविज़न करवाने हेतु SparkTG से संपर्क करें।
2. क्रेडेंशियल्स प्राप्त करें
बेसिक ऑथेंटिकेशन के लिए अपने username:password क्रेडेंशियल्स प्राप्त करें।
3. API चुनें
कॉल मैनेजमेंट, एजेंट API, मैसेजिंग और अन्य में से चुनें।
4. इंटीग्रेट करें
अपने वेब, डेस्कटॉप या मोबाइल एप्लिकेशन में REST एंडपॉइंट्स का उपयोग करें।
उपलब्ध API श्रेणियां
एजेंट मैनेजमेंट
लॉगिन, स्टेटस, ब्रेक और एजेंट कॉन्फ़िगरेशन
कॉल मैनेजमेंट
कॉल करना, ट्रांसफ़र, शेड्यूलिंग और कॉल कंट्रोल
मैसेजिंग और OTP
SMS और OTP सत्यापन सेवाएं
एनालिटिक्स
कॉल हिस्ट्री, रिपोर्ट्स और डैशबोर्ड डेटा
रियल-टाइम इवेंट्स
WebSocket इवेंट्स और वेबहुक इंटीग्रेशन
कॉन्फ़िगरेशन
ट्रांसफ़र सेटिंग्स और सेवा कॉन्फ़िगरेशन
