When the bluecherry-client is running it is also serving a HTTP RESTful API on port 43770. This service allows for seamless integration into the software running on the edge device. The RESTful API currently exposes CRUD operations on the notification destination list and message (email, SMS, phone and push) sending.
For security reasons the internal bluecherry-client webserver binds to 127.0.0.1. Even without a firewall in place no external LAN/WAN client can access the API exposed by the bluecherry-client. This also removes the need to have authentication enabled by default and it thus makes integration with your application more easy.
All types of messaging uses the same API route, /api/internal/messages. This allows you to use a single API call to send messages to multiple destinations or to send different types of messages. The only exception is when you want to create an email with attachments, because of handling binary data a separate call is required for each email you want to send.
Each of the message types is uniquely identified by their number:
The API is also available as a Postman collection which you can download here: bluecherry-client.postman_collection.json