Skip to main content

Documentation Index

Fetch the complete documentation index at: https://alphabet-06152314.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint returns the current communication module configuration, showing which channels are active and what diagnostic settings are in use. It is read-only — use it to inspect the live configuration before dispatching messages or to verify that a channel is enabled. The endpoint requires the AdminOnly authorization policy.

​
Endpoint

GET /api/v1/communications/configuration
Authorization: AdminOnly No request body or query parameters are accepted.

​
Response

200 OK — returns CommunicationConfigurationDto.
​
enabledChannels
string[]
The list of communication channels currently active (e.g. ["Email", "Sms", "InApp"]). Only channels in this list can be targeted by the send endpoint.
​
defaultChannel
string
The channel used when none is specified in a dispatch request. This is always one of the values in enabledChannels.
​
enableDetailedLogging
boolean
When true, the module writes verbose per-channel logs for every dispatch attempt. Useful for diagnosing delivery failures in non-production environments.
400 Bad Request — returns ProblemDetails if the configuration could not be loaded.

​
Example

curl -X GET "https://api.example.com/api/v1/communications/configuration" \
  -H "Authorization: Bearer <admin-token>"

​
Example response

{
  "enabledChannels": ["Email", "Sms", "InApp"],
  "defaultChannel": "Email",
  "enableDetailedLogging": false
}

​
Changing the configuration

This endpoint is read-only. To change which channels are enabled or to toggle detailed logging, update the Communication section in appsettings.json and restart the API.
Disabling a channel in appsettings.json will cause any send request that targets that channel to fail at dispatch time. Check this endpoint after a configuration change to confirm the expected channels are active.