Alarm entegrasyonları
Temel platformalarm_integrations_connections_writeHarici entegrasyonlarBir tesisi bir izleme ortağının şablonuna bağlar ve bu bağlantıyı yönetir: kaydetme (şablon, hesap numarası, bölge eşlemesi, olaylar, tesis alanları), kaldırma, onay isteme, test sinyali gönderme, başarılı bir testten sonra etkinleştirme ve hazırlanan bir değişikliği atma.
Canlı bir bağlantı (active veya failing) yalnızca applyMode ile değişir: staged, hazırlanan bir test başarılı olup siz etkinleştirene kadar alarmları canlı ayarlarda tutar; immediate hemen uygular. Gizli alanlar kabul edilir ancak asla döndürülmez. Tesiste External Integrations gerektirir. Önce alarm_integrations_read connections ile okuyun.
Eylemler:
- save: Bağlantıyı kaydedin. Yeni bir bağlantı için templateId gerekir. fields, tesis alanlarını anahtara göre ayarlar (null birini temizler; gizli değerler mühürlenir). Canlı bir bağlantıda applyMode gönderin, aksi halde çağrı apply-mode-required ile başarısız olur. Gerekli: partnerId. Onay ister.
- remove: Bağlantıyı kaldırın. Tesisin ortakla bağlantısını, hazırlanan değişikliklerle birlikte kaldırır; alarmlar artık buradan o izleme merkezine gitmez. Gerekli: partnerId. Onay ister.
- request_approval: Onay isteyin. İzleme merkezinden bağlantıyı onaylamasını veya bir hesap numarası atamasını ister (ortak onaylı şablonlar). Gerekli: partnerId.
- send_test_signal: Test sinyali gönderin. İzleme merkezine gerçek bir test sinyalini kuyruğa alır; test_signal_status ile durumu sorgulayın. staged: true, canlı ayarlar yerine hazırlanan değişikliği test eder. Gerekli: partnerId. Onay ister.
- activate: Bir bağlantıyı veya değişikliği etkinleştirin. Bekleyen bir bağlantıyı canlıya alır, hazırlanan bir değişikliği canlıya taşır veya test edilmemiş bir değişikliği onaylar. Etkinleştirme, son değişiklikten sonra başarılı olan bir testin requestId değerini gerektirir: hazırlanan bir test (staged: true) hazırlanan değişikliği canlıya taşır, canlı bir test ise test edilmemiş bir değişikliği onaylar. Gerekli: partnerId, requestId. Onay ister.
- discard_pending_change: Hazırlanan değişikliği atın. Hazırlanan değişikliği bırakır; canlı ayarlara dokunulmaz. Hazırlanmış bir şey yoksa discarded false olur. Gerekli: partnerId. Onay ister.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
action* | "save" | "remove" | "request_approval" | "send_test_signal" | "activate" | "discard_pending_change" | Yapılacak işlem; her eylem araç açıklamasında anlatılmıştır. |
facilityId | string | Tesis kimliği. Kastettiğiniz tesis bağlı tesisse isteğe bağlıdır. |
partnerId | string | alarm_integrations_read connections sonucundaki izleme ortağı (organizasyonun kendi şablonları için org#<id>) |
templateId | string | Bu tesise sunulan yayımlanmış bir şablon (save) |
linkingIdentifier | stringnull | İzleme merkezinin tesisi tanıdığı hesap numarası (save) |
zoneMap | objectnull | Buton seri numarasından bölgeye eşleme, ör. { "DS-0001": "001" } (save) |
events | arraynull | Ortağa gönderilen olay türleri (null: şablonunkiler) (save) |
fields | object | Anahtara göre tesis alanı değerleri; null birini temizler. Asla döndürülmez. (save) |
applyMode | "staged" | "immediate" | Canlı bağlantılar: staged (test edin, ardından etkinleştirin) veya immediate (save) |
staged | boolean | Hazırlanan değişikliği test eder (etkinleştirmeden önce gereklidir) (send_test_signal) |
requestId | string | send_test_signal sonucundaki test sinyali istek kimliği (tsr_...) (activate) |
confirm | boolean | Yalnızca kullanıcı ilk çağrının döndürdüğü önizlemeyi onayladıktan sonra ayarlayın |
alarm_integrations_destinations_writeHarici entegrasyonlarDuress ConfigurationÖzel alarm hedeflerini ekler, değiştirir, siler ve test amaçlı tetikler: kendi izleme alıcınız, bir röle kartı, SMS, sesli arama, e-posta, webhook'lar, ekip sohbeti veya bir nöbet çağrı hizmeti (kanal listesi); tesis (varsayılan), marka veya organizasyon düzeyinde.
Gizli olmayan ayarlar config içine girer; gizli değerler (parolalar, webhook URL'leri, anahtarlar) ayar yoluna göre fields içine girer, mühürlenir ve asla döndürülmez. Etkin hedefler eksiksiz bir config gerektirir. Tesis hedefleri orada External Integrations veya Duress Configuration gerektirir; marka ve organizasyon hedefleri organizasyon genelinde erişim gerektirir. Önce alarm_integrations_read destinations ile okuyun.
Eylemler:
- save: Hedefi kaydedin. connectionId olmadan bir hedef ekler (channel ve name gerekir); connectionId ile bir hedefi değiştirir (kanal aynı kalır). config gönderildiğinde gizli olmayan ayarların yerini alır; fields içinde gönderilmeyen gizli değerler korunur. Onay ister.
- remove: Hedefi silin. Hedefi siler; bir tesis rölesi de alarm rölesini sürmeyi bırakır. Gerekli: connectionId. Onay ister.
- send_test_signal: Bir hedefe test gönderin. Hedefe gerçek bir test mesajını kuyruğa alır; tesisle birlikte alarm_integrations_read test_signal_status ile durumu sorgulayın. Marka ve organizasyon hedefleri facilityId üzerinden test edilir. Gerekli: connectionId. Onay ister.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
action* | "save" | "remove" | "send_test_signal" | Yapılacak işlem; her eylem araç açıklamasında anlatılmıştır. |
facilityId | string | Tesis kimliği. Kastettiğiniz tesis bağlı tesisse isteğe bağlıdır. |
ownerScope | string | facility#<id>, brand#<id> veya org#<id> (varsayılan: tesis) |
connectionId | string | Değiştirilecek hedef; yeni bir hedef eklemek için göndermeyin |
channel | "cid-csvip" | "sentinel-http" | "relay" | "sms" | "voice" | "email" | "webhook" | "slack" | "teams" | "google-chat" | "pagerduty" | "opsgenie" | Hedef türü; oluşturulduktan sonra değiştirilemez (save) |
name | string | Ayarlarda ve teslim günlüğünde gösterilir (save) |
enabled | boolean | Yeni hedefler için varsayılan true (save) |
events | arraynull | Aldığı olay türleri (null: kanalın varsayılanları) (save) |
guestLink | "shared" | "none" | "null" | Yalnızca SMS, e-posta ve ekip sohbeti kanalları: shared (yalnızca görüntülenebilen tek bir alarm sayfası, varsayılan) veya none (save) |
config | object | Kanal için gizli olmayan ayarlar (save) |
fields | object | Yola göre gizli ayarlar, ör. { "webhookUrl": "https://..." }; null birini temizler (save) |
confirm | boolean | Yalnızca kullanıcı ilk çağrının döndürdüğü önizlemeyi onayladıktan sonra ayarlayın |
alarm_integrations_readHarici entegrasyonlarDuress ConfigurationBir tesisin duress alarmlarının Performance Hub dışında nereye gittiğini okur: izleme merkezi bağlantıları (ortak, şablon, hesap numarası, bölge eşlemesi, durum, hazır olma eksikleri, hazırlanan değişiklikler), tesisteki, markasındaki ve organizasyonundaki özel hedefler (izleme alıcıları, röleler, SMS, sesli arama, e-posta, webhook'lar, sohbet, çağrı), bir yönlendirme önizlemesi, teslim günlüğü ve test sinyali sonuçları.
Tesiste External Integrations veya Duress Configuration gerektirir. Gizli ve mühürlü değerler asla gösterilmez, yalnızca { key, secret, hasValue } gösterilir; kişilerin numaraları ve adresleri yönlendirme ve teslim bilgilerinden çıkarılır. Saatler ISO biçimindedir. Bunları alarm_integrations_connections_write ve alarm_integrations_destinations_write ile değiştirin.
Eylemler:
- connections: İzleme merkezi bağlantıları. Tesisin ortak bağlantıları: şablon, hesap numarası (linkingIdentifier), bölge eşlemesi, olaylar, connectionStatus, missing (canlıya geçişi engelleyenler), pendingChange (hazırlanmış, henüz canlı değil) ve untestedChange. canEdit: burada External Integrations.
- destinations: Özel hedefler. Tesis için tetiklenebilen hedefler (kendi hedefleri, markasının ve organizasyonunun hedefleri, her biri canEdit ile) veya ownerScope ile tek bir kapsamın hedefleri. Ayarlar config içindedir; gizli değerler fields { key, secret, hasValue } olarak gösterilir.
- routing: Yönlendirme önizlemesi. Bir alarmın şu anda nereye gideceği (yalnızca canlı ayarlar), universal-api'nin çözümlediği şekliyle: lane, olaylar ve gizli değerler hariç config ile hedefler, dışarıda kalan her şeyi açıklayan problems ve henüz yönlendirilmeyen pendingChanges. eventType yalnızca o olayı alanları tutar.
- deliveries: Teslim günlüğü. En yeniden eskiye alarm teslimleri (durum, kanal, alıcı, gecikme, herkese açık hata metni). Filtrelenmiş bir sayfa kısa olabilir ve yine de nextCursor içerebilir. Cihaz uyarıları kind alert olarak görünür.
- test_signal_status: Test sinyali sonucu. universal-api bir deneme kaydedene kadar queued, ardından teslim satırlarıyla birlikte succeeded (bir alıcı onayladı veya gönderildi) ya da failed. Testin gönderildiği tesisi kullanın. Gerekli: requestId.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
action* | "connections" | "destinations" | "routing" | "deliveries" | "test_signal_status" | Yapılacak işlem; her eylem araç açıklamasında anlatılmıştır. |
facilityId | string | Tesis kimliği. Kastettiğiniz tesis bağlı tesisse isteğe bağlıdır. |
limit | integer | Sayfa başına öğe (varsayılan 25, en fazla 100) (connections, destinations, deliveries) |
cursor | string | Önceki sayfadan nextCursor (connections, destinations, deliveries) |
ownerScope | string | Yalnızca bu kapsam: brand#<id> veya org#<id> (destinations) |
eventType | string | ör. ph.duress.incident.created (routing, deliveries) |
from | string | ISO tarih-saat, dahil (deliveries) |
to | string | ISO tarih-saat, hariç (deliveries) |
status | array | sent, acknowledged, failed, shadow değerlerinden herhangi biri (deliveries) |
channel | string | Tam kanal adı, ör. cid-csvip veya sms (deliveries) |
destinationId | string | Tam hedef kimliği (deliveries) |
incidentId | string | Tek bir alarmın teslimleri (deliveries) |
requestId | string | Tek bir test sinyalinin teslimleri (deliveries, test_signal_status) |
search | string | Herhangi bir kimlik, kanal veya hatadaki metin (deliveries) |