Integrasi Alarm
Platform Intialarm_integrations_connections_writeIntegrasi EksternalMenghubungkan fasilitas ke template mitra pemantauan dan mengelola koneksi tersebut: simpan (template, nomor akun, peta zona, peristiwa, kolom fasilitas), hapus, minta persetujuan, kirim sinyal uji, aktifkan setelah uji berhasil, dan buang perubahan yang ditahap.
Koneksi live (active atau failing) hanya berubah dengan applyMode: staged mempertahankan alarm pada pengaturan live hingga uji tahap berhasil dan Anda mengaktifkannya; immediate langsung menerapkannya. Kolom rahasia diterima tetapi tidak pernah dikembalikan. Memerlukan External Integrations di fasilitas. Baca terlebih dahulu dengan alarm_integrations_read connections.
Aksi:
- save: Menyimpan koneksi. templateId diperlukan untuk koneksi baru. fields mengatur kolom fasilitas berdasarkan kunci (null menghapus satu kolom; rahasia disegel). Pada koneksi live, sertakan applyMode, atau panggilan gagal dengan apply-mode-required. Memerlukan partnerId. Meminta konfirmasi.
- remove: Menghapus koneksi. Menghapus koneksi fasilitas ke mitra, beserta perubahan yang ditahap; alarm dari sini tidak lagi dikirim ke pusat pemantauan tersebut. Memerlukan partnerId. Meminta konfirmasi.
- request_approval: Meminta persetujuan. Meminta pusat pemantauan menyetujui koneksi atau menetapkan nomor akun (template partner-approval). Memerlukan partnerId.
- send_test_signal: Mengirim sinyal uji. Mengantrekan sinyal uji sungguhan ke pusat pemantauan; pantau test_signal_status. staged: true menguji perubahan yang ditahap, bukan pengaturan live. Memerlukan partnerId. Meminta konfirmasi.
- activate: Mengaktifkan koneksi atau perubahan. Menjadikan koneksi yang tertunda live, mempromosikan perubahan yang ditahap, atau mengonfirmasi perubahan yang belum diuji. Pengaktifan memerlukan requestId dari uji yang berhasil setelah perubahan terakhir: uji tahap (staged: true) mempromosikan perubahan yang ditahap, uji live mengonfirmasi perubahan yang belum diuji. Memerlukan partnerId, requestId. Meminta konfirmasi.
- discard_pending_change: Membuang perubahan yang ditahap. Menghapus perubahan yang ditahap; pengaturan live tidak tersentuh. discarded bernilai false jika tidak ada yang ditahap. Memerlukan partnerId. Meminta konfirmasi.
Parameter
| Nama | Jenis | Deskripsi |
|---|---|---|
action* | "save" | "remove" | "request_approval" | "send_test_signal" | "activate" | "discard_pending_change" | Tindakan yang akan dilakukan; setiap tindakan dijelaskan dalam deskripsi alat. |
facilityId | string | ID fasilitas. Opsional jika fasilitas yang terhubung adalah fasilitas yang Anda maksud. |
partnerId | string | Mitra pemantauan, dari alarm_integrations_read connections (org#<id> untuk template milik organisasi sendiri) |
templateId | string | Template terbitan yang ditawarkan ke fasilitas ini (save) |
linkingIdentifier | stringnull | Nomor akun yang digunakan pusat pemantauan untuk mengenali fasilitas (save) |
zoneMap | objectnull | Nomor seri tombol ke zona, mis. { "DS-0001": "001" } (save) |
events | arraynull | Jenis peristiwa yang dikirim ke mitra (null: milik template) (save) |
fields | object | Nilai kolom fasilitas berdasarkan kunci; null menghapus satu nilai. Tidak pernah dikembalikan. (save) |
applyMode | "staged" | "immediate" | Koneksi live: staged (uji, lalu aktifkan) atau immediate (save) |
staged | boolean | Uji perubahan yang ditahap (diperlukan sebelum mengaktifkannya) (send_test_signal) |
requestId | string | ID permintaan sinyal uji (tsr_...), dari send_test_signal (activate) |
confirm | boolean | Atur hanya setelah pengguna mengonfirmasi pratinjau yang dikembalikan oleh panggilan pertama |
alarm_integrations_destinations_writeIntegrasi EksternalDuress ConfigurationMenambahkan, mengubah, menghapus, dan menguji tujuan alarm khusus: penerima pemantauan milik Anda sendiri, papan relai, SMS, suara, email, webhook, obrolan tim, atau layanan paging on-call (daftar channel), di tingkat fasilitas (default), merek, atau organisasi.
Pengaturan non-rahasia dimasukkan ke config; rahasia (kata sandi, URL webhook, kunci) dimasukkan ke fields berdasarkan jalur pengaturan dan disegel, tidak pernah dikembalikan. Tujuan yang diaktifkan memerlukan config yang lengkap. Tujuan fasilitas memerlukan External Integrations atau Duress Configuration di sana; tujuan merek dan organisasi memerlukan akses tingkat organisasi. Baca terlebih dahulu dengan alarm_integrations_read destinations.
Aksi:
- save: Menyimpan tujuan. Tanpa connectionId menambahkan tujuan (channel dan name diperlukan); dengan connectionId mengubah tujuan (channel tetap). config, jika dikirim, menggantikan pengaturan non-rahasia; rahasia yang tidak disertakan dalam fields tetap disimpan. Meminta konfirmasi.
- remove: Menghapus tujuan. Menghapus tujuan; relai fasilitas juga berhenti menggerakkan relai alarm. Memerlukan connectionId. Meminta konfirmasi.
- send_test_signal: Mengirim uji ke tujuan. Mengantrekan pesan uji sungguhan ke tujuan; pantau alarm_integrations_read test_signal_status dengan fasilitas tersebut. Tujuan merek dan organisasi diuji dari facilityId. Memerlukan connectionId. Meminta konfirmasi.
Parameter
| Nama | Jenis | Deskripsi |
|---|---|---|
action* | "save" | "remove" | "send_test_signal" | Tindakan yang akan dilakukan; setiap tindakan dijelaskan dalam deskripsi alat. |
facilityId | string | ID fasilitas. Opsional jika fasilitas yang terhubung adalah fasilitas yang Anda maksud. |
ownerScope | string | facility#<id>, brand#<id> atau org#<id> (default: fasilitas) |
connectionId | string | Tujuan yang akan diubah; jangan sertakan untuk menambahkan tujuan |
channel | "cid-csvip" | "sentinel-http" | "relay" | "sms" | "voice" | "email" | "webhook" | "slack" | "teams" | "google-chat" | "pagerduty" | "opsgenie" | Jenis tujuan; tidak dapat diubah setelah dibuat (save) |
name | string | Ditampilkan di pengaturan dan log pengiriman (save) |
enabled | boolean | Default true untuk tujuan baru (save) |
events | arraynull | Jenis peristiwa yang diterimanya (null: default channel) (save) |
guestLink | "shared" | "none" | "null" | Hanya untuk channel SMS, email, dan obrolan tim: shared (satu halaman alarm khusus tampilan, default) atau none (save) |
config | object | Pengaturan non-rahasia untuk channel (save) |
fields | object | Pengaturan rahasia berdasarkan jalur, mis. { "webhookUrl": "https://..." }; null menghapus satu pengaturan (save) |
confirm | boolean | Atur hanya setelah pengguna mengonfirmasi pratinjau yang dikembalikan oleh panggilan pertama |
alarm_integrations_readIntegrasi EksternalDuress ConfigurationMembaca ke mana alarm duress fasilitas dikirim di luar Performance Hub: koneksi pusat pemantauannya (mitra, template, nomor akun, peta zona, status, kekurangan kesiapan, perubahan yang ditahap), tujuan khusus (penerima pemantauan, relai, SMS, suara, email, webhook, obrolan, paging) di fasilitas, merek, dan organisasinya, pratinjau perutean, log pengiriman, dan hasil sinyal uji.
Memerlukan External Integrations atau Duress Configuration di fasilitas. Rahasia dan nilai yang disegel tidak pernah ditampilkan, hanya { key, secret, hasValue }; nomor dan alamat orang disamarkan dari perutean dan pengiriman. Waktu dalam format ISO. Ubah dengan alarm_integrations_connections_write dan alarm_integrations_destinations_write.
Aksi:
- connections: Koneksi pusat pemantauan. Koneksi mitra fasilitas: template, nomor akun (linkingIdentifier), peta zona, peristiwa, connectionStatus, missing (apa yang menghalangi untuk live), pendingChange (ditahap, belum live) dan untestedChange. canEdit: External Integrations di sini.
- destinations: Tujuan khusus. Tujuan yang dapat terpicu untuk fasilitas (milik sendiri, milik merek dan organisasinya, masing-masing dengan canEdit), atau dengan ownerScope, tujuan dari satu cakupan. Pengaturan di config; rahasia sebagai fields { key, secret, hasValue }.
- routing: Pratinjau perutean. Ke mana alarm akan dikirim saat ini (hanya pengaturan live), sebagaimana diselesaikan oleh universal-api: tujuan dengan lane, peristiwa, dan config tanpa rahasia, problems yang menjelaskan apa pun yang tidak disertakan, dan pendingChanges yang belum dirutekan. eventType hanya mempertahankan yang menerima peristiwa tersebut.
- deliveries: Log pengiriman. Pengiriman alarm, terbaru lebih dulu (status, channel, penerima, latensi, kata-kata kesalahan publik). Halaman yang difilter bisa pendek dan tetap memiliki nextCursor. Peringatan perangkat ditampilkan sebagai kind alert.
- test_signal_status: Hasil sinyal uji. queued hingga universal-api mencatat percobaan, lalu succeeded (penerima mengonfirmasi atau sinyal terkirim) atau failed, beserta baris pengiriman. Gunakan fasilitas tempat uji dikirim. Memerlukan requestId.
Parameter
| Nama | Jenis | Deskripsi |
|---|---|---|
action* | "connections" | "destinations" | "routing" | "deliveries" | "test_signal_status" | Tindakan yang akan dilakukan; setiap tindakan dijelaskan dalam deskripsi alat. |
facilityId | string | ID fasilitas. Opsional jika fasilitas yang terhubung adalah fasilitas yang Anda maksud. |
limit | integer | Item per halaman (default 25, maksimal 100) (connections, destinations, deliveries) |
cursor | string | nextCursor dari halaman sebelumnya (connections, destinations, deliveries) |
ownerScope | string | Hanya cakupan ini: brand#<id> atau org#<id> (destinations) |
eventType | string | mis. ph.duress.incident.created (routing, deliveries) |
from | string | Tanggal-waktu ISO, inklusif (deliveries) |
to | string | Tanggal-waktu ISO, eksklusif (deliveries) |
status | array | Salah satu dari sent, acknowledged, failed, shadow (deliveries) |
channel | string | Channel persis, mis. cid-csvip atau sms (deliveries) |
destinationId | string | ID tujuan persis (deliveries) |
incidentId | string | Pengiriman untuk satu alarm (deliveries) |
requestId | string | Pengiriman untuk satu sinyal uji (deliveries, test_signal_status) |
search | string | Teks dalam ID, channel, atau kesalahan apa pun (deliveries) |