SparkTG

प्रभावी ब्रेक प्राप्त करें (v2) दस्तावेज़ीकरण

प्रभावी ब्रेक प्राप्त करें (v2)

v2

प्रभावी ब्रेक प्राप्त करें (v2)

एजेंट्स के लिए उपलब्ध ब्रेक स्टेटस, चाहें तो किसी एक एजेंट के लिए

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

अवलोकन

आपकी सर्विस में एजेंट्स जिन ब्रेक स्टेटस का इस्तेमाल कर सकते हैं उनकी सूची, उदाहरण के लिए CRM या CTI में एजेंट का स्टेटस ड्रॉपडाउन भरने के लिए। "प्रभावी" का मतलब है वे ब्रेक जिन्हें एजेंट अभी इस्तेमाल कर सकते हैं: वे डिफ़ॉल्ट ब्रेक जिन्हें आपके एडमिन ने बंद नहीं किया है, और वे कस्टम ब्रेक जिन्हें उन्होंने चालू किया है। पूरी सर्विस के लिए बंद ब्रेक सूची में नहीं होते। सूची हमेशा टोकन की सर्विस की होती है। किसी एजेंट के लिए एडमिन ने कौन-से ब्रेक छिपाए हैं, यह भी देखने के लिए agent-id भेजें। इसका शुल्क नहीं लगता।

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

GET/api/v2/effective-breaks

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

agent-id(Integer)

एजेंट की ID (GET /api/v2/agents से लौटने वाला id)। भेजने पर, इस एजेंट के लिए एडमिन द्वारा छिपाए गए ब्रेक "disabled": true के साथ लौटते हैं। एजेंट-विशिष्ट फ़्लैग के बिना सर्विस की सूची पाने के लिए इसे न भेजें या खाली भेजें। एजेंट सक्रिय होना चाहिए और टोकन की सर्विस का होना चाहिए।

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

पूरी सर्विस के ब्रेक

कोई पैरामीटर नहीं। तब इस्तेमाल करें जब कोई खास एजेंट ध्यान में न हो, उदाहरण के लिए रिपोर्ट में ब्रेक के नाम दिखाने के लिए। रिस्पॉन्स छोटा किया गया है; आम तौर पर एक सर्विस में लगभग एक दर्जन ब्रेक होते हैं।

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

एक एजेंट के ब्रेक

agent-id भेजें। यहाँ एडमिन ने एजेंट 319 के लिए Leave छिपाया है, इसलिए वह "disabled": true के साथ लौटता है। ब्रेक सूची में बना रहता है ताकि आप उसका नाम और रंग दिखा सकें; बस एजेंट को उसे चुनने न दें।

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

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

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

बेसिक API कॉल
curl 'https://telephonycloud.co.in/api/v2/effective-breaks' \
  -H 'Authorization: Bearer <YOUR_TOKEN>'
💡 <YOUR_TOKEN> की जगह अपना API टोकन डालें

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

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

सैंपल रिस्पॉन्स
[{"break_id":0,"label":"Available","icon":"available","color":"#5ccc56","is_system":true,"sort_order":1,"is_deleted":false,"category":"SYSTEM"},{"break_id":1,"label":"Meal","icon":"lunch","color":"#F4...
पूरा रिस्पॉन्स फ़ॉर्मेट देखने के लिए रिस्पॉन्स सेक्शन देखें