Setting up email notification templates in 3CX Phone System

Introduction

Surely you know that 3CX notifies users and administrators about various events in the system using a wide range of e-mail messages. In the 14th version of the system a separate section appeared to configure these notifications. Now the system administrator can customize each message in accordance with the requirements of the organization in the Options section - E-mail.

The E-mail and Notifications tab lists all events that may be of interest to the 3CX administrator. Here you can also specify one or several e-mail addresses (separated by commas) to which notifications will be sent.


')
The messages themselves are pre-installed in the system in English. It makes sense for Russian-speaking users of 3CX Phone System to translate at least basic messages into Russian. However, the question arises with the definition of the variables used in these notifications. In this article we will explain the values ​​of all system variables used in e-mail notifications.

Variables in email notification templates

Anti Hacking IP blacklisted - the IP address is blocked by the proactive protection module (anti-hacking)

%% IPADDRESS %% IP address that was blocked

%% TIME %% Time in seconds for which it was locked

Call to blocked country - Call to a prohibited country

%% CALLTO %% Call to number

%% CALLFROM %% Call from number

%% CALLPREFIX %% Number Prefix

Conference email - Invitation letter to the conference

%% CONFERENCENAME %% Conference Name

%% EXTERNALNUMBER %% External Conference Number

%% CONFERENCEID %% PIN for conference ID

%% CONFERENCEDESC %% Conference Description

%% INTERNALNUMBER %% Internal Conference Number

%% STARTTIME %% Conference start time

DNS Failure - DNS Server Error / Network Failure

%% PRODUCTION %% Registration Server Name

%% DESTINATION %% Call Direction

Emergency call - The emergency number is dialed.

%% EMERGENCYNUMBER %% Emergency Number

%% CALLFROM %% Call from number

Ext. Agent Welcome - Invitation letter to an external operator

%% MOBILENUMBER %% Mobile number of external operator

Extension Login / Logout - Login / Logout to the 3CX Management Console

%% EXTNUMBER %% User Extension

%% EXTFIRSTNAME %% Username

%% EXTLASTNAME %% User Name

%% USERIP %% IP address of the user

%% LICENSECONTACT %% The system is registered in the name

%% LICENSEEMAIL %% The system is registered by e-mail

Extension Welcome - Invitation letter to a new user.

%% EXTNUMBER %% User Extension

%% EXTFIRSTNAME %% Username

%% EXTLASTNAME %% User Name

%% EXTPIN %% PIN of the extension

%% VMNUMBER %% Voicemail number

%% WEBRTCLINK %% WebRTC user link

%% IFWEBRTCENABLED_START %% The beginning of the text block that is inserted if the WebRTC link is enabled for the user

%% IFWEBRTCENABLED_END %% End of the text block that is inserted if the WebRTC link is enabled for the user

Fax - New fax message

%% STARTTIME %% Date and time to start receiving a fax

%% STOPTIME %% Date and time of the fax reception

%% IMGFILE %% Fax image file name (.tif)

%% PDFFILE %% File name of the converted fax (full path to the pdf file)

%% PAGES %% Number of pages in fax

%% FAX_ID %% ID fax

%% CALLER_ID %% Caller ID

%% CALLEE_ID %% Recipient number

IP blacklisted - IP address blocked

%% IPADDRESS %% IP address that was blocked

%% TIME %% Time in seconds for which it was locked

%% EXPIREDATE %% Blocked until date

%% REASONBLACKLISTED %% Reason for blocking IP addresses

License limit reached - The maximum number of calls for this license has been reached.

%% ACTIVECALLS %% Number of simultaneous calls

New missed call - New missed call

%% EXTNUMBER %% The extension of the user who missed the call

%% EXTFIRSTNAME %% Username

%% EXTLASTNAME %% User Name

%% PARTYCALLERID %% Caller Caller ID

%% PARTYNAME %% Caller Name

%% START_TIME %% Call Start Time

%% END_TIME %% Call Completion Time

%% RING_TIME %% Dial Time

Queue: call is lost - Queue: Lost Call

%% QUEUENUMBER %% Queue number

%% QUEUENAME %% Queue Name

%% CALLER %% Caller ID Caller

Queue: callback is made - Queue: callback made

%% TOCALLER %% Number to which the callback is requested

%% QUEUENUMBER %% Queue number

%% QUEUENAME %% Queue Name

%% CALLER %% Caller ID Caller

Queue: Failed callback - Queue: unsuccessful callback

%% TOCALLER %% Number to which the callback is requested

%% QUEUENUMBER %% Queue number

%% QUEUENAME %% Queue Name

%% CALLER %% Caller ID Caller

Queue: SLA is reached - Queue: Service delivery time exceeded (SLA violation)

%% CALLER %% Caller ID for which the wait time has been exceeded

%% QUEUENUMBER %% Queue number

%% QUEUENAME %% Queue Name

%% TOTALNUMBERCALLERS %% Total number of subscribers in the queue at the time of violation

%% CALLSINSERVICE %% Number of calls that were served by operators at the time of the violation

%% CALLSWAITING %% Number of calls that were expected at the time of the violation

%% WAITINGTIME %% Actual subscriber waiting time (which turned out to be more than SLA)

%% INTERNALCALLID %% Internal call ID

Recordings folder quota reached - The quota for the folder with call recordings has been reached.

%% CURRENTSIZE %% Current folder size (in bytes / kb / Mb / Gb)

%% QUOTASIZE %% Quota size (in bytes / kb / Mb / Gb)

%% CURRENTSIZE_PERCENT %% Current use of quota in percent

%% QUOTA_PERCENT %% Use of quota as a percentage, after which an e-mail notification is sent

%% FOLDER %% Path to the Conversation Records folder

Registration status - The registration status of the extension has changed.

%% EXTENSIONNUMBER %% Extension

%% STATUS %% New extension status

%% SIPREGISTRATION %% SIP Registration Options

Reports template - Call Report Template

%% REPORT_NAME %% Report name (for example, Call Log, Extension Statistics, etc.)

%% FREQUENCY %% Report generation frequency (daily, weekly)

%% REPORT_URL %% Link to report file

%% REPORT_LIMIT_REACHED_START %% The beginning of a text block that is inserted when the report size limit is reached.

%% REPORT_LIMIT_REACHED_END %% The end of the text block that is inserted when the report size limit is reached.

Restore Complete - System Restore Complete

%% RESTORE_STATUS %% Recovery Status (successful, unsuccessful)

%% IF_ERROR_SHOW %% Beginning of the text block that is inserted if an error occurs

%% IF_ERROR_END %% End of the text block that is inserted if an error occurs

%% SHORT_ERROR_DESCRIPTION %% Brief description of the problem

%% DATETIME_START %% Date and time of the start of recovery

%% DATETIME_FINISH %% Date and time of the completion of the recovery

%% BACKUP_FILE %% Backup file that was restored

%% MANAGEMENTCONSOLE_LINK %% Link to the input to the 3CX control interface

STUN Resolution fails - Server STUN Error

%% STUNSERVER %% STUN server

%% PORT %% Server port number

%% REASON %% Cause of failure

Trunk Error - Trunk / Operator has responded to the request with an error code

%% CALLTO %% Call to number

%% CALLFROM %% Call from number

%% REPLY %% Error in response

Trunk failover - Emergency trunk switching

%% DEVICE %% The device through which the call was to pass

%% CALL %% Number to which the call was made

Trunk status - Changed the status of a VoIP trunk

%% TRUNKNUMBER %% Trunk Number

%% STATUS %% New trunk status

VoiceMail - Voice Mail Notification

%% CALLER %% Caller ID Caller

%% CALLERNAME %% Caller Name

%% EXTNUMBER %% The extension number of the user who received voicemail

%% EXTFIRSTNAME %% Username

%% EXTLASTNAME %% User Name

%% DURATION %% Duration of the message in the format hh: mm: ss

%% FILENAME %% Name of the audio file in the user's voicebox folder

%% DATETIME %% Received at (date and time in short system format)

%% DATE %% Received on (date in short system format)

%% DATETIME: [...] %% Received at (date and time in custom format). A detailed description of the possible formats is contained in the documentation for .NET.

Voicemail folder quota reached - The quota for the size of the folder with voicemail entries has been reached.

%% CURRENTSIZE %% Current folder size (in bytes / kb / Mb / Gb)

%% QUOTASIZE %% Quota size (in bytes / kb / Mb / Gb)

%% CURRENTSIZE_PERCENT %% Current use of quota in percent

%% QUOTA_PERCENT %% Use of quota in percent, after which an e-mail notification is sent

%% FOLDER %% Voicemail File Folder Path

Conclusion

We have tried to collect all known system variables found in the 3CX e-mail templates. We hope that the information provided will help you not only to create notifications that are understandable to users, but also to use them in various automated processes. For example, information from an e-mail about a missed call can create a reminder task for a user in a CRM system, etc.

Additional Information

• Variables in phone autotuning patterns
• Internal number management
• Trunk Management
• Fax server
• Reports