अलार्म इंटीग्रेशन

कोर प्लेटफ़ॉर्म
alarm_integrations_connections_writeबाहरी इंटीग्रेशन

किसी सुविधा को मॉनिटरिंग पार्टनर के टेम्पलेट से कनेक्ट करता है और उस कनेक्शन को प्रबंधित करता है: सहेजना (टेम्पलेट, खाता संख्या, ज़ोन मैप, इवेंट, सुविधा फ़ील्ड), हटाना, स्वीकृति का अनुरोध करना, परीक्षण सिग्नल भेजना, सफल परीक्षण के बाद सक्रिय करना, और staged बदलाव को रद्द करना।

लाइव कनेक्शन (active या failing) केवल applyMode के साथ बदलता है: staged अलार्म को तब तक लाइव सेटिंग्स पर रखता है जब तक staged परीक्षण सफल न हो और आप उसे सक्रिय न करें; immediate अभी लागू करता है। गोपनीय फ़ील्ड स्वीकार किए जाते हैं, पर कभी लौटाए नहीं जाते। सुविधा पर External Integrations आवश्यक है। पहले alarm_integrations_read connections से पढ़ें।

कार्रवाइयाँ:

  • save: कनेक्शन सहेजें। नए कनेक्शन के लिए templateId आवश्यक है। fields कुंजी के अनुसार सुविधा फ़ील्ड सेट करता है (null किसी एक को हटाता है; गोपनीय मान सील किए जाते हैं)। लाइव कनेक्शन पर applyMode दें, अन्यथा कॉल apply-mode-required के साथ विफल होती है। partnerId आवश्यक है। पुष्टि माँगता है।
  • remove: कनेक्शन हटाएँ। पार्टनर से सुविधा का कनेक्शन, किसी भी staged बदलाव के साथ, हटा देता है; यहाँ से उस मॉनिटरिंग केंद्र को अलार्म जाना बंद हो जाता है। partnerId आवश्यक है। पुष्टि माँगता है।
  • request_approval: स्वीकृति का अनुरोध करें। मॉनिटरिंग केंद्र से कनेक्शन स्वीकृत करने या खाता संख्या देने का अनुरोध करता है (पार्टनर-स्वीकृति वाले टेम्पलेट)। partnerId आवश्यक है।
  • send_test_signal: परीक्षण सिग्नल भेजें। मॉनिटरिंग केंद्र के लिए एक वास्तविक परीक्षण सिग्नल कतार में डालता है; test_signal_status की जाँच करते रहें। staged: true लाइव सेटिंग्स के बजाय staged बदलाव का परीक्षण करता है। partnerId आवश्यक है। पुष्टि माँगता है।
  • activate: कनेक्शन या बदलाव सक्रिय करें। लंबित कनेक्शन को लाइव करता है, staged बदलाव को लागू करता है, या बिना परीक्षण वाले बदलाव की पुष्टि करता है। सक्रिय करने के लिए ऐसे परीक्षण का requestId आवश्यक है जो पिछले बदलाव के बाद सफल हुआ हो: staged परीक्षण (staged: true) staged बदलाव को लागू करता है, लाइव परीक्षण बिना परीक्षण वाले बदलाव की पुष्टि करता है। partnerId, requestId आवश्यक हैं। पुष्टि माँगता है।
  • discard_pending_change: staged बदलाव रद्द करें। staged बदलाव को हटा देता है; लाइव सेटिंग्स अप्रभावित रहती हैं। कुछ भी staged न होने पर discarded false होता है। partnerId आवश्यक है। पुष्टि माँगता है।

पैरामीटर

नामप्रकारविवरण
action*"save" | "remove" | "request_approval" | "send_test_signal" | "activate" | "discard_pending_change"क्या करना है; प्रत्येक क्रिया का वर्णन टूल विवरण में है।
facilityIdstringसुविधा ID। जब कनेक्टेड सुविधा ही आपकी अभीष्ट सुविधा हो, तो वैकल्पिक।
partnerIdstringमॉनिटरिंग पार्टनर, alarm_integrations_read connections से (संगठन के अपने टेम्पलेट के लिए org#<id>)
templateIdstringइस सुविधा को उपलब्ध कराया गया प्रकाशित टेम्पलेट (save)
linkingIdentifierstringnullवह खाता संख्या जिससे मॉनिटरिंग केंद्र सुविधा को पहचानता है (save)
zoneMapobjectnullबटन सीरियल से ज़ोन, उदाहरण के लिए { "DS-0001": "001" } (save)
eventsarraynullपार्टनर को भेजे जाने वाले इवेंट प्रकार (null: टेम्पलेट के) (save)
fieldsobjectकुंजी के अनुसार सुविधा फ़ील्ड के मान; null किसी एक को हटाता है। कभी लौटाए नहीं जाते। (save)
applyMode"staged" | "immediate"लाइव कनेक्शन: staged (परीक्षण करें, फिर सक्रिय करें) या immediate (save)
stagedbooleanstaged बदलाव का परीक्षण करें (उसे सक्रिय करने से पहले आवश्यक) (send_test_signal)
requestIdstringपरीक्षण-सिग्नल अनुरोध id (tsr_...), send_test_signal से (activate)
confirmbooleanकेवल तभी सेट करें जब उपयोगकर्ता ने पहली कॉल से लौटाए गए पूर्वावलोकन की पुष्टि कर दी हो
alarm_integrations_destinations_writeबाहरी इंटीग्रेशनDuress Configuration

सुविधा (डिफ़ॉल्ट), ब्रांड या संगठन स्तर पर कस्टम अलार्म गंतव्य जोड़ता है, बदलता है, हटाता है और उन पर परीक्षण भेजता है: आपका अपना मॉनिटरिंग रिसीवर, रिले बोर्ड, SMS, वॉइस, ईमेल, वेबहुक, टीम चैट या ऑन-कॉल पेजिंग सेवा (channel सूची)।

गैर-गोपनीय सेटिंग्स config में जाती हैं; गोपनीय मान (पासवर्ड, वेबहुक URL, कुंजियाँ) सेटिंग पथ के अनुसार fields में जाते हैं और सील किए जाते हैं, कभी लौटाए नहीं जाते। सक्षम गंतव्यों के लिए पूरा config आवश्यक है। सुविधा गंतव्यों के लिए वहाँ External Integrations या Duress Configuration आवश्यक है; ब्रांड और संगठन गंतव्यों के लिए संगठन-व्यापी पहुँच आवश्यक है। पहले alarm_integrations_read destinations से पढ़ें।

कार्रवाइयाँ:

  • save: गंतव्य सहेजें। connectionId के बिना नया गंतव्य जोड़ता है (channel और name आवश्यक); उसके साथ मौजूदा गंतव्य बदलता है (channel वही रहता है)। भेजे जाने पर config गैर-गोपनीय सेटिंग्स को बदल देता है; fields से छोड़े गए गोपनीय मान बने रहते हैं। पुष्टि माँगता है।
  • remove: गंतव्य हटाएँ। गंतव्य हटा देता है; सुविधा का रिले अलार्म रिले चलाना भी बंद कर देता है। connectionId आवश्यक है। पुष्टि माँगता है।
  • send_test_signal: गंतव्य पर परीक्षण भेजें। गंतव्य के लिए एक वास्तविक परीक्षण संदेश कतार में डालता है; सुविधा के साथ alarm_integrations_read test_signal_status की जाँच करते रहें। ब्रांड और संगठन गंतव्यों का परीक्षण facilityId से किया जाता है। connectionId आवश्यक है। पुष्टि माँगता है।

पैरामीटर

नामप्रकारविवरण
action*"save" | "remove" | "send_test_signal"क्या करना है; प्रत्येक क्रिया का वर्णन टूल विवरण में है।
facilityIdstringसुविधा ID। जब कनेक्टेड सुविधा ही आपकी अभीष्ट सुविधा हो, तो वैकल्पिक।
ownerScopestringfacility#<id>, brand#<id> या org#<id> (डिफ़ॉल्ट: सुविधा)
connectionIdstringबदला जाने वाला गंतव्य; नया जोड़ने के लिए छोड़ दें
channel"cid-csvip" | "sentinel-http" | "relay" | "sms" | "voice" | "email" | "webhook" | "slack" | "teams" | "google-chat" | "pagerduty" | "opsgenie"गंतव्य का प्रकार; बनाने के बाद इसे बदला नहीं जा सकता (save)
namestringसेटिंग्स और डिलीवरी लॉग में दिखाया जाता है (save)
enabledbooleanनए गंतव्यों के लिए डिफ़ॉल्ट true (save)
eventsarraynullइसे मिलने वाले इवेंट प्रकार (null: channel के डिफ़ॉल्ट) (save)
guestLink"shared" | "none" | "null"केवल SMS, ईमेल और टीम चैट चैनल: shared (एक केवल-देखने वाला अलार्म पेज, डिफ़ॉल्ट) या none (save)
configobjectchannel के लिए गैर-गोपनीय सेटिंग्स (save)
fieldsobjectपथ के अनुसार गोपनीय सेटिंग्स, उदाहरण के लिए { "webhookUrl": "https://..." }; null किसी एक को हटाता है (save)
confirmbooleanकेवल तभी सेट करें जब उपयोगकर्ता ने पहली कॉल से लौटाए गए पूर्वावलोकन की पुष्टि कर दी हो
alarm_integrations_readबाहरी इंटीग्रेशनDuress Configuration

पढ़ता है कि किसी सुविधा के duress अलार्म Performance Hub के बाहर कहाँ जाते हैं: उसके मॉनिटरिंग-केंद्र कनेक्शन (पार्टनर, टेम्पलेट, खाता संख्या, ज़ोन मैप, स्थिति, तैयारी की कमियाँ, staged बदलाव), सुविधा, उसके ब्रांड और संगठन के कस्टम गंतव्य (मॉनिटरिंग रिसीवर, रिले, SMS, वॉइस, ईमेल, वेबहुक, चैट, पेजिंग), रूटिंग पूर्वावलोकन, डिलीवरी लॉग और परीक्षण-सिग्नल के परिणाम।

सुविधा पर External Integrations या Duress Configuration आवश्यक है। गोपनीय और सील किए गए मान कभी नहीं दिखाए जाते, केवल { key, secret, hasValue }; रूटिंग और डिलीवरी से लोगों के नंबर और पते हटा दिए जाते हैं। समय ISO में होते हैं। इन्हें alarm_integrations_connections_write और alarm_integrations_destinations_write से बदलें।

कार्रवाइयाँ:

  • connections: मॉनिटरिंग-केंद्र कनेक्शन। सुविधा के पार्टनर कनेक्शन: टेम्पलेट, खाता संख्या (linkingIdentifier), ज़ोन मैप, इवेंट, connectionStatus, missing (लाइव होने में क्या बाधा है), pendingChange (staged, अभी लाइव नहीं) और untestedChange। canEdit: यहाँ External Integrations।
  • destinations: कस्टम गंतव्य। वे गंतव्य जो सुविधा के लिए सक्रिय हो सकते हैं (उसके अपने, उसके ब्रांड के और संगठन के, हर एक canEdit के साथ), या ownerScope के साथ किसी एक दायरे के। सेटिंग्स config में; गोपनीय मान fields { key, secret, hasValue } के रूप में।
  • routing: रूटिंग पूर्वावलोकन। कोई अलार्म अभी कहाँ जाएगा (केवल लाइव सेटिंग्स), जैसा universal-api उसे तय करता है: lane, इवेंट और गोपनीय मानों के बिना config के साथ गंतव्य, छोड़ी गई किसी भी चीज़ को समझाने वाली problems, और अभी रूट न हुए pendingChanges। eventType केवल वही रखता है जो वह इवेंट प्राप्त करता है।
  • deliveries: डिलीवरी लॉग। अलार्म डिलीवरी, नवीनतम पहले (स्थिति, channel, रिसीवर, विलंब, त्रुटि का सार्वजनिक विवरण)। फ़िल्टर किया गया पेज छोटा हो सकता है और फिर भी उसमें nextCursor हो सकता है। Device alerts kind alert के रूप में दिखते हैं।
  • test_signal_status: परीक्षण सिग्नल का परिणाम। जब तक universal-api कोई प्रयास दर्ज नहीं करता तब तक queued, फिर डिलीवरी पंक्तियों के साथ succeeded (किसी रिसीवर ने पावती दी या संदेश भेज दिया गया) या failed। उसी सुविधा का उपयोग करें जिससे परीक्षण भेजा गया था। requestId आवश्यक है।

पैरामीटर

नामप्रकारविवरण
action*"connections" | "destinations" | "routing" | "deliveries" | "test_signal_status"क्या करना है; प्रत्येक क्रिया का वर्णन टूल विवरण में है।
facilityIdstringसुविधा ID। जब कनेक्टेड सुविधा ही आपकी अभीष्ट सुविधा हो, तो वैकल्पिक।
limitintegerप्रति पेज आइटम (डिफ़ॉल्ट 25, अधिकतम 100) (connections, destinations, deliveries)
cursorstringपिछले पेज से nextCursor (connections, destinations, deliveries)
ownerScopestringकेवल यह दायरा: brand#<id> या org#<id> (destinations)
eventTypestringउदाहरण के लिए ph.duress.incident.created (routing, deliveries)
fromstringISO दिनांक-समय, सम्मिलित (deliveries)
tostringISO दिनांक-समय, असम्मिलित (deliveries)
statusarraysent, acknowledged, failed, shadow में से कोई भी (deliveries)
channelstringसटीक channel, उदाहरण के लिए cid-csvip या sms (deliveries)
destinationIdstringसटीक गंतव्य id (deliveries)
incidentIdstringएक अलार्म की डिलीवरी (deliveries)
requestIdstringएक परीक्षण सिग्नल की डिलीवरी (deliveries, test_signal_status)
searchstringकिसी भी id, channel या त्रुटि में मौजूद टेक्स्ट (deliveries)