Integrasi Penggera

Platform Teras
alarm_integrations_connections_writeIntegrasi Luaran

Menyambungkan kemudahan kepada templat rakan kongsi pemantauan dan mengurus sambungan itu: simpan (templat, nombor akaun, peta zon, peristiwa, medan kemudahan), alih keluar, minta kelulusan, hantar isyarat ujian, aktifkan selepas ujian berjaya, dan buang perubahan berperingkat.

Sambungan langsung (active atau failing) hanya berubah dengan applyMode: staged mengekalkan penggera pada tetapan langsung sehingga ujian berperingkat berjaya dan anda mengaktifkannya; immediate menggunakannya serta-merta. Medan rahsia diterima tetapi tidak pernah dikembalikan. Memerlukan External Integrations di kemudahan itu. Baca dahulu dengan alarm_integrations_read connections.

Tindakan:

  • save: Simpan sambungan. templateId diperlukan untuk sambungan baharu. fields menetapkan medan kemudahan mengikut kunci (null mengosongkan satu; rahsia dimeterai). Pada sambungan langsung, hantar applyMode, jika tidak panggilan gagal dengan apply-mode-required. Memerlukan partnerId. Meminta pengesahan.
  • remove: Alih keluar sambungan. Mengalih keluar sambungan kemudahan kepada rakan kongsi, berserta sebarang perubahan berperingkat; penggera berhenti dihantar ke pusat pemantauan itu dari sini. Memerlukan partnerId. Meminta pengesahan.
  • request_approval: Minta kelulusan. Meminta pusat pemantauan meluluskan sambungan atau menetapkan nombor akaun (templat kelulusan rakan kongsi). Memerlukan partnerId.
  • send_test_signal: Hantar isyarat ujian. Menjadualkan isyarat ujian sebenar ke pusat pemantauan; tinjau test_signal_status. staged: true menguji perubahan berperingkat dan bukannya tetapan langsung. Memerlukan partnerId. Meminta pengesahan.
  • activate: Aktifkan sambungan atau perubahan. Menjadikan sambungan yang belum selesai langsung, menaikkan perubahan berperingkat, atau mengesahkan perubahan yang belum diuji. Pengaktifan memerlukan requestId ujian yang berjaya selepas perubahan terakhir: ujian berperingkat (staged: true) menaikkan perubahan berperingkat, ujian langsung mengesahkan perubahan yang belum diuji. Memerlukan partnerId, requestId. Meminta pengesahan.
  • discard_pending_change: Buang perubahan berperingkat. Menggugurkan perubahan berperingkat; tetapan langsung tidak disentuh. discarded bernilai false apabila tiada apa-apa yang berperingkat. Memerlukan partnerId. Meminta pengesahan.

Parameter

NamaJenisPenerangan
action*"save" | "remove" | "request_approval" | "send_test_signal" | "activate" | "discard_pending_change"Perkara yang hendak dilakukan; setiap tindakan diterangkan dalam penerangan alat.
facilityIdstringID kemudahan. Pilihan jika kemudahan yang disambungkan ialah kemudahan yang Anda maksudkan.
partnerIdstringRakan kongsi pemantauan, daripada alarm_integrations_read connections (org#<id> untuk templat organisasi sendiri)
templateIdstringTemplat diterbitkan yang ditawarkan kepada kemudahan ini (save)
linkingIdentifierstringnullNombor akaun yang digunakan oleh pusat pemantauan untuk mengenal pasti kemudahan (save)
zoneMapobjectnullNombor siri butang kepada zon, cth. { "DS-0001": "001" } (save)
eventsarraynullJenis peristiwa yang dihantar kepada rakan kongsi (null: jenis templat) (save)
fieldsobjectNilai medan kemudahan mengikut kunci; null mengosongkan satu. Tidak pernah dikembalikan. (save)
applyMode"staged" | "immediate"Sambungan langsung: staged (uji, kemudian aktifkan) atau immediate (save)
stagedbooleanUji perubahan berperingkat (diperlukan sebelum mengaktifkannya) (send_test_signal)
requestIdstringID permintaan isyarat ujian (tsr_...), daripada send_test_signal (activate)
confirmbooleanTetapkan hanya selepas pengguna mengesahkan pratonton yang dikembalikan oleh panggilan pertama
alarm_integrations_destinations_writeIntegrasi LuaranDuress Configuration

Menambah, mengubah, memadam dan menguji destinasi penggera tersuai: penerima pemantauan anda sendiri, papan geganti, SMS, suara, e-mel, webhook, sembang pasukan atau perkhidmatan panggilan atas panggilan (senarai channel), di kemudahan (lalai), jenama atau organisasi.

Tetapan bukan rahsia diletakkan dalam config; rahsia (kata laluan, URL webhook, kunci) diletakkan dalam fields mengikut laluan tetapan dan dimeterai, tidak pernah dikembalikan. Destinasi yang didayakan memerlukan config yang lengkap. Destinasi kemudahan memerlukan External Integrations atau Duress Configuration di sana; destinasi jenama dan organisasi memerlukan akses seluruh organisasi. Baca dahulu dengan alarm_integrations_read destinations.

Tindakan:

  • save: Simpan destinasi. Tanpa connectionId, menambah destinasi (channel dan name diperlukan); dengannya, mengubah destinasi (channel kekal). config, apabila dihantar, menggantikan tetapan bukan rahsia; rahsia yang tidak dimasukkan dalam fields dikekalkan. Meminta pengesahan.
  • remove: Padam destinasi. Memadam destinasi; geganti kemudahan juga berhenti mengawal geganti penggera. Memerlukan connectionId. Meminta pengesahan.
  • send_test_signal: Hantar ujian ke destinasi. Menjadualkan mesej ujian sebenar ke destinasi; tinjau alarm_integrations_read test_signal_status dengan kemudahan itu. Destinasi jenama dan organisasi diuji dari facilityId. Memerlukan connectionId. Meminta pengesahan.

Parameter

NamaJenisPenerangan
action*"save" | "remove" | "send_test_signal"Perkara yang hendak dilakukan; setiap tindakan diterangkan dalam penerangan alat.
facilityIdstringID kemudahan. Pilihan jika kemudahan yang disambungkan ialah kemudahan yang Anda maksudkan.
ownerScopestringfacility#<id>, brand#<id> atau org#<id> (lalai: kemudahan)
connectionIdstringDestinasi yang hendak diubah; tinggalkan untuk menambah destinasi baharu
channel"cid-csvip" | "sentinel-http" | "relay" | "sms" | "voice" | "email" | "webhook" | "slack" | "teams" | "google-chat" | "pagerduty" | "opsgenie"Jenis destinasi; ia tidak boleh diubah selepas dicipta (save)
namestringDipaparkan dalam tetapan dan log penghantaran (save)
enabledbooleanLalai true untuk destinasi baharu (save)
eventsarraynullJenis peristiwa yang diterimanya (null: lalai channel) (save)
guestLink"shared" | "none" | "null"Saluran SMS, e-mel dan sembang pasukan sahaja: shared (satu halaman penggera lihat sahaja, lalai) atau none (save)
configobjectTetapan bukan rahsia untuk channel (save)
fieldsobjectTetapan rahsia mengikut laluan, cth. { "webhookUrl": "https://..." }; null mengosongkan satu (save)
confirmbooleanTetapkan hanya selepas pengguna mengesahkan pratonton yang dikembalikan oleh panggilan pertama
alarm_integrations_readIntegrasi LuaranDuress Configuration

Membaca ke mana penggera duress kemudahan dihantar di luar Performance Hub: sambungan pusat pemantauannya (rakan kongsi, templat, nombor akaun, peta zon, status, jurang kesediaan, perubahan berperingkat), destinasi tersuai (penerima pemantauan, geganti, SMS, suara, e-mel, webhook, sembang, panggilan) di kemudahan, jenama dan organisasinya, pratonton penghalaan, log penghantaran dan hasil isyarat ujian.

Memerlukan External Integrations atau Duress Configuration di kemudahan itu. Rahsia dan nilai yang dimeterai tidak pernah dipaparkan, hanya { key, secret, hasValue }; nombor dan alamat orang disunting daripada penghalaan dan penghantaran. Masa dalam format ISO. Ubahnya dengan alarm_integrations_connections_write dan alarm_integrations_destinations_write.

Tindakan:

  • connections: Sambungan pusat pemantauan. Sambungan rakan kongsi kemudahan: templat, nombor akaun (linkingIdentifier), peta zon, peristiwa, connectionStatus, missing (perkara yang menghalang pengaktifan langsung), pendingChange (berperingkat, belum langsung) dan untestedChange. canEdit: External Integrations di sini.
  • destinations: Destinasi tersuai. Destinasi yang boleh dicetuskan untuk kemudahan (miliknya sendiri, milik jenama dan organisasinya, masing-masing dengan canEdit), atau dengan ownerScope, destinasi satu skop. Tetapan dalam config; rahsia sebagai fields { key, secret, hasValue }.
  • routing: Pratonton penghalaan. Ke mana penggera akan dihantar pada masa ini (tetapan langsung sahaja), seperti yang diselesaikan oleh universal-api: destinasi dengan lane, events dan config tanpa rahsia, problems yang menerangkan apa-apa yang ditinggalkan, dan pendingChanges yang belum dihalakan. eventType hanya mengekalkan destinasi yang menerima peristiwa itu.
  • deliveries: Log penghantaran. Penghantaran penggera, yang terbaharu dahulu (status, channel, penerima, kependaman, perkataan ralat awam). Halaman yang ditapis boleh menjadi pendek tetapi masih mempunyai nextCursor. Amaran peranti dipaparkan sebagai kind alert.
  • test_signal_status: Hasil isyarat ujian. queued sehingga universal-api merekodkan percubaan, kemudian succeeded (penerima mengakui atau ia telah dihantar) atau failed, berserta baris penghantaran. Gunakan kemudahan tempat ujian dihantar. Memerlukan requestId.

Parameter

NamaJenisPenerangan
action*"connections" | "destinations" | "routing" | "deliveries" | "test_signal_status"Perkara yang hendak dilakukan; setiap tindakan diterangkan dalam penerangan alat.
facilityIdstringID kemudahan. Pilihan jika kemudahan yang disambungkan ialah kemudahan yang Anda maksudkan.
limitintegerItem setiap halaman (lalai 25, maksimum 100) (connections, destinations, deliveries)
cursorstringnextCursor daripada halaman sebelumnya (connections, destinations, deliveries)
ownerScopestringSkop ini sahaja: brand#<id> atau org#<id> (destinations)
eventTypestringcth. ph.duress.incident.created (routing, deliveries)
fromstringTarikh-masa ISO, inklusif (deliveries)
tostringTarikh-masa ISO, eksklusif (deliveries)
statusarrayMana-mana daripada sent, acknowledged, failed, shadow (deliveries)
channelstringChannel yang tepat, cth. cid-csvip atau sms (deliveries)
destinationIdstringID destinasi yang tepat (deliveries)
incidentIdstringPenghantaran untuk satu penggera (deliveries)
requestIdstringPenghantaran untuk satu isyarat ujian (deliveries, test_signal_status)
searchstringTeks dalam mana-mana ID, channel atau ralat (deliveries)