SparkTG

एजेंट अपडेट करें (v2) दस्तावेज़ीकरण

एजेंट अपडेट करें (v2)

v2

एजेंट अपडेट करें (v2)

लॉग इन, लॉग आउट, ब्रेक और प्रोफ़ाइल बदलाव

API v2v21 एंडपॉइंट्स

अवलोकन

किसी एजेंट को लॉग इन या लॉग आउट करें, ब्रेक पर भेजें, या उसका फ़ोन नंबर, कंट्री कोड या डिस्प्ले नाम बदलें। यह PATCH /api/v1/agents की जगह लेता है। एजेंट की पहचान agent_number या agent_sip में से ठीक एक से करें, फिर बदलने के लिए कम से कम एक फ़ील्ड भेजें; जो फ़ील्ड आप छोड़ देते हैं उन्हें छुआ नहीं जाता। बॉडी JSON होती है, और नीचे सूचीबद्ध न किया गया कोई भी फ़ील्ड 400 के साथ अस्वीकार हो जाता है। null और खाली स्ट्रिंग अस्वीकार होती हैं; यह एंडपॉइंट कुछ भी मिटाता नहीं है। हर सफल कॉल एक बार मीटर होती है।

उपलब्ध एंडपॉइंट्स

PUT/api/v2/agents

मुख्य पैरामीटर्स

agent_number(String)

एजेंट का मौजूदा फ़ोन नंबर। यह या agent_sip भेजें, दोनों नहीं।

agent_sip(String)

एजेंट का SIP एक्सटेंशन। यह या agent_number भेजें, दोनों नहीं।

status(Integer)

0 एजेंट को लॉग इन करता है (उपलब्ध)। 2 उसे लॉग आउट करता है (ऑफ़लाइन) या, break_id के साथ, उसे उस ब्रेक पर भेजता है। कोई और मान स्वीकार नहीं किया जाता।

break_id(Integer)

एजेंट को किस ब्रेक पर भेजना है। यह आपकी सर्विस के लिए सक्षम ब्रेक होना चाहिए। break_id भेजने का अर्थ स्टेटस 2 है, और इसे स्टेटस 0 के साथ नहीं जोड़ा जा सकता। स्टेटस 2 और बिना break_id के, डिफ़ॉल्ट ब्रेक 7 (ऑफ़लाइन) इस्तेमाल होता है, जो एजेंट को लॉग आउट कर देता है।

number(String)

नया फ़ोन नंबर: 4 से 15 अंक, बिना +, स्पेस या डैश के। यह सर्विस के किसी दूसरे एजेंट का नहीं होना चाहिए। एजेंट के कॉल पर रहते इसे बदला नहीं जा सकता।

country_code(String)

1 से 4 अंक, बिना +, और 0 से शुरू नहीं, उदाहरण के लिए 91 या 971।

उपयोग परिदृश्य

एजेंट को लॉग इन करें

status को 0 पर सेट करें। एजेंट उपलब्ध हो जाता है और अपनी कतारों से कॉल पाने लगता है। इससे एजेंट किसी भी ब्रेक से वापस भी आ जाता है।

0 पैरामीटर्सउदाहरण सेक्शन में उपलब्ध

एजेंट को लॉग आउट करें

बिना break_id के status को 2 पर सेट करें। एजेंट ऑफ़लाइन (ब्रेक 7) हो जाता है और कॉल पाना बंद कर देता है। break_id 7 के साथ status 2 भेजने पर भी यही होता है।

0 पैरामीटर्सउदाहरण सेक्शन में उपलब्ध

एजेंट को ब्रेक पर भेजें

break_id भेजें; status 2 अपने आप माना जाता है। दोबारा लॉग इन होने तक एजेंट कॉल पाना बंद कर देता है। यहाँ एजेंट को SIP एक्सटेंशन की जगह फ़ोन नंबर से चुना गया है।

0 पैरामीटर्सउदाहरण सेक्शन में उपलब्ध

एक ब्रेक से दूसरे ब्रेक पर जाना

एजेंट सीधे एक ब्रेक से दूसरे ब्रेक पर नहीं जा सकता; ऐसी कॉल 409 लौटाती है। पहले उसे लॉग इन करें (status 0), फिर नया break_id भेजें। दोनों कॉल सुरक्षित रूप से दोबारा की जा सकती हैं।

0 पैरामीटर्सउदाहरण सेक्शन में उपलब्ध

प्रोफ़ाइल विवरण अपडेट करें

नाम, फ़ोन नंबर और कंट्री कोड एक साथ बदलें। प्रोफ़ाइल फ़ील्ड status या break_id वाली कॉल में ही भेजे जा सकते हैं, लेकिन एजेंट के कॉल पर रहते नंबर नहीं बदला जा सकता।

0 पैरामीटर्सउदाहरण सेक्शन में उपलब्ध

त्वरित उदाहरण

एक साधारण cURL कमांड के साथ इस API को आज़माएं

बेसिक API कॉल
curl -X PUT 'https://telephonycloud.co.in/api/v2/agents' \
  -H 'Authorization: Bearer <YOUR_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"agent_sip": "10114", "status": 0}'
💡 <YOUR_TOKEN> की जगह अपना API टोकन डालें

रिस्पॉन्स प्रीव्यू

इस API का सैंपल रिस्पॉन्स

सैंपल रिस्पॉन्स
{"status":"success","changed":["status","break_id"],"agent":{"id":735,"name":"Priya Sharma","number":"9876500000","country_code":"91","sip":"10114","status":2,"break_id":3}}
पूरा रिस्पॉन्स फ़ॉर्मेट देखने के लिए रिस्पॉन्स सेक्शन देखें