SparkTG

API v2 पर जाना दस्तावेज़ीकरण

API v2 पर जाना

v2

API v2 पर जाना

आपके मौजूदा इंटीग्रेशन के लिए टोकन-आधारित ऑथेंटिकेशन

आपका इंटीग्रेशन SparkTG API को /api/v1 पर कॉल करता है और हर रिक्वेस्ट के साथ SparkTG यूज़रनेम और पासवर्ड भेजता है। API ऑथेंटिकेशन अब साइन किए गए API टोकन पर जा रहा है, जो उन्हीं एंडपॉइंट के लिए /api/v2 पर उपलब्ध हैं। एंडपॉइंट, पैरामीटर और रिस्पॉन्स वही रहते हैं: ज़्यादातर इंटीग्रेशन के लिए केवल बेस URL और Authorization हेडर बदलता है।

v2 पर क्यों जाएँ

क्या भेजा जाता है
यूज़रनेम + पासवर्ड (v1):हर रिक्वेस्ट पर लॉगिन पासवर्ड
API टोकन (v2):एक साइन किया गया टोकन; कोई भी पासवर्ड आपके एडमिन के हाथ से बाहर नहीं जाता
अगर यह लीक हो जाए
यूज़रनेम + पासवर्ड (v1):पासवर्ड बदलने तक काम करता रहता है, और वही पासवर्ड डैशबोर्ड भी खोल सकता है
API टोकन (v2):API Access Tokens स्क्रीन पर उस एक टोकन को तुरंत रद्द करें; डैशबोर्ड लॉगिन पर कोई असर नहीं पड़ता
दायरा
यूज़रनेम + पासवर्ड (v1):वह यूज़र जो कुछ भी एक्सेस कर सकता है
API टोकन (v2):ठीक एक सर्विस, जो टोकन में तय है
अवधि
यूज़रनेम + पासवर्ड (v1):कोई समाप्ति नहीं
API टोकन (v2):एक साल बाद समाप्त; नया टोकन बनाकर बदलें
इसे कौन बना सकता है
यूज़रनेम + पासवर्ड (v1):पासवर्ड जानने वाला कोई भी
API टोकन (v2):केवल सर्विस एडमिन, वन-टाइम पासवर्ड (OTP) जाँच के बाद
स्थिरता
यूज़रनेम + पासवर्ड (v1):किसी के पासवर्ड बदलते ही टूट जाता है
API टोकन (v2):किसी लॉगिन पासवर्ड से जुड़ा नहीं
दृश्यता
यूज़रनेम + पासवर्ड (v1):—
API टोकन (v2):हर रिक्वेस्ट टोकन की सर्विस के नाम दर्ज होती है

API टोकन बनाएँ

  1. 1SparkTG डैशबोर्ड में Admin → Settings → API Access Tokens खोलें।
  2. 2Generate a new token के अंतर्गत चुनें कि वन-टाइम पासवर्ड कहाँ पाना है (SMS, WhatsApp या Email) और उसका अनुरोध करें।
  3. 3OTP दर्ज करें, चाहें तो एक लेबल जोड़ें (जैसे आपके इंटीग्रेशन का नाम) और टोकन बनाएँ।
  4. 4टोकन कॉपी करें और सुरक्षित रखें। यह केवल एक बार दिखाया जाता है और एक साल तक मान्य रहता है।

टोकन आपका सर्विस एडमिन बनाता है। उसी स्क्रीन पर आपके टोकन की सूची होती है और वहीं से किसी टोकन को रद्द किया जा सकता है। टोकन की अवधि समाप्त होने से पहले नया टोकन बनाएँ और अपने इंटीग्रेशन को उस पर स्विच करें।

क्या बदलता है

बेस URL
v1 (अभी):https://telephonycloud.co.in/api/v1
v2:https://telephonycloud.co.in/api/v2
ऑथेंटिकेशन
v1 (अभी):Authorization: Basic <username:password>
v2:Authorization: Bearer <YOUR_TOKEN>
सर्विस id (svc-id / service-id)
v1 (अभी):सर्विस चुनता है।
v2:वैकल्पिक। सर्विस हमेशा टोकन से आती है। अगर आप इसे भेजते हैं, तो यह टोकन की सर्विस से मेल खाना चाहिए, वरना HTTP 403।
किसी कार्रवाई के लिए एजेंट
v1 (अभी):आपके भेजे पैरामीटर से लिया जाता है।
v2:वही। अगर आप agent-sip, agent-id या agent-number नहीं भेजते, तो कार्रवाई उस एडमिन के नाम होती है जिसने टोकन बनाया, इसलिए एजेंट का agent-sip, agent-id या agent-number भेजें।
शेड्यूल्ड कॉल हटाएँ
v1 (अभी):GET या POST
v2:केवल DELETE, पैरामीटर क्वेरी स्ट्रिंग में
WhatsApp मैसेज भेजें
v1 (अभी):यूज़र के एजेंट के रूप में भेजा जाता है
v2:वैकल्पिक agent-id क्वेरी पैरामीटर भेजने वाला एजेंट चुनता है
सर्विसेज़ की सूची
v1 (अभी):यूज़र की सभी सर्विसेज़
v2:केवल टोकन की सर्विस

सफल रिस्पॉन्स और एंडपॉइंट से जुड़े एरर v1 जैसे ही हैं। हर v2 रिक्वेस्ट API उपयोग की बिलिंग के लिए दर्ज की जाती है।

उदाहरण

यूज़रनेम + पासवर्ड (v1)
curl -u '<username>:<password>' \
  'https://telephonycloud.co.in/api/v1/calls?service-id=<SERVICE_ID>&number=9XXXXXXXXX&agent-id=<AGENT_ID>'
API टोकन (v2)
curl -H 'Authorization: Bearer <YOUR_TOKEN>' \
  'https://telephonycloud.co.in/api/v2/calls?number=9XXXXXXXXX&agent-id=<AGENT_ID>'

<YOUR_TOKEN> की जगह अपना API टोकन डालें

टोकन एरर

एंडपॉइंट चलने से पहले टोकन जाँचा जाता है, इसलिए कोई भी v2 रिक्वेस्ट ये लौटा सकती है।

HTTP 401Authorization हेडर मौजूद नहीं है या गलत है, या टोकन की अवधि समाप्त हो गई है।
{"status":"error","code":401,"message":"invalid or missing JWT"}
HTTP 401टोकन को API Access Tokens स्क्रीन पर रद्द कर दिया गया है।
{"status":"error","code":401,"message":"token revoked or unknown"}
HTTP 403टोकन जिस सर्विस का है, वह सक्रिय नहीं है।
{"status":"error","code":403,"message":"service inactive (svcId=<id>)"}
HTTP 403svc-id या service-id पैरामीटर किसी दूसरी सर्विस 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