การผสานรวมสัญญาณเตือน

แพลตฟอร์มหลัก

alarm_integrations_connections_writeการผสานรวมภายนอก

เชื่อมต่อสถานที่กับเทมเพลตของพาร์ทเนอร์ผู้ให้บริการเฝ้าระวังและจัดการการเชื่อมต่อนั้น: บันทึก (เทมเพลต หมายเลขบัญชี แผนผังโซน เหตุการณ์ ฟิลด์ของสถานที่) ลบ ขออนุมัติ ส่งสัญญาณทดสอบ เปิดใช้งานหลังการทดสอบสำเร็จ และยกเลิกการเปลี่ยนแปลงที่เตรียมไว้

การเชื่อมต่อที่ใช้งานจริง (active หรือ failing) จะเปลี่ยนได้ด้วย applyMode เท่านั้น: staged จะให้สัญญาณเตือนใช้การตั้งค่าปัจจุบันต่อไปจนกว่าการทดสอบแบบ staged จะสำเร็จและคุณเปิดใช้งาน ส่วน immediate จะมีผลทันที ระบบรับฟิลด์ที่เป็นข้อมูลลับแต่จะไม่ส่งคืน ต้องมีสิทธิ์ External Integrations ที่สถานที่ อ่านข้อมูลก่อนด้วย connections ของ alarm_integrations_read

การดำเนินการ:

save: บันทึกการเชื่อมต่อ ต้องระบุ templateId สำหรับการเชื่อมต่อใหม่ fields กำหนดฟิลด์ของสถานที่ตามคีย์ (null จะล้างค่า ข้อมูลลับจะถูกปิดผนึก) สำหรับการเชื่อมต่อที่ใช้งานจริงให้ส่ง applyMode มิฉะนั้นการเรียกจะล้มเหลวด้วย apply-mode-required ต้องระบุ partnerId ขอการยืนยัน
remove: ลบการเชื่อมต่อ ลบการเชื่อมต่อของสถานที่กับพาร์ทเนอร์ รวมถึงการเปลี่ยนแปลงที่เตรียมไว้ สัญญาณเตือนจากที่นี่จะไม่ส่งไปยังศูนย์เฝ้าระวังนั้นอีก ต้องระบุ partnerId ขอการยืนยัน
request_approval: ขออนุมัติ ขอให้ศูนย์เฝ้าระวังอนุมัติการเชื่อมต่อหรือกำหนดหมายเลขบัญชี (เทมเพลตที่ต้องให้พาร์ทเนอร์อนุมัติ) ต้องระบุ partnerId
send_test_signal: ส่งสัญญาณทดสอบ จัดคิวสัญญาณทดสอบจริงไปยังศูนย์เฝ้าระวัง แล้วตรวจสอบ test_signal_status เป็นระยะ staged: true จะทดสอบการเปลี่ยนแปลงที่เตรียมไว้แทนการตั้งค่าปัจจุบัน ต้องระบุ partnerId ขอการยืนยัน
activate: เปิดใช้งานการเชื่อมต่อหรือการเปลี่ยนแปลง ทำให้การเชื่อมต่อที่รอดำเนินการใช้งานได้จริง เลื่อนการเปลี่ยนแปลงที่เตรียมไว้ขึ้นใช้งาน หรือยืนยันการเปลี่ยนแปลงที่ยังไม่ได้ทดสอบ การเปิดใช้งานต้องมี requestId ของการทดสอบที่สำเร็จหลังการเปลี่ยนแปลงครั้งล่าสุด: การทดสอบแบบ staged (staged: true) จะเลื่อนการเปลี่ยนแปลงที่เตรียมไว้ขึ้นใช้งาน ส่วนการทดสอบแบบ live จะยืนยันการเปลี่ยนแปลงที่ยังไม่ได้ทดสอบ ต้องระบุ partnerId, requestId ขอการยืนยัน
discard_pending_change: ยกเลิกการเปลี่ยนแปลงที่เตรียมไว้ ทิ้งการเปลี่ยนแปลงที่เตรียมไว้ โดยไม่แตะต้องการตั้งค่าปัจจุบัน discarded จะเป็น false เมื่อไม่มีการเปลี่ยนแปลงที่เตรียมไว้ ต้องระบุ partnerId ขอการยืนยัน

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`action`*	`"save" \| "remove" \| "request_approval" \| "send_test_signal" \| "activate" \| "discard_pending_change"`	สิ่งที่ต้องการทำ การดำเนินการแต่ละรายการมีคำอธิบายอยู่ในคำอธิบายของเครื่องมือ
`facilityId`	`string`	ID ของสถานที่ ไม่จำเป็นต้องระบุหากหมายถึงสถานที่ที่เชื่อมต่ออยู่
`partnerId`	`string`	พาร์ทเนอร์ผู้ให้บริการเฝ้าระวัง จาก connections ของ alarm_integrations_read (org#<id> สำหรับเทมเพลตขององค์กรเอง)
`templateId`	`string`	เทมเพลตที่เผยแพร่แล้วซึ่งเปิดให้สถานที่นี้ใช้ (save)
`linkingIdentifier`	`stringnull`	หมายเลขบัญชีที่ศูนย์เฝ้าระวังใช้ระบุสถานที่ (save)
`zoneMap`	`objectnull`	ซีเรียลของปุ่มกับโซน เช่น { "DS-0001": "001" } (save)
`events`	`arraynull`	ประเภทเหตุการณ์ที่ส่งไปยังพาร์ทเนอร์ (null: ตามเทมเพลต) (save)
`fields`	`object`	ค่าฟิลด์ของสถานที่ตามคีย์ null จะล้างค่า ระบบจะไม่ส่งคืนค่าเหล่านี้ (save)
`applyMode`	`"staged" \| "immediate"`	การเชื่อมต่อที่ใช้งานจริง: staged (ทดสอบแล้วจึงเปิดใช้งาน) หรือ immediate (save)
`staged`	`boolean`	ทดสอบการเปลี่ยนแปลงที่เตรียมไว้ (จำเป็นก่อนเปิดใช้งาน) (send_test_signal)
`requestId`	`string`	ID คำขอสัญญาณทดสอบ (tsr_...) จาก send_test_signal (activate)
`confirm`	`boolean`	ตั้งค่าเฉพาะหลังจากผู้ใช้ยืนยันตัวอย่างที่ได้จากการเรียกครั้งแรกแล้วเท่านั้น

alarm_integrations_destinations_writeการผสานรวมภายนอกDuress Configuration

เพิ่ม เปลี่ยน ลบ และทดสอบปลายทางสัญญาณเตือนแบบกำหนดเอง ได้แก่ เครื่องรับสัญญาณเฝ้าระวังของคุณเอง แผงรีเลย์ SMS การโทรด้วยเสียง อีเมล webhook แชตของทีม หรือบริการเรียกตัวผู้ปฏิบัติงานเวร (รายการ channel) ที่ระดับสถานที่ (ค่าเริ่มต้น) แบรนด์ หรือองค์กร

การตั้งค่าที่ไม่ใช่ข้อมูลลับให้ใส่ใน config ส่วนข้อมูลลับ (รหัสผ่าน URL ของ webhook คีย์) ให้ใส่ใน fields ตามเส้นทางการตั้งค่า ซึ่งจะถูกปิดผนึกและไม่ส่งคืน ปลายทางที่เปิดใช้งานต้องมี config ครบถ้วน ปลายทางระดับสถานที่ต้องมีสิทธิ์ External Integrations หรือ Duress Configuration ที่นั่น ส่วนปลายทางระดับแบรนด์และองค์กรต้องมีสิทธิ์เข้าถึงทั่วทั้งองค์กร อ่านข้อมูลก่อนด้วย destinations ของ alarm_integrations_read

การดำเนินการ:

save: บันทึกปลายทาง หากไม่มี connectionId จะเพิ่มปลายทางใหม่ (ต้องระบุ channel และ name) หากมีจะเปลี่ยนปลายทางนั้น (channel คงเดิม) เมื่อส่ง config จะแทนที่การตั้งค่าที่ไม่ใช่ข้อมูลลับ ข้อมูลลับที่ไม่ได้ส่งใน fields จะคงไว้ ขอการยืนยัน
remove: ลบปลายทาง ลบปลายทาง และรีเลย์ของสถานที่จะหยุดควบคุมรีเลย์สัญญาณเตือนด้วย ต้องระบุ connectionId ขอการยืนยัน
send_test_signal: ส่งการทดสอบไปยังปลายทาง จัดคิวข้อความทดสอบจริงไปยังปลายทาง แล้วตรวจสอบ test_signal_status ของ alarm_integrations_read กับสถานที่เป็นระยะ ปลายทางระดับแบรนด์และองค์กรจะทดสอบจาก facilityId ต้องระบุ connectionId ขอการยืนยัน

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`action`*	`"save" \| "remove" \| "send_test_signal"`	สิ่งที่ต้องการทำ การดำเนินการแต่ละรายการมีคำอธิบายอยู่ในคำอธิบายของเครื่องมือ
`facilityId`	`string`	ID ของสถานที่ ไม่จำเป็นต้องระบุหากหมายถึงสถานที่ที่เชื่อมต่ออยู่
`ownerScope`	`string`	facility#<id>, brand#<id> หรือ org#<id> (ค่าเริ่มต้น: สถานที่)
`connectionId`	`string`	ปลายทางที่จะเปลี่ยน ไม่ต้องส่งเพื่อเพิ่มปลายทางใหม่
`channel`	`"cid-csvip" \| "sentinel-http" \| "relay" \| "sms" \| "voice" \| "email" \| "webhook" \| "slack" \| "teams" \| "google-chat" \| "pagerduty" \| "opsgenie"`	ประเภทปลายทาง ซึ่งเปลี่ยนไม่ได้หลังสร้างแล้ว (save)
`name`	`string`	แสดงในการตั้งค่าและบันทึกการส่ง (save)
`enabled`	`boolean`	ค่าเริ่มต้นเป็น true สำหรับปลายทางใหม่ (save)
`events`	`arraynull`	ประเภทเหตุการณ์ที่ปลายทางได้รับ (null: ค่าเริ่มต้นของ channel) (save)
`guestLink`	`"shared" \| "none" \| "null"`	เฉพาะ channel SMS อีเมล และแชตของทีม: shared (หน้าสัญญาณเตือนแบบดูอย่างเดียวหนึ่งหน้า ซึ่งเป็นค่าเริ่มต้น) หรือ none (save)
`config`	`object`	การตั้งค่าที่ไม่ใช่ข้อมูลลับของ channel (save)
`fields`	`object`	การตั้งค่าที่เป็นข้อมูลลับตามเส้นทาง เช่น { "webhookUrl": "https://..." } null จะล้างค่า (save)
`confirm`	`boolean`	ตั้งค่าเฉพาะหลังจากผู้ใช้ยืนยันตัวอย่างที่ได้จากการเรียกครั้งแรกแล้วเท่านั้น

alarm_integrations_readการผสานรวมภายนอกDuress Configuration

อ่านว่าสัญญาณเตือน Duress ของสถานที่ถูกส่งไปที่ใดนอก Performance Hub: การเชื่อมต่อกับศูนย์เฝ้าระวัง (พาร์ทเนอร์ เทมเพลต หมายเลขบัญชี แผนผังโซน สถานะ สิ่งที่ยังขาดก่อนพร้อมใช้งาน การเปลี่ยนแปลงที่เตรียมไว้) ปลายทางแบบกำหนดเอง (เครื่องรับสัญญาณเฝ้าระวัง รีเลย์ SMS การโทรด้วยเสียง อีเมล webhook แชต การเรียกตัว) ที่ระดับสถานที่ แบรนด์ และองค์กร ตัวอย่างการกำหนดเส้นทาง บันทึกการส่ง และผลของสัญญาณทดสอบ

ต้องมีสิทธิ์ External Integrations หรือ Duress Configuration ที่สถานที่ ข้อมูลลับและค่าที่ถูกปิดผนึกจะไม่แสดง แสดงเพียง { key, secret, hasValue } หมายเลขโทรศัพท์และที่อยู่ของบุคคลจะถูกปกปิดในข้อมูลการกำหนดเส้นทางและการส่ง เวลาอยู่ในรูปแบบ ISO เปลี่ยนแปลงข้อมูลด้วย alarm_integrations_connections_write และ alarm_integrations_destinations_write

การดำเนินการ:

connections: การเชื่อมต่อกับศูนย์เฝ้าระวัง การเชื่อมต่อพาร์ทเนอร์ของสถานที่: เทมเพลต หมายเลขบัญชี (linkingIdentifier) แผนผังโซน เหตุการณ์ connectionStatus, missing (สิ่งที่ขัดขวางการใช้งานจริง), pendingChange (เตรียมไว้ ยังไม่ใช้งานจริง) และ untestedChange canEdit: มีสิทธิ์ External Integrations ที่นี่
destinations: ปลายทางแบบกำหนดเอง ปลายทางที่อาจทำงานสำหรับสถานที่ (ของสถานที่เอง ของแบรนด์ และขององค์กร แต่ละรายการมี canEdit) หรือเฉพาะขอบเขตเดียวเมื่อระบุ ownerScope การตั้งค่าอยู่ใน config ข้อมูลลับแสดงเป็น fields { key, secret, hasValue }
routing: ตัวอย่างการกำหนดเส้นทาง สัญญาณเตือนจะไปที่ใดในขณะนี้ (การตั้งค่าปัจจุบันเท่านั้น) ตามที่ universal-api ประมวลผล: ปลายทางพร้อม lane เหตุการณ์ และ config โดยไม่รวมข้อมูลลับ problems ที่อธิบายสิ่งที่ถูกตัดออก และ pendingChanges ที่ยังไม่ได้กำหนดเส้นทาง eventType จะเก็บเฉพาะปลายทางที่ได้รับเหตุการณ์นั้น
deliveries: บันทึกการส่ง การส่งสัญญาณเตือนเรียงจากใหม่ไปเก่า (สถานะ channel ผู้รับ เวลาแฝง ข้อความข้อผิดพลาดแบบสาธารณะ) หน้าที่กรองแล้วอาจมีรายการน้อยแต่ยังมี nextCursor การแจ้งเตือนอุปกรณ์จะแสดงเป็น kind alert
test_signal_status: ผลของสัญญาณทดสอบ เป็น queued จนกว่า universal-api จะบันทึกความพยายามส่ง จากนั้นเป็น succeeded (ผู้รับตอบรับหรือส่งสำเร็จแล้ว) หรือ failed พร้อมแถวข้อมูลการส่ง ให้ใช้สถานที่ที่ส่งการทดสอบ ต้องระบุ requestId

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`action`*	`"connections" \| "destinations" \| "routing" \| "deliveries" \| "test_signal_status"`	สิ่งที่ต้องการทำ การดำเนินการแต่ละรายการมีคำอธิบายอยู่ในคำอธิบายของเครื่องมือ
`facilityId`	`string`	ID ของสถานที่ ไม่จำเป็นต้องระบุหากหมายถึงสถานที่ที่เชื่อมต่ออยู่
`limit`	`integer`	จำนวนรายการต่อหน้า (ค่าเริ่มต้น 25 สูงสุด 100) (connections, destinations, deliveries)
`cursor`	`string`	nextCursor จากหน้าก่อนหน้า (connections, destinations, deliveries)
`ownerScope`	`string`	เฉพาะขอบเขตนี้: brand#<id> หรือ org#<id> (destinations)
`eventType`	`string`	เช่น ph.duress.incident.created (routing, deliveries)
`from`	`string`	วันที่และเวลาแบบ ISO รวมค่านี้ (deliveries)
`to`	`string`	วันที่และเวลาแบบ ISO ไม่รวมค่านี้ (deliveries)
`status`	`array`	ค่าใดก็ได้จาก sent, acknowledged, failed, shadow (deliveries)
`channel`	`string`	channel ที่ตรงกันทุกตัวอักษร เช่น cid-csvip หรือ sms (deliveries)
`destinationId`	`string`	ID ปลายทางที่ตรงกันทุกตัวอักษร (deliveries)
`incidentId`	`string`	การส่งของสัญญาณเตือนหนึ่งรายการ (deliveries)
`requestId`	`string`	การส่งของสัญญาณทดสอบหนึ่งรายการ (deliveries, test_signal_status)
`search`	`string`	ข้อความใน ID, channel หรือข้อผิดพลาดใดก็ได้ (deliveries)