POportsip
Notification

Update notification settings

Update notification settings.

post/tenant/notification

Request

Request body

type'SMTP' | 'MS365' | 'GMAIL' required

The email server type.
Can be either:

  • SMTP: Use generic SMTP server.
  • MS365 Use Microsoft 365 email service.
  • GMAIL Use Google Gmail service.
serverstring

SMTP server used for sending mails.

portinteger

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

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 required

Username or email address.

passwordstring

Password for email account.

auth'DISABLE' | 'AUTO' | 'LOGIN' | 'PLAIN'

The authentication protocols.
Can be either:

  • DISABLE: Skip authentication mechanism.
  • AUTO: Use auto-selected authentication algorithms by server (Currently only supports LOGIN and PLAIN).
  • LOGIN: Use LOGIN authentication mechanism.
  • PLAIN Use PLAIN authentication mechanism.
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.

Example request

{
  "port": 80
}

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.