Alarmbridge Service - API Overview

This API overview provides a detailed summary of tools for provisioning, managing, and integrating the Alarmbridge Service, enabling robust alarm handling, advanced session control, and real-time event-based responses within alarm and ARC systems.

The Service Provisioning API is essential for setting up and configuring the Alarmbridge Service for your domain. It allows you to define event receivers, map event senders, and configure protocol-specific endpoints, providing the foundation for alarm reception and delivery. By using this API the Alarmbridge Service can handle alarm events, manage sessions, and route alarms to ARC systems or specified applications.

• Main Endpoints

  • POST /provisioning/alarmbridge/{domain}

    Sets up the event receiver for the specified domain, allowing the Alarmbridge Service to receive incoming alarm events. Configure this endpoint to specify the receiver's protocol and destination address (e.g., SIP address or phone number) for incoming events.

  • POST /provisioning/alarmeventmapper/{domain}

    Sets up the event sender to route alarm events to target destinations. Map outgoing alarms to SIP addresses, phone numbers, or REST callback URLs based on the required protocol.

The API endpoints for Application Integration allow you to manage and control active alarm sessions, handle in-call commands, clear down sessions, and initiate new alarm events. These APIs support real-time alarm handling and integration within ARC platforms and alarm applications.

• Main Endpoints

  • POST /{domain}/devicecommand

    Sends in-call commands for an ongoing alarm session, allowing remote control of session settings. Use this API to issue commands such as volume adjustments or switching between one-way and two-way communication.

  • POST /{domain}/hangupalarmcall

    Clears down an ongoing alarm session, ending the alarm call and closing the session cleanly once the alarm communication is resolved.

  • POST /{domain}/sendalarmevent

    Sends an alarm event to a specified destination, using the designated protocol. This endpoint allows you to initiate an alarm and route it to a specified ARC platform or endpoint.

The REST Callbacks for Application Integration provide event-driven notifications, keeping your application updated on alarm event status in real time. By handling these callbacks, you can monitor alarm event receiving, verify delivery, and manage failures as they occur.

• Main Callbacks

  • POST /newAlarmbridgeEvent

    Triggered when an alarm event is received by a provisioned event receiver, confirming that the Alarmbridge Service has processed the incoming alarm event. Use this callback to track new alarm events and initiate application-based responses.

  • POST /alarmSent

    Triggered when an alarm event sent via the /sendalarmevent API is successfully delivered to the specified destination. This callback provides confirmation of delivery, allowing for logging and verification that the alarm reached the intended endpoint.

  • POST /alarmSendFailure

    Triggered when an alarm event sent via the /sendalarmevent API fails to be delivered. Use this callback to track failures and initiate retries or troubleshooting actions to ensure successful alarm transmission.

These APIs and callbacks provide a comprehensive framework for configuring, integrating, and monitoring alarm communication events with the Alarmbridge Service, enabling seamless, real-time management of alarm interactions across ARC platforms and alarm devices.