Copyright (C) 2018-2023 The Open Library Foundation
This software is distributed under the terms of the Apache License, Version 2.0. See the file "LICENSE" for more information.
Sending messages through delivery channels
The module acts as an intermediary that sorts the prepared messages, sends them through the appropriate delivery channels. All technical complexity, sending queues, persistence of messages, available sending channels are regulated by this module. Module provide single REST endpoint - POST /message-delivery for delivering message by using available delivery channels.
POST /message-delivery
Required permission: "sender.message-delivery"
Request body example:
{
"notificationId": "c276e2ed-cc4b-4e3f-ad36-91aa3a4f4c2a",
"recipientUserId": "33c59afd-9970-4205-9198-84eba036d105",
"messages": [
{
"deliveryChannel": "email",
"header": "Your FOLIO password changed",
"body": "Dear Alex,\n\nYour password has been changed.",
"outputFormat": "text/plain"
},
{
"deliveryChannel": "mail",
"header": "Your FOLIO password changed",
"body": "Dear Alex, Your password has been changed.",
"outputFormat": "text/plain"
}
]
}
The raml-module-builder framework.
Other modules.
Other FOLIO Developer documentation is at dev.folio.org
See project MODSENDER at the FOLIO issue tracker.
See the built target/ModuleDescriptor.json for the interfaces that this module
requires and provides, the permissions, and the additional module metadata.
This module's API documentation.
The built artifacts for this module are available. See configuration for repository access, and the Docker image.