API v2 पर जाना दस्तावेज़ीकरण
API v2 पर जाना
API v2 पर जाना
API v2 पर जाना
आपके मौजूदा इंटीग्रेशन के लिए टोकन-आधारित ऑथेंटिकेशन
आपका इंटीग्रेशन SparkTG API को /api/v1 पर कॉल करता है और हर रिक्वेस्ट के साथ SparkTG यूज़रनेम और पासवर्ड भेजता है। API ऑथेंटिकेशन अब साइन किए गए API टोकन पर जा रहा है, जो उन्हीं एंडपॉइंट के लिए /api/v2 पर उपलब्ध हैं। एंडपॉइंट, पैरामीटर और रिस्पॉन्स वही रहते हैं: ज़्यादातर इंटीग्रेशन के लिए केवल बेस URL और Authorization हेडर बदलता है।
v2 पर क्यों जाएँ
API टोकन बनाएँ
- 1SparkTG डैशबोर्ड में Admin → Settings → API Access Tokens खोलें।
- 2Generate a new token के अंतर्गत चुनें कि वन-टाइम पासवर्ड कहाँ पाना है (SMS, WhatsApp या Email) और उसका अनुरोध करें।
- 3OTP दर्ज करें, चाहें तो एक लेबल जोड़ें (जैसे आपके इंटीग्रेशन का नाम) और टोकन बनाएँ।
- 4टोकन कॉपी करें और सुरक्षित रखें। यह केवल एक बार दिखाया जाता है और एक साल तक मान्य रहता है।
टोकन आपका सर्विस एडमिन बनाता है। उसी स्क्रीन पर आपके टोकन की सूची होती है और वहीं से किसी टोकन को रद्द किया जा सकता है। टोकन की अवधि समाप्त होने से पहले नया टोकन बनाएँ और अपने इंटीग्रेशन को उस पर स्विच करें।
क्या बदलता है
सफल रिस्पॉन्स और एंडपॉइंट से जुड़े एरर v1 जैसे ही हैं। हर v2 रिक्वेस्ट API उपयोग की बिलिंग के लिए दर्ज की जाती है।
उदाहरण
curl -u '<username>:<password>' \
'https://telephonycloud.co.in/api/v1/calls?service-id=<SERVICE_ID>&number=9XXXXXXXXX&agent-id=<AGENT_ID>'curl -H 'Authorization: Bearer <YOUR_TOKEN>' \
'https://telephonycloud.co.in/api/v2/calls?number=9XXXXXXXXX&agent-id=<AGENT_ID>'<YOUR_TOKEN> की जगह अपना API टोकन डालें
टोकन एरर
एंडपॉइंट चलने से पहले टोकन जाँचा जाता है, इसलिए कोई भी v2 रिक्वेस्ट ये लौटा सकती है।
{"status":"error","code":401,"message":"invalid or missing JWT"}{"status":"error","code":401,"message":"token revoked or unknown"}{"status":"error","code":403,"message":"service inactive (svcId=<id>)"}{"status":"error","code":403,"message":"svc-id does not match token's service"}v2 एंडपॉइंट
ये API आज v2 पर उपलब्ध हैं। SparkTG की बाकी API भी जल्द v2 पर आ रही हैं।
कॉल करें (v2)
आउटबाउंड या शेड्यूल्ड कॉल शुरू करें
क्लिक टू कॉल (v2)
OTP से सत्यापित कॉलबैक अनुरोध
शेड्यूल्ड कॉल हटाएँ (v2)
शेड्यूल की गई कॉल रद्द करें
एक साथ शेड्यूल्ड कॉल बनाएँ (v2)
एक रिक्वेस्ट में 500 तक कॉल शेड्यूल करें
WhatsApp मैसेज भेजें (v2)
अपनी सर्विस से मैसेज भेजें
कॉल डिटेल एक साथ प्राप्त करें (v2)
किसी समय-अवधि के कॉल रिकॉर्ड
लॉगिन / लॉगआउट रिपोर्ट (v2)
एजेंट के लॉगिन और लॉगआउट का समय
एजेंट्स की सूची (v2)
टोकन की सर्विस के सभी एजेंट
एजेंट अपडेट करें (v2)
लॉग इन, लॉग आउट, ब्रेक और प्रोफ़ाइल बदलाव
प्रभावी ब्रेक प्राप्त करें (v2)
एजेंट्स के लिए उपलब्ध ब्रेक स्टेटस, चाहें तो किसी एक एजेंट के लिए
CDR रिपोर्ट (v2)
एक टाइम विंडो के लिए कॉल डिटेल रिकॉर्ड्स
एजेंट परफ़ॉर्मेंस रिपोर्ट (v2)
प्रति एजेंट कॉल काउंट तथा टॉक, हैंडल, होल्ड और पिकअप टाइम
Login / logout रॉ रिपोर्ट (v2)
लॉगिन और ब्रेक टाइमलाइन, प्रति स्टेटस सेगमेंट एक रो
Login / logout समरी रिपोर्ट (v2)
प्रति एजेंट आइडल, टॉक, ब्रेक और लॉगआउट ड्यूरेशन
सर्विसेज़ की सूची (v2)
टोकन की सर्विस
LeadSquared DID सूची (v2)
LeadSquared इंटीग्रेशन के लिए DID
