Tích hợp báo động

Kết nối một cơ sở với mẫu của đối tác giám sát và quản lý kết nối đó: lưu (mẫu, số tài khoản, bản đồ vùng, sự kiện, trường của cơ sở), xóa, yêu cầu phê duyệt, gửi tín hiệu thử nghiệm, kích hoạt sau khi thử nghiệm thành công và hủy bỏ thay đổi đang chờ (staged).

Kết nối đang hoạt động (active hoặc failing) chỉ thay đổi khi có applyMode: staged giữ báo động trên cài đặt đang áp dụng cho đến khi thử nghiệm thay đổi đang chờ thành công và bạn kích hoạt nó; immediate áp dụng ngay. Các trường bí mật được chấp nhận nhưng không bao giờ được trả về. Cần quyền External Integrations tại cơ sở. Hãy đọc trước bằng alarm_integrations_read connections.

Các hành động:

• save: Lưu kết nối. Cần templateId cho kết nối mới. fields đặt các trường của cơ sở theo khóa (null xóa một trường; giá trị bí mật được niêm phong). Với kết nối đang hoạt động, hãy truyền applyMode, nếu không lệnh gọi sẽ thất bại với apply-mode-required. Cần partnerId. Yêu cầu xác nhận.
• remove: Xóa kết nối. Xóa kết nối của cơ sở với đối tác, cùng mọi thay đổi đang chờ; báo động từ đây sẽ không còn được gửi đến trung tâm giám sát đó. Cần partnerId. Yêu cầu xác nhận.
• request_approval: Yêu cầu phê duyệt. Yêu cầu trung tâm giám sát phê duyệt kết nối hoặc cấp số tài khoản (mẫu cần đối tác phê duyệt). Cần partnerId.
• send_test_signal: Gửi tín hiệu thử nghiệm. Đưa một tín hiệu thử nghiệm thật vào hàng đợi gửi đến trung tâm giám sát; hãy kiểm tra định kỳ test_signal_status. staged: true thử nghiệm thay đổi đang chờ thay vì cài đặt đang áp dụng. Cần partnerId. Yêu cầu xác nhận.
• activate: Kích hoạt kết nối hoặc thay đổi. Đưa kết nối đang chờ vào hoạt động, áp dụng thay đổi đang chờ, hoặc xác nhận thay đổi chưa được thử nghiệm. Kích hoạt cần requestId của một lần thử nghiệm thành công sau lần thay đổi gần nhất: thử nghiệm thay đổi đang chờ (staged: true) áp dụng thay đổi đang chờ, thử nghiệm trên cài đặt đang áp dụng xác nhận thay đổi chưa được thử nghiệm. Cần partnerId, requestId. Yêu cầu xác nhận.
• discard_pending_change: Hủy bỏ thay đổi đang chờ. Loại bỏ thay đổi đang chờ; cài đặt đang áp dụng không bị ảnh hưởng. discarded là false khi không có thay đổi nào đang chờ. Cần partnerId. Yêu cầu xác nhận.

Thêm, thay đổi, xóa và gửi thử các đích báo động tùy chỉnh: bộ thu giám sát của riêng bạn, bo mạch rơ-le, SMS, thoại, email, webhook, chat nhóm hoặc dịch vụ nhắn tin trực (danh sách channel), ở cấp cơ sở (mặc định), thương hiệu hoặc tổ chức.

Cài đặt không bí mật được đặt trong config; giá trị bí mật (mật khẩu, URL webhook, khóa) được đặt trong fields theo đường dẫn cài đặt và được niêm phong, không bao giờ được trả về. Đích đang bật cần có config đầy đủ. Đích cấp cơ sở cần quyền External Integrations hoặc Duress Configuration tại cơ sở đó; đích cấp thương hiệu và tổ chức cần quyền truy cập toàn tổ chức. Hãy đọc trước bằng alarm_integrations_read destinations.

Các hành động:

• save: Lưu đích. Không có connectionId thì thêm đích mới (cần channel và name); có connectionId thì thay đổi đích đó (channel giữ nguyên). config, khi được gửi, sẽ thay thế các cài đặt không bí mật; các giá trị bí mật không có trong fields được giữ nguyên. Yêu cầu xác nhận.
• remove: Xóa đích. Xóa đích; rơ-le của cơ sở cũng ngừng điều khiển rơ-le báo động. Cần connectionId. Yêu cầu xác nhận.
• send_test_signal: Gửi thử nghiệm đến một đích. Đưa một tin nhắn thử nghiệm thật vào hàng đợi gửi đến đích; hãy kiểm tra định kỳ alarm_integrations_read test_signal_status với cơ sở. Đích cấp thương hiệu và tổ chức được thử nghiệm từ facilityId. Cần connectionId. Yêu cầu xác nhận.

Đọc nơi các báo động duress của một cơ sở được gửi đến bên ngoài Performance Hub: các kết nối trung tâm giám sát (đối tác, mẫu, số tài khoản, bản đồ vùng, trạng thái, những điểm còn thiếu để sẵn sàng, thay đổi đang chờ), các đích tùy chỉnh (bộ thu giám sát, rơ-le, SMS, thoại, email, webhook, chat, nhắn tin trực) ở cấp cơ sở, thương hiệu và tổ chức của cơ sở, bản xem trước định tuyến, nhật ký gửi và kết quả tín hiệu thử nghiệm.

Cần quyền External Integrations hoặc Duress Configuration tại cơ sở. Giá trị bí mật và giá trị đã niêm phong không bao giờ được hiển thị, chỉ có { key, secret, hasValue }; số điện thoại và địa chỉ của mọi người được ẩn khỏi dữ liệu định tuyến và gửi. Thời gian theo định dạng ISO. Thay đổi chúng bằng alarm_integrations_connections_write và alarm_integrations_destinations_write.

Các hành động:

• connections: Kết nối trung tâm giám sát. Các kết nối đối tác của cơ sở: mẫu, số tài khoản (linkingIdentifier), bản đồ vùng, sự kiện, connectionStatus, missing (những gì ngăn kết nối đi vào hoạt động), pendingChange (đang chờ, chưa áp dụng) và untestedChange. canEdit: có quyền External Integrations tại đây.
• destinations: Đích tùy chỉnh. Các đích có thể kích hoạt cho cơ sở (của riêng cơ sở, của thương hiệu và tổ chức, mỗi đích có canEdit), hoặc với ownerScope là các đích của một phạm vi. Cài đặt nằm trong config; giá trị bí mật dưới dạng fields { key, secret, hasValue }.
• routing: Xem trước định tuyến. Nơi một báo động sẽ được gửi đến ngay lúc này (chỉ theo cài đặt đang áp dụng), như universal-api xác định: các đích kèm lane, sự kiện và config không bao gồm giá trị bí mật, problems giải thích những gì bị loại ra, và pendingChanges chưa được định tuyến. eventType chỉ giữ lại những đích nhận sự kiện đó.
• deliveries: Nhật ký gửi. Các lần gửi báo động, mới nhất trước (trạng thái, channel, bên nhận, độ trễ, nội dung lỗi công khai). Một trang đã lọc có thể ngắn nhưng vẫn có nextCursor. Cảnh báo thiết bị hiển thị với kind alert.
• test_signal_status: Kết quả tín hiệu thử nghiệm. queued cho đến khi universal-api ghi nhận một lần thử, sau đó là succeeded (bên nhận đã xác nhận hoặc tín hiệu đã được gửi) hoặc failed, kèm các dòng gửi. Hãy dùng cơ sở mà từ đó tín hiệu thử nghiệm được gửi. Cần requestId.