Notification | PortSIP Knowledge Base

PortSIP Knowledge Base

List default email templates

get

List all of default email templates

Authorizations

Responses

200

application/json

4XX

Error

get

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"
    }
  ]
}

Retrieve default details of template

get

Get details of default template by name.

Authorizations

Path parameters

namestring · enumRequired

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.

Possible values:

Responses

200

application/json

4XX

Error

get

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 custom email templates

get

List all of custom email templates

Authorizations

Responses

200

application/json

4XX

Error

get

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"
    }
  ]
}

Retrieve custom details of template

get

Get details of custom template by name.

Authorizations

Path parameters

namestring · enumRequired

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.

Possible values:

Responses

200

application/json

4XX

Error

get

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"
}

Retrieve notification settings

get

Retrieve details of notification settings.

Authorizations

Responses

200

application/json

4XX

Error

get

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

post

Update notification settings.

Authorizations

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

Responses

200

4XX

Error

post

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

Test email

post

Check email server configurations by sending testing email.

Authorizations

Body

recipientstringRequired

The recipient's e-mail address.

subjectstringRequired

Mail subject.

contentstringRequired

Mail content.

Responses

200

4XX

Error

post

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

Add custom email template

post

Create custom email template.

Authorizations

Body

namestring · enumOptional

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.

Possible values:

fromstringOptional

Notification email from field.

subjectstringOptional

Notification email subject field.

bodystringOptional

Notification email body.

Responses

201

Created block code.

application/json

4XX

Error

post

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"
}

Update custom email template

post

Update custom email template.

Authorizations

Path parameters

namestring · enumRequired

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.

Possible values:

Body

fromstringOptional

Notification email from field.

subjectstringOptional

Notification email subject field.

bodystringOptional

Notification email body.

Responses

200

4XX

Error

post

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