Start or Stop Emergency Alert API

Start an Emergency Alert

Start an emergency alert.

Applicable Products: All IP Speakers, Paging Adapters, IP Visual Alerters, IP Displays

Minimum Firmware Version: 5.7

URI

POST /api/controls/emergency-alert/start

Payload

Element	Description	Type	Required	Notes
announcement	The ID number of the emergency alert. In the device web interface, this corresponds to the Announcement number under Additional Features → Emergency Alerts. For example, for Announcement 2, the ID is `2`.	integer	Required	Valid values: 1-10

Sample Request 1: Start emergency 1.

curl -X POST \
  -H "Authorization: hmac <user>:<nonce>:<digest>" \
  -H "Content-Md5: <hex_md5>" \
  -H "Content-Type: application/json" \
  -H "Date: <RFC1123_date>" \
  -d '{"announcement":"1"}' \
  http://10.11.12.123/api/controls/emergency-alert/start

Example Response

On success, the device plays the emergency alert.

Stop an Emergency Alert

Stop an ongoing emergency alert.

Applicable Products: All IP Speakers, Paging Adapters, IP Visual Alerters, IP Displays

Minimum Firmware Version: 5.7

URI

POST /api/controls/emergency-alert/stop

Sample Request 1: Stop the ongoing emergency.

curl -X POST \
  -H "Authorization: hmac <user>:<nonce>:<digest>" \
  -H "Content-Md5: <hex_md5>" \
  -H "Content-Type: application/json" \
  -H "Date: <RFC1123_date>" \ 
  http://10.11.12.123/api/controls/emergency-alert/stop

Example Response

On success, the device stops the emergency alert.