Notification

Retrieve notification settings

Retrieve details of notification settings.

GEThttp://127.0.0.1:8888/api/tenant/notification

Response

Body

serverstring

SMTP server used for sending mails.

portinteger (int32)

A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535. For TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port

Example: 80

reply_tostring

A Reply-To address is identified by inserting the Reply-To header in your email.
It is the email address that the reply message is sent when you want the reply to go to an email address that is different than the From: address.

usernamestring

Username or email address.

authenum

The authorization protocols.
Can be either:

LOGIN: Use LOGIN authorization protocol.
PLAIN Use PLAIN authorization protocol.

LOGINPLAIN

enable_tls_sslboolean

Whether to enable TLS/SSL.

enable_starttls_autoboolean

Whether StartTLS is automatically enabled.

recipientsstring

Comma-separated list of email address that should receive notifications.
Allow up to 15 email addresses.

notify_user_registrationboolean

Notify via email when user registered.

notify_queue_sla_breachedboolean

Notify queue manager via email when SLA time has been breached.

notify_queue_callbackboolean

Notify queue manager via email when callback has been made.

notify_queue_callback_failedboolean

Notify queue manager via email when callback failed.

notify_queue_call_lostboolean

Notify queue Manager via email when call lost.

Request

const response = await fetch('http://127.0.0.1:8888/api/tenant/notification', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "server": "text",
  "port": 80,
  "reply_to": "text",
  "username": "text",
  "auth": "LOGIN",
  "enable_tls_ssl": true,
  "enable_starttls_auto": true,
  "recipients": "text",
  "notify_user_registration": false,
  "notify_queue_sla_breached": false,
  "notify_queue_callback": false,
  "notify_queue_callback_failed": false,
  "notify_queue_call_lost": false
}

Update notification settings

Update notification settings.

POSThttp://127.0.0.1:8888/api/tenant/notification

Body

serverstring

SMTP server used for sending mails.

portinteger (int32)

Example: 80

reply_tostring

usernamestring

Username or email address.

passwordstring

Password for email account.

authenum

The authorization protocols.
Can be either:

LOGIN: Use LOGIN authorization protocol.
PLAIN Use PLAIN authorization protocol.

LOGINPLAIN

enable_tls_sslboolean

Whether to enable TLS/SSL.

enable_starttls_autoboolean

Whether StartTLS is automatically enabled.

recipientsstring

Comma-separated list of email address that should receive notifications.
Allow up to 15 email addresses.

notify_user_registrationboolean

Notify via email when user registered.

notify_queue_sla_breachedboolean

Notify queue manager via email when SLA time has been breached.

notify_queue_callbackboolean

Notify queue manager via email when callback has been made.

notify_queue_callback_failedboolean

Notify queue manager via email when callback failed.

notify_queue_call_lostboolean

Notify queue Manager via email when call lost.

Response

Request

const response = await fetch('http://127.0.0.1:8888/api/tenant/notification', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

PreviousStatus NextPassword policy

{ "server": "text", "port": 80, "reply_to": "text", "username": "text", "auth": "LOGIN", "enable_tls_ssl": true, "enable_starttls_auto": true, "recipients": "text", "notify_user_registration": false, "notify_queue_sla_breached": false, "notify_queue_callback": false, "notify_queue_callback_failed": false, "notify_queue_call_lost": false }