API Success / Failure Actions

Configuring REST API Requests for a Button

You can assign up to five REST API requests to a single button on the Algo 8450.

When the button is pressed or activated remotely, all associated REST API requests are triggered, enabling you to interact with target devices or applications from a remote location.

There are two ways to associate REST API requests with a button:

• Set Send API Request as the button Action.

• Combine REST API requests with a button action.

  For example, start a SIP call and send REST API requests simultaneously.

Tips

Your device includes a variety of preset screens for API request configurations.

Using a preset screen makes it faster and easier to create API requests.

Related Links:

• Preset Screens for API Configurations

Example Use Case: Using Multiple API Requests in an Emergency Lockdown Scenario

When a button is pressed or activated remotely, trigger the following events:

• Activate Algo ceiling speakers inside the building at a moderate volume to announce the lockdown message.

• Activate Algo horn speakers outside the building at a higher volume to alert people nearby.

• Display an emergency slide on Algo IP displays instructing occupants to follow staff directions.

• Trigger a strobe light in high-noise areas where audio announcements are not heard.

• Unlock a secured exit door via REST API commands to allow safe evacuation.

  This coordinated action ensures that occupants, staff, and emergency responders are all notified immediately through multiple channels — audio, visual, and access control — improving both safety and response times.

To configure API Requests for a button:

1. Log in to the device web interface.

2. While configuring a button in Screens, do one of the following:

   1. Select Send API Request for Action.

   2. Set Enabled for Send API Request.

3. To allow remote activation of this button by other devices using REST API commands, or an inbound SIP extension, enter a unique Identifier for this button.

4. Select Number of API Requests.

5. Select a REST API command from the Command drop-down list.

6. Enter the general command parameters:

   • Data Payload: Data to be sent in the request body.

   • Target: One or more destination device IP addresses or application URLs(comma-delimited).

     For example, 10.12.123.12,10.12.123.12, or prod-20.canadacentral.logic.azure.com:443.

     Note

     You do not need to include the prefix https:// to the target IP address or URL you enter. The 8450 automatically adds the https:// prefix to the target IP or URL.

     To use http instead, include http:// in the IP address or URL to override the default https://prefix.

7. If you selected Other command type, also specify the following:

   • Method: Choose the HTTP method (POST or PUT).

   • Custom Path: Enter the custom API endpoint path. For example, api/custom/alert.

     Note

     Do not include a forward slash (/) at the beginning of your custom path. The 8450 automatically adds a forward slash (/) at the start of the path.

     Including a forward slash manually will cause the path to fail.

     For example, set your Custom Path as api/custom/alert instead of /api/custom/alert.

   • Header: Provide required headers.

     For API calls to Algo devices, select the Algo Standard Authentication Headers.

     For non-Algo devices, select and specify Custom Headers. For example, Content-Type: application/json.

8. To enable Button Protection, select whether users must enter a passcode or confirm the action before triggering it.

9. To customize the API request feedback, select an option for On Success or On Failure:

   

   • No Action: No customized feedback.

   • Show Message: Displays a customized message on the screen.

     You need to configure a message.

   • Show Image: Displays an image on the screen.

     You need to choose an Image.

10. Select Save.