Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Notification

Manage notification functions.

List system email templates

get

List all of system email templates

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

OK

application/json
get/admin/email_templates
GET /api/admin/email_templates HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "name": "HARD_DISK_EXCEEDED",
      "from": "",
      "subject": "Low System Disk Space",
      "body": "%%DATE_TIME%%: your PBX server [%%PBX_WEB_DOMAIN%%] disk remaining free space is critically low. Used: %%USED_SIZE%% G; free: %%FREE_SIZE%% G.\n",
      "protected": true
    }
  ]
}

Retrieve a custom email template by its name.

get

This API fetches the details of a custom email template (protected=false) based on its name.

  • System default templates (protected=true) will not be returned.

  • If no custom template exists with the given name, the API returns a 404 Not Found.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
namestring · enumRequired

The name of the system email template.
Can be either:

  • 2FA_VERIFICATION: Authentication with two factor notification.
  • CPU_EXCEEDED: CPU usage exceeded threshold notification.
  • HARD_DISK_EXCEEDED: Hard disk usage exceeded threshold notification.
  • IP_BLOCKED: IP adddredd blocked notification.
  • LICENSE_LIMIT: License limited notification.
  • MEMORY_EXCEEDED: Memory usage exceeded threshold notification.
  • RESET_PASSWORD: Reset password notification.
  • SERVICE_CONNECTED: Service connected notification.
  • SERVICE_DISCONNECTED: Service disconnected notification.
  • TENANT_DISK_QUOTA_LIMIT_REACHED: Tenant disk quota limited notification.
  • TRUNK_CALL_LIMIT_REACHED: Trunk call limited notification.
  • TRUNK_CONNECTED: Trunk connected notification.
  • TRUNK_DISCONNECTED: Trunk disconnected notification.
  • UPDATE_PUSH_CERTS_FAILED: Update push certificates failed notification.
  • WEBHOOK_QUEUE_TOO_LARGE: Webhook queue full notification.
Example: IP_BLOCKEDPossible values:
Responses
200

OK

application/json
namestring · enumOptional

The name of the system email template.
Can be either:

  • 2FA_VERIFICATION: Authentication with two factor notification.
  • CPU_EXCEEDED: CPU usage exceeded threshold notification.
  • HARD_DISK_EXCEEDED: Hard disk usage exceeded threshold notification.
  • IP_BLOCKED: IP adddredd blocked notification.
  • LICENSE_LIMIT: License limited notification.
  • MEMORY_EXCEEDED: Memory usage exceeded threshold notification.
  • RESET_PASSWORD: Reset password notification.
  • SERVICE_CONNECTED: Service connected notification.
  • SERVICE_DISCONNECTED: Service disconnected notification.
  • TENANT_DISK_QUOTA_LIMIT_REACHED: Tenant disk quota limited notification.
  • TRUNK_CALL_LIMIT_REACHED: Trunk call limited notification.
  • TRUNK_CONNECTED: Trunk connected notification.
  • TRUNK_DISCONNECTED: Trunk disconnected notification.
  • UPDATE_PUSH_CERTS_FAILED: Update push certificates failed notification.
  • WEBHOOK_QUEUE_TOO_LARGE: Webhook queue full notification.
Example: IP_BLOCKEDPossible values:
bodystringOptional

Notification email body.

subjectstringOptional

Notification email subject field.

fromstringOptional

Notification email from field.

protectedbooleanOptional

Indicates whether the template is system-protected:

  • true: System default template (read-only, cannot be modified)
  • false: Custom template (editable)
Example: true
get/admin/email_templates/{name}
GET /api/admin/email_templates/{name} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "HARD_DISK_EXCEEDED",
  "from": "PBX System <system@pbx.com>",
  "subject": "Low System Disk Space",
  "body": "%%DATE_TIME%%: your PBX server [%%PBX_WEB_DOMAIN%%] disk remaining free space is critically low. Used: %%USED_SIZE%% G; free: %%FREE_SIZE%% G.\n",
  "protected": false
}

Update a custom email template.

post

This API updates an custom system email template.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
namestring · enumRequired

The name of the system email template.
Can be either:

  • 2FA_VERIFICATION: Authentication with two factor notification.
  • CPU_EXCEEDED: CPU usage exceeded threshold notification.
  • HARD_DISK_EXCEEDED: Hard disk usage exceeded threshold notification.
  • IP_BLOCKED: IP adddredd blocked notification.
  • LICENSE_LIMIT: License limited notification.
  • MEMORY_EXCEEDED: Memory usage exceeded threshold notification.
  • RESET_PASSWORD: Reset password notification.
  • SERVICE_CONNECTED: Service connected notification.
  • SERVICE_DISCONNECTED: Service disconnected notification.
  • TENANT_DISK_QUOTA_LIMIT_REACHED: Tenant disk quota limited notification.
  • TRUNK_CALL_LIMIT_REACHED: Trunk call limited notification.
  • TRUNK_CONNECTED: Trunk connected notification.
  • TRUNK_DISCONNECTED: Trunk disconnected notification.
  • UPDATE_PUSH_CERTS_FAILED: Update push certificates failed notification.
  • WEBHOOK_QUEUE_TOO_LARGE: Webhook queue full notification.
Example: IP_BLOCKEDPossible values:
Body
bodystringRequired

Notification email body.

subjectstringRequired

Notification email subject field.

fromstringRequired

Notification email from field.

Responses
200

OK

No content
post/admin/email_templates/{name}
POST /api/admin/email_templates/{name} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 226

{
  "from": "PBX System <system@pbx.com>",
  "subject": "Low System Disk Space",
  "body": "%%DATE_TIME%%: your PBX server [%%PBX_WEB_DOMAIN%%] disk remaining free space is critically low. Used: %%USED_SIZE%% G; free: %%FREE_SIZE%% G.\n"
}
No content

Retrieve notification settings

get

Retrieve details of notification settings.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

OK

application/json
typestring · enumOptional

The email server type.
Can be either:

  • SMTP: Use generic SMTP server.
  • MS365 Use Microsoft 365 email service.
  • GMAIL Use Google Gmail service.
Possible values:
serverstringOptional

SMTP server used for sending mails.

portinteger · int32 · max: 65535Optional

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_tostringOptional

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 · max: 128Optional

Username or email address.

authstring · enumOptional

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.
Default: AUTOPossible values:
enable_tls_sslbooleanOptional

Whether to enable TLS/SSL.

Default: true
enable_starttls_autobooleanOptional

Whether StartTLS is automatically enabled.

Default: false
recipientsstringOptional

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

enable_system_email_serverbooleanRead-onlyOptional

Has ability to use system email server settings to send notifications.

notify_user_registrationbooleanOptional

Notify via email when user registered.

Default: false
notify_queue_sla_breachedbooleanOptional

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

Default: false
notify_queue_callbackbooleanOptional

Notify queue manager via email when callback has been made.

Default: false
notify_queue_callback_failedbooleanOptional

Notify queue manager via email when callback failed.

Default: false
notify_queue_call_lostbooleanOptional

Notify queue Manager via email when call lost.

Default: false
notify_emergency_callbooleanOptional

Send a notification email when emergency number dialed.

Default: true
notify_license_limitedbooleanOptional

Send a notification email when license limit reached.

Default: true
notify_trunk_call_limitedbooleanOptional

Send a notification email when trunk call limited reached.

Default: true
get/tenant/notification
GET /api/tenant/notification HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "type": "SMTP",
  "server": "",
  "port": 1000,
  "reply_to": "",
  "username": "example",
  "auth": "AUTO",
  "enable_tls_ssl": true,
  "enable_starttls_auto": true,
  "recipients": "",
  "enable_system_email_server": false,
  "notify_user_registration": true,
  "notify_queue_sla_breached": false,
  "notify_queue_callback": false,
  "notify_queue_callback_failed": false,
  "notify_queue_call_lost": false,
  "notify_emergency_call": true,
  "notify_license_limited": true,
  "notify_trunk_call_limited": true
}

Update notification settings

post

Update notification settings.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
typestring · enumRequired

The email server type.
Can be either:

  • SMTP: Use generic SMTP server.
  • MS365 Use Microsoft 365 email service.
  • GMAIL Use Google Gmail service.
Possible values:
serverstringOptional

SMTP server used for sending mails.

portinteger · int32 · max: 65535Optional

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_tostringOptional

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 · max: 128Required

Username or email address.

passwordstringOptional

Password for email account.

authstring · enumOptional

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.
Default: AUTOPossible values:
enable_tls_sslbooleanOptional

Whether to enable TLS/SSL.

Default: true
enable_starttls_autobooleanOptional

Whether StartTLS is automatically enabled.

Default: false
recipientsstringOptional

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

notify_user_registrationbooleanOptional

Notify via email when user registered.

Default: false
notify_queue_sla_breachedbooleanOptional

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

Default: false
notify_queue_callbackbooleanOptional

Notify queue manager via email when callback has been made.

Default: false
notify_queue_callback_failedbooleanOptional

Notify queue manager via email when callback failed.

Default: false
notify_queue_call_lostbooleanOptional

Notify queue Manager via email when call lost.

Default: false
notify_emergency_callbooleanOptional

Send a notification email when emergency number dialed.

Default: true
notify_license_limitedbooleanOptional

Send a notification email when license limit reached.

Default: true
notify_trunk_call_limitedbooleanOptional

Send a notification email when trunk call limited reached.

Default: true
Responses
200

OK

No content
post/tenant/notification
POST /api/tenant/notification HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 424

{
  "type": "SMTP",
  "server": "",
  "port": 1000,
  "reply_to": "",
  "username": "example",
  "password": "",
  "auth": "AUTO",
  "enable_tls_ssl": true,
  "enable_starttls_auto": true,
  "recipients": "",
  "notify_user_registration": true,
  "notify_queue_sla_breached": false,
  "notify_queue_callback": false,
  "notify_queue_callback_failed": false,
  "notify_queue_call_lost": false,
  "notify_emergency_call": true,
  "notify_license_limited": true,
  "notify_trunk_call_limited": true
}
No content

Test email

post

Check email server configurations by sending testing email.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
recipientstringRequired

The recipient's e-mail address.

subjectstringRequired

Mail subject.

contentstringRequired

Mail content.

Responses
200

OK

No content
post/tenant/notification/test_email
POST /api/tenant/notification/test_email HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "recipient": "",
  "subject": "example",
  "content": ""
}
No content

List default email templates

get

List all of default email templates

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

OK

application/json
get/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": "",
      "subject": "example",
      "body": ""
    }
  ]
}

Retrieve default details of template

get

Get details of default template by name.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
namestring · enumRequired

Name of the email template:
Can be either:

  • AUTH_RESET_PASSWORD: reset user password notification.
  • AUTH_SIGN_IN_2FA: two factor authentication code notification.
  • CALL_REPORT_COMPLETED: call report completed notification.
  • CONFERENCE_INVITATION: meeting invitation notification.
  • DISK_LOW: low disk notification.
  • EMERGENCY_CALL: emergency call notification.
  • LICENSE_LIMITED: license limited notification.
  • QUEUE_CALLBACK: call queue callback notification.
  • QUEUE_CALLBACK_FAILED: call queue callback failed notification.
  • QUEUE_CALL_LOST: call queue call lost notification.
  • QUEUE_SLA: call queue sla time reached notification.
  • RECHARGE: recharge notification.
  • SHARED_VOICEMAIL_RECEIVED: shared voicemail received notification.
  • TRUNK_CALL_LIMITED: trunk call limited notification.
  • TRUNK_CONNECTED: trunk connected notification.
  • TRUNK_DISCONNECTED: trunk disconnected notification.
  • USER_CREATION: user creation notification.
  • VOICEMAIL_RECEIVED: received voicemail notification.
Possible values:
Responses
200

OK

application/json
namestring · enumOptional

Name of the email template:
Can be either:

  • AUTH_RESET_PASSWORD: reset user password notification.
  • AUTH_SIGN_IN_2FA: two factor authentication code notification.
  • CALL_REPORT_COMPLETED: call report completed notification.
  • CONFERENCE_INVITATION: meeting invitation notification.
  • DISK_LOW: low disk notification.
  • EMERGENCY_CALL: emergency call notification.
  • LICENSE_LIMITED: license limited notification.
  • QUEUE_CALLBACK: call queue callback notification.
  • QUEUE_CALLBACK_FAILED: call queue callback failed notification.
  • QUEUE_CALL_LOST: call queue call lost notification.
  • QUEUE_SLA: call queue sla time reached notification.
  • RECHARGE: recharge notification.
  • SHARED_VOICEMAIL_RECEIVED: shared voicemail received notification.
  • TRUNK_CALL_LIMITED: trunk call limited notification.
  • TRUNK_CONNECTED: trunk connected notification.
  • TRUNK_DISCONNECTED: trunk disconnected notification.
  • USER_CREATION: user creation notification.
  • VOICEMAIL_RECEIVED: received voicemail notification.
Possible values:
fromstringOptional

Notification email from field.

subjectstringOptional

Notification email subject field.

bodystringOptional

Notification email body.

get/default_email_templates/{name}
GET /api/default_email_templates/{name} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "USER_CREATION",
  "from": "",
  "subject": "example",
  "body": ""
}

List custom email templates

get

List all of custom email templates

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

OK

application/json
get/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": "",
      "subject": "example",
      "body": ""
    }
  ]
}

Add custom email template

post

Create custom email template.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
namestring · enumOptional

Name of the email template:
Can be either:

  • AUTH_RESET_PASSWORD: reset user password notification.
  • AUTH_SIGN_IN_2FA: two factor authentication code notification.
  • CALL_REPORT_COMPLETED: call report completed notification.
  • CONFERENCE_INVITATION: meeting invitation notification.
  • DISK_LOW: low disk notification.
  • EMERGENCY_CALL: emergency call notification.
  • LICENSE_LIMITED: license limited notification.
  • QUEUE_CALLBACK: call queue callback notification.
  • QUEUE_CALLBACK_FAILED: call queue callback failed notification.
  • QUEUE_CALL_LOST: call queue call lost notification.
  • QUEUE_SLA: call queue sla time reached notification.
  • RECHARGE: recharge notification.
  • SHARED_VOICEMAIL_RECEIVED: shared voicemail received notification.
  • TRUNK_CALL_LIMITED: trunk call limited notification.
  • TRUNK_CONNECTED: trunk connected notification.
  • TRUNK_DISCONNECTED: trunk disconnected notification.
  • USER_CREATION: user creation notification.
  • VOICEMAIL_RECEIVED: received voicemail notification.
Possible values:
fromstringOptional

Notification email from field.

subjectstringOptional

Notification email subject field.

bodystringOptional

Notification email body.

Responses
201

Created

application/json
idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw
post/custom_email_templates
POST /api/custom_email_templates HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "name": "USER_CREATION",
  "from": "",
  "subject": "example",
  "body": ""
}
{
  "id": "xxxxxxxx"
}

Retrieve custom details of template

get

Get details of custom template by name.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
namestring · enumRequired

Name of the email template:
Can be either:

  • AUTH_RESET_PASSWORD: reset user password notification.
  • AUTH_SIGN_IN_2FA: two factor authentication code notification.
  • CALL_REPORT_COMPLETED: call report completed notification.
  • CONFERENCE_INVITATION: meeting invitation notification.
  • DISK_LOW: low disk notification.
  • EMERGENCY_CALL: emergency call notification.
  • LICENSE_LIMITED: license limited notification.
  • QUEUE_CALLBACK: call queue callback notification.
  • QUEUE_CALLBACK_FAILED: call queue callback failed notification.
  • QUEUE_CALL_LOST: call queue call lost notification.
  • QUEUE_SLA: call queue sla time reached notification.
  • RECHARGE: recharge notification.
  • SHARED_VOICEMAIL_RECEIVED: shared voicemail received notification.
  • TRUNK_CALL_LIMITED: trunk call limited notification.
  • TRUNK_CONNECTED: trunk connected notification.
  • TRUNK_DISCONNECTED: trunk disconnected notification.
  • USER_CREATION: user creation notification.
  • VOICEMAIL_RECEIVED: received voicemail notification.
Possible values:
Responses
200

OK

application/json
namestring · enumOptional

Name of the email template:
Can be either:

  • AUTH_RESET_PASSWORD: reset user password notification.
  • AUTH_SIGN_IN_2FA: two factor authentication code notification.
  • CALL_REPORT_COMPLETED: call report completed notification.
  • CONFERENCE_INVITATION: meeting invitation notification.
  • DISK_LOW: low disk notification.
  • EMERGENCY_CALL: emergency call notification.
  • LICENSE_LIMITED: license limited notification.
  • QUEUE_CALLBACK: call queue callback notification.
  • QUEUE_CALLBACK_FAILED: call queue callback failed notification.
  • QUEUE_CALL_LOST: call queue call lost notification.
  • QUEUE_SLA: call queue sla time reached notification.
  • RECHARGE: recharge notification.
  • SHARED_VOICEMAIL_RECEIVED: shared voicemail received notification.
  • TRUNK_CALL_LIMITED: trunk call limited notification.
  • TRUNK_CONNECTED: trunk connected notification.
  • TRUNK_DISCONNECTED: trunk disconnected notification.
  • USER_CREATION: user creation notification.
  • VOICEMAIL_RECEIVED: received voicemail notification.
Possible values:
fromstringOptional

Notification email from field.

subjectstringOptional

Notification email subject field.

bodystringOptional

Notification email body.

get/custom_email_templates/{name}
GET /api/custom_email_templates/{name} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "USER_CREATION",
  "from": "",
  "subject": "example",
  "body": ""
}

Update custom email template

post

Update custom email template.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
namestring · enumRequired

Name of the email template:
Can be either:

  • AUTH_RESET_PASSWORD: reset user password notification.
  • AUTH_SIGN_IN_2FA: two factor authentication code notification.
  • CALL_REPORT_COMPLETED: call report completed notification.
  • CONFERENCE_INVITATION: meeting invitation notification.
  • DISK_LOW: low disk notification.
  • EMERGENCY_CALL: emergency call notification.
  • LICENSE_LIMITED: license limited notification.
  • QUEUE_CALLBACK: call queue callback notification.
  • QUEUE_CALLBACK_FAILED: call queue callback failed notification.
  • QUEUE_CALL_LOST: call queue call lost notification.
  • QUEUE_SLA: call queue sla time reached notification.
  • RECHARGE: recharge notification.
  • SHARED_VOICEMAIL_RECEIVED: shared voicemail received notification.
  • TRUNK_CALL_LIMITED: trunk call limited notification.
  • TRUNK_CONNECTED: trunk connected notification.
  • TRUNK_DISCONNECTED: trunk disconnected notification.
  • USER_CREATION: user creation notification.
  • VOICEMAIL_RECEIVED: received voicemail notification.
Possible values:
Body
fromstringOptional

Notification email from field.

subjectstringOptional

Notification email subject field.

bodystringOptional

Notification email body.

Responses
200

OK

No content
post/custom_email_templates/{name}
POST /api/custom_email_templates/{name} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "from": "",
  "subject": "example",
  "body": ""
}
No content
PreviousExternal Message
NextTroubleshooting

Last updated

Was this helpful?