March 21, 2016 at 01:17Configuring email notification templates in 3CX Phone System
Introduction
Surely you know that 3CX notifies users and administrators of various events in the system using a wide range of e-mail messages. In version 14 of the system, a separate section has appeared to configure these notifications. Now the system administrator can customize each message in accordance with the requirements of the organization in the Parameters - E-mail section.
The Email and Notifications tab lists all events that may be of interest to the 3CX administrator. You can immediately specify one or more e-mail addresses (separated by commas) to which notifications will be sent.
The messages themselves are preinstalled in the system in English. It makes sense to 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 - IP address is blocked by the proactive protection module (anti-hacking)
%% IPADDRESS %% IP address that was blocked
%% TIME %% Time in seconds that it was blocked
Call to blocked country - Call to a banned country
%% CALLTO %% Call to
%% CALLFROM %% Call from
%% CALLPREFIX %% Number prefix
Conference email - Invitation letter to the conference
%% CONFERENCENAME %% Conference name
%% EXTERNALNUMBER %% Conference external number
%% CONFERENCEID %% PIN for conference ID
%% CONFERENCEDESC %% Conference description
%% INTERNALNUMBER %% Conference internal number
%% STARTTIME %% Conference start time
DNS Failure - DNS Server Error / Network Failure
%% PRODUCTION %% Registration Server Name
%% DESTINATION %% Call Direction
Emergency call - Emergency number dialed
%% EMERGENCYNUMBER %% Emergency number
%% CALLFROM %% Call from number
Ext. Agent Welcome - An invitation letter to an external operator
%% MOBILENUMBER %% Mobile number of an external operator
Extension Login / Logout - Log in / out to the 3CX management console
%% EXTNUMBER %% Extension number of user
%% EXTFIRSTNAME %% Username
%% EXTLASTNAME %% Last name of user
%% USERIP %% IP address of user
%% LICENSECONTACT %% The system is registered in the name
%% LICENSEEMAIL %% The system is registered by e-mail
Extension Welcome - An invitation letter to a new user
%% EXTNUMBER %% Extension of user
%% EXTFIRSTNAME %% Username
%% EXTLASTNAME %% Last name of user
%% EXTPIN %% Extension PIN
%% 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 %% The end of the text block that is inserted if the WebRTC link is enabled for the user
Fax - New Fax Message
%% STARTTIME %% Fax reception start time and date
%% STOPTIME %% Fax reception end time and time
%% IMGFILE %% Fax image file name (.tif)
%% PDFFILE %% Name of the converted fax file (full path to pdf file )
%% PAGES %%
Fax pages %% FAX_ID %% Fax ID
%% CALLER_ID %% Caller ID
%% CALLEE_ID %% Recipient Number
IP blacklisted - IP address is blocked
%% IPADDRESS %% IP address that was blocked
%% TIME %% Time in seconds it was blocked
%% EXPIREDATE %% Blocked until date
%% REASONBLACKLISTED %% Reason for blocking IP address
License limit reached - The maximum number of calls for this license has been reached.
%% ACTIVECALLS %% Number of concurrent calls
New missed call - New missed call
%% EXTNUMBER %% Extension of the user who missed the call
%% EXTFIRSTNAME %% Username
%% EXTLASTNAME %% Last name of the user
%% PARTYCALLERID %% Caller Caller ID %% PARTYNAME %% Caller
name
%% START_TIME %% Call start time
%% END_TIME %% Call
End Time %% RING_TIME %% Dial Time
Queue: call is lost - Queue: lost call
%% QUEUENUMBER %% Queue number
%% QUEUENAME %% Queue name %% CALLER
%% Caller Caller ID
Queue: callback is made - Queue: callback made
%% TOCALLER %% Number to which the callback was requested
%% QUEUENUMBER %% Queue number
%% QUEUENAME %% Queue name %% CALLER
%% Caller Caller ID
Queue: Failed callback - Queue: failed callback
%% TOCALLER %% Number to which the callback was requested
%% QUEUENUMBER %% Queue number
%% QUEUENAME %% Queue name %% CALLER
%% Caller Caller ID
Queue: SLA is reached - Queue: Service delivery time exceeded (SLA violation)
%% CALLER %% Caller ID for which the waiting time has been exceeded
%% QUEUENUMBER %% Queue number
%% QUEUENAME %% Queue name
%% TOTALNUMBERCALLERS %% The total number of subscribers in the queue at the time of violation
%% CALLSINSERVICE %% The number of calls that were serviced by operators at the time of violation
%% CALLSWAITING %% The number of calls that were waiting at the time of violation
%% WAITINGTIME %% Actual waiting time of the subscriber (which turned out to be greater than SLA)
%% INTERNALCALLID %% Internal call ID
Recordings folder quota reached - The quota on the size of the conversation recording folder has been reached.
%% CURRENTSIZE %% Current folder size (in bytes / kb / Mb / Gb)
%% QUOTASIZE %% Quota size (in bytes / kb / Mb / Gb)
%% CURRENTSIZE_PERCENT %% Current percentage quota usage
%% QUOTA_PERCENT %% Percentage quota usage after which an e-mail notification is sent
%% FOLDER %% The path to the conversation recording folder
Registration status - Extension registration status has changed
%% EXTENSIONNUMBER %% Extension
%% STATUS %% New extension status
%% SIPREGISTRATION %% SIP registration settings
Reports template - Call Report Template
%% REPORT_NAME %% Report name (e.g. Call Log, Extension Statistics, etc.)
%% FREQUENCY %% Report generation frequency (daily, weekly)
%% REPORT_URL %% Report file link
%% REPORT_LIMIT_REACHED_START %% Start text block that is inserted if the report size limit is reached
%% REPORT_LIMIT_REACHED_END %% The end of the text block that is inserted if the report size limit is reached
Restore Complete - System Restore Complete
%% RESTORE_STATUS %% Recovery status (successful, unsuccessful)
%% IF_ERROR_SHOW %% The beginning of the text block that is inserted if an error occurs
%% IF_ERROR_END %% The end of the text block that is inserted if an error occurs
%% SHORT_ERROR_DESCRIPTION %% Short description of the error problems
%% DATETIME_START %% Date and time to start recovery
%% DATETIME_FINISH %% Date and time to complete recovery
%% BACKUP_FILE %% Backup file that was being restored
%% MANAGEMENTCONSOLE_LINK %% Link to the 3CX management interface
STUN Resolution fails - STUN Server Error
%% STUNSERVER %% STUN server
%% PORT %% Server port number
%% REASON %% Cause of failure
Trunk Error - Trunk / Operator responded to the request with an error code
%% CALLTO %% Call to
%% CALLFROM %% Call from
%% REPLY %% Error in answer
Trunk failover - Trunk failover
%% DEVICE %% The device the call was to go through
%% CALL %% The number the call was made to
Trunk status - VoIP trunk status has changed
%% TRUNKNUMBER %% Trunk number
%% STATUS %% New trunk status
VoiceMail - Voice Mail Notification
%% CALLER %% Caller Caller ID
%% CALLERNAME %% Caller Name
%% EXTNUMBER %% Extension number of the user who received the voicemail
%% EXTFIRSTNAME %% Username
%% EXTLASTNAME %% Last name of the user
%% DURATION %% Message length in format hh: mm: ss
%% FILENAME %% The name of the audio file in the user's voice box folder
%% DATETIME %% Received in (date and time in short system format)
%% DATE %% Received in (date in short system format)
%% DATETIME: [...] %% Received on (date and time in custom format). A detailed description of the possible formats is provided in the .NET documentation.
Voicemail folder quota reached - A quota has been reached for the size of the folder with voicemail entries
%% CURRENTSIZE %% Current folder size (in bytes / kb / Mb / Gb)
%% QUOTASIZE %% Quota size (in bytes / kb / Mb / Gb)
%% CURRENTSIZE_PERCENT %% Current percentage quota usage
%% QUOTA_PERCENT %% Percentage quota usage after which an e-mail notification is sent
%% FOLDER %% The path to the voicemail file folder
Conclusion
We tried to collect all the known system variables found in 3CX e-mail templates. We hope that the information provided will help you not only create notifications that are understandable to users, but also 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.