Configuring Notification Channels

Before proceeding with the configuration, make sure you understand the fields that will change based on the notification channel (SMS, Telegram, or Email).

1. SMS Notification Example

Field Breakdown:

Field	Type	Description
channels	array	List of communication channels.
channel	string*	Specifies that the notification will be sent via SMS.
to	string *	The recipient's phone number (e.g., `0763407346`).
metaData	object	Contains additional configuration options for SMS notifications.
retryOnFailure	boolean*	Indicates whether the system should retry sending the SMS if it fails.
subject	string*	The subject or title of the notification. Example: `"OTP"`.
message	string *	The content of the SMS message to be sent to the recipient. Example: `"Your code is 0092"`.
refId	string*	A reference ID for the notification. Example: `"REF0092"`.

When retryOnFailure = true

1st Retry: If the notification fails, the system retry after 5 minutes.

2nd Retry: If it still fails, the system retry 15 minutes later (total 20 minutes from the first failure).

3rd Retry: If it fails again, the system retry 30 minutes later (total 50 minutes from the first failure).

Example Request:

[
  {
    "channels": [
      {
        "channel": "sms",
        "to": "0763407346",
        "metaData": {
          "retryOnFailure": true
        }
      }
    ],
    "subject": "OTP",
    "message": "Your code is 0092",
    "refId": "REF0092"
  }
]

2. Telegram Notification Example

Field Breakdown:

Field	Type	Description
channels	array	List of communication channels.
channel	string*	Specifies that the notification will be sent via Telegram.
to	string*	The recipient’s Telegram ID (e.g., `user_telegram_id`).
metaData	object	Contains additional configuration options for Telegram.
retryOnFailure	boolean*	Indicates whether the system should retry sending the Telegram message if it fails.
parseMode	string*	Defines the message format (e.g., `html` for rich text formatting).

When retryOnFailure = true

1st Retry: If the notification fails, the system retry after 5 minutes.

2nd Retry: If it still fails, the system retry 15 minutes later (total 20 minutes from the first failure).

3rd Retry: If it fails again, the system retry 30 minutes later (total 50 minutes from the first failure).

Example Request:

[
  {
    "channels": [
      {
        "channel": "telegram",
        "to": "user_telegram_id",
        "metaData": {
          "retryOnFailure": true,
          "parseMode": "html"
        }
      }
    ],
    "subject": "OTP",
    "message": "Your code is 0092",
    "refId": "REF0092"
  }
]

3. Email Notification Example

Field Breakdown:

Field	Type	Description
channels	array	List of communication channels.
channel	string*	Specifies that the notification will be sent via Email.
to	string*	The recipient’s email address (e.g., `example@example.com`).
metaData	object	Contains additional configuration options for Email.
retryOnFailure	boolean*	Indicates whether the system should retry sending the email if it fails.
cc	string	Carbon copy recipients
bcc	string	Blind carbon copy recipients
attachments	string	URL to the file to be attached
separateTo	boolean*	Whether to send the message separately to each recipient

When retryOnFailure = true

1st Retry: If the notification fails, the system retry after 5 minutes.

2nd Retry: If it still fails, the system retry 15 minutes later (total 20 minutes from the first failure).

3rd Retry: If it fails again, the system retry 30 minutes later (total 50 minutes from the first failure).

Example Request:

[
  {
    "channels": [
      {
        "channel": "email",
        "to": "example@example.com",
        "metaData": {
          "retryOnFailure": true,
          "cc": "",
          "bcc": "",
          "attachments": "file url",
          "separateTo": false
        }
      }
    ],
    "subject": "OTP",
    "message": "Your code is 0092",
    "refId": "REF0092"
  }
]

Full Example

Configuring Notification Channels#

1. SMS Notification Example#

Field Breakdown:#

Example Request:#

2. Telegram Notification Example#

Field Breakdown:#

3. Email Notification Example#

Field Breakdown:#

Configuring Notification Channels

1. SMS Notification Example

Field Breakdown:

Example Request:

2. Telegram Notification Example

Field Breakdown:

3. Email Notification Example

Field Breakdown: