Notification
Manage notification functions.
Retrieve details of notification settings.
GET /api/tenant/notification HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"type": "SMTP",
"server": "text",
"port": 80,
"reply_to": "text",
"username": "text",
"auth": "AUTO",
"enable_tls_ssl": true,
"enable_starttls_auto": false,
"recipients": "text",
"enable_system_email_server": true,
"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.
The email server type.
Can be either:
SMTP
: Use generic SMTP server.MS365
Use Microsoft 365 email service.GMAIL
Use Google Gmail service.
SMTP server used for sending mails.
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
80
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.
Username or email address.
Password for email account.
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.
AUTO
Possible values: Whether to enable TLS/SSL.
true
Whether StartTLS is automatically enabled.
false
Comma-separated list of email address that should receive notifications.
Allow up to 15 email addresses.
Notify via email when user registered.
false
Notify queue manager via email when SLA time has been breached.
false
Notify queue manager via email when callback has been made.
false
Notify queue manager via email when callback failed.
false
Notify queue Manager via email when call lost.
false
POST /api/tenant/notification HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 345
{
"type": "SMTP",
"server": "text",
"port": 80,
"reply_to": "text",
"username": "text",
"password": "text",
"auth": "AUTO",
"enable_tls_ssl": true,
"enable_starttls_auto": false,
"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
}
No content
Check email server configurations by sending testing email.
The recipient's e-mail address.
Mail subject.
Mail content.
POST /api/tenant/notification/test_email HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 54
{
"recipient": "text",
"subject": "text",
"content": "text"
}
No content
List all of default email templates
GET /api/default_email_templates HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"items": [
{
"name": "USER_CREATION",
"from": "text",
"subject": "text",
"body": "text"
}
]
}
Get details of default template by name.
Name of the email template:
Can be either:
USER_CREATION
: user creation notification.QUEUE_CALL_LOST
: call queue call lost notification.QUEUE_SLA
: call queue sla time reached notification.QUEUE_CALLBACK
: call queue callback notification.QUEUE_CALLBACK_FAILED
: call queue callback failed notification.VOICEMAIL_RECEIVED
: received voicemail notification.CALL_REPORT_COMPLETED
: call report completed notification.DISK_LOW
: low disk notification.EMERGENCY_CALL
: emergency call notification.LICENSE_LIMITED
: license limited notification.RECHARGE
: recharge notification.CONFERENCE_INVITATION
: meeting invitation notification.TRUNK_CONNECTED
: trunk connected notification.TRUNK_DISCONNECTED
: trunk disconnected notification.
GET /api/default_email_templates/{name} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"name": "USER_CREATION",
"from": "text",
"subject": "text",
"body": "text"
}
List all of custom email templates
GET /api/custom_email_templates HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"items": [
{
"name": "USER_CREATION",
"from": "text",
"subject": "text",
"body": "text"
}
]
}
Create custom email template.
Name of the email template:
Can be either:
USER_CREATION
: user creation notification.QUEUE_CALL_LOST
: call queue call lost notification.QUEUE_SLA
: call queue sla time reached notification.QUEUE_CALLBACK
: call queue callback notification.QUEUE_CALLBACK_FAILED
: call queue callback failed notification.VOICEMAIL_RECEIVED
: received voicemail notification.CALL_REPORT_COMPLETED
: call report completed notification.DISK_LOW
: low disk notification.EMERGENCY_CALL
: emergency call notification.LICENSE_LIMITED
: license limited notification.RECHARGE
: recharge notification.CONFERENCE_INVITATION
: meeting invitation notification.TRUNK_CONNECTED
: trunk connected notification.TRUNK_DISCONNECTED
: trunk disconnected notification.
Notification email from field.
Notification email subject field.
Notification email body.
POST /api/custom_email_templates HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 69
{
"name": "USER_CREATION",
"from": "text",
"subject": "text",
"body": "text"
}
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}
Get details of custom template by name.
Name of the email template:
Can be either:
USER_CREATION
: user creation notification.QUEUE_CALL_LOST
: call queue call lost notification.QUEUE_SLA
: call queue sla time reached notification.QUEUE_CALLBACK
: call queue callback notification.QUEUE_CALLBACK_FAILED
: call queue callback failed notification.VOICEMAIL_RECEIVED
: received voicemail notification.CALL_REPORT_COMPLETED
: call report completed notification.DISK_LOW
: low disk notification.EMERGENCY_CALL
: emergency call notification.LICENSE_LIMITED
: license limited notification.RECHARGE
: recharge notification.CONFERENCE_INVITATION
: meeting invitation notification.TRUNK_CONNECTED
: trunk connected notification.TRUNK_DISCONNECTED
: trunk disconnected notification.
GET /api/custom_email_templates/{name} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"name": "USER_CREATION",
"from": "text",
"subject": "text",
"body": "text"
}
Update custom email template.
Name of the email template:
Can be either:
USER_CREATION
: user creation notification.QUEUE_CALL_LOST
: call queue call lost notification.QUEUE_SLA
: call queue sla time reached notification.QUEUE_CALLBACK
: call queue callback notification.QUEUE_CALLBACK_FAILED
: call queue callback failed notification.VOICEMAIL_RECEIVED
: received voicemail notification.CALL_REPORT_COMPLETED
: call report completed notification.DISK_LOW
: low disk notification.EMERGENCY_CALL
: emergency call notification.LICENSE_LIMITED
: license limited notification.RECHARGE
: recharge notification.CONFERENCE_INVITATION
: meeting invitation notification.TRUNK_CONNECTED
: trunk connected notification.TRUNK_DISCONNECTED
: trunk disconnected notification.
Notification email from field.
Notification email subject field.
Notification email body.
POST /api/custom_email_templates/{name} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 46
{
"from": "text",
"subject": "text",
"body": "text"
}
No content