3CX administrators need to plan ahead on how to construct their 3CX Phone System. It can be very time consuming to create extensions one-by-one, along with their settings and provisioning.
There are two very simple ways to speed up this process – creating a .csv file and importing it or creating one extension and then export extensions to a .csv. You can create any number of extensions in seconds.
Here are sample import files for each version of 3CX Phone System:
- 3CX Phone System Version 14
- 3CX Phone System Version 12.5
- 3CX Phone System Version 12
- 3CX Phone System Version 11
Download the sample file for your version and create your PBX configuration to your specifications. Each column is hard-coded in the 3CX Import function and the position of the column must remain as is. The comma delimited file provides the structure of the columns and how they should be named in Row 1. Row 2 contains an example which will create an extension with provisioning.
The table below explains the field requirements and options for 3CX Phone System Version 14. For older versions download the example csv files above.
|Field Name||Description||Possible Values|
|Number||Extension Number||Numeric values only|
|MobileNumber||Mobile Number||Numeric values only|
|AuthID||SIP Authentication ID||Aphanumeric|
|AuthPassword||SIP Authentication Password||Aphanumeric|
|EnableVoicemail||Enable Voice Mail Box for this extension||0 – VoiceMail is disabled
1 – VoiceMail is enabled
|VMNoPin||Disable Voicemail PIN authentication||0 – Pin Authentication for VoiceMail is disabled
1 – Pin Authentication for VoiceMail is enabled
|VMPlayCallerID||Play Caller ID||0 – Do not play Caller ID
1 – Play Caller ID
|PIN||PIN number used to access Voicemail box||Numeric|
|VMPlayMsgDateTime||Read out date/time of message||0 – Do not read Date/Time of message
1 – Read in AM/PM Format
2 – Read in 24hr format
|VMEmailOptions||Email options||0 – No email notification is generated when the extension receives VoiceMail
1 – Email notification is sent
2 – Email Notification with voicemail attached will be sent.
3 – Email notification with vmail attached will be sent and vmail file will be deleted from the server.
|QueueStatus||Queue status||0 – Logged out of Queues
1 – Logged in Queues
|OutboundCallerID||Outbound Caller ID||Alphanumeric – Configures the Outbound Caller ID for the extension|
|SIPID||SIP ID||Alphanumeric – Configures the SIP ID for the extension|
|DeliverAudio||PBX delivers Audio||0 – PBX does not deliver audio
1 – PBX delivers audio
|SupportReinvite||Supports Re-invite||0 – Reinvites not supported
1 – Reinvites supported
|SupportReplaces||Support Replaces header||0 – Does not support Replaces Header
1 – Supports Replaces Header
|EnableSRTP||Switch on Secure RTP (SRTP)||0 – Disabled
1 – Secure SRTP on
|ManagementAccess||Allow 3CX Management Console Access||0 – 3CX Management Console access not allowed
1 – 3CX Management Console access enabled + user can manage his own Extension
2 – 3CX Management Console access enabled + User is set as Group / Department manager (can manage the extensions of the groups he is a member of)
3 – 3CX Management Console access enabled + user is set as a Global Extension Manager (can manage all user extensions on the System)
|ReporterAccess||Allow 3CX Web Reports Access||0 – 3CX Reports access not allowed
1 – 3CX Reports access enabled
|WallboardAccess||Allow 3CX Wallboard Access||0 – 3CX Wallboard access not allowed
1- 3CX Wallboard access enabled
|TurnOffMyPhone||Disallow use of 3CXPhone||0 – 3CXPhone use is enabled
1 – 3CXPhone use is disabled
|HideFWrules||Hide Forwarding Rules||0 – Forwarding Rules tab enabled in 3CXPhone
1 – Forwarding Rules tab disabled in 3CXPhone
|CanSeeRecordings||Show Call Recordings||0 – Call recordings not shown to the user
1 – Call recordings shown to the user
|CanDeleteRecordings||Allow deletion of recordings||0 – Does not allow the deletion of recordings by the user
1 – Allows deletion of recordings by the user
|RecordCalls||Record all calls||0 – Do not record all calls
1 – Record all calls for this extention
|CallScreening||Call screening ON||0 – No Call Screening
1 – Enable Call Screening
|EmailMissedCalls||Send email notification on missed call||0 – Do not send email notification on missed call
1 – Send email notification on missed call
|Disabled||Disable Extension||0 – Extension is enabled
1 – Extension is disabled
|DisableExternalCalls||Disable External Calls||0 – External calls enabled
1 – External calls disabled
|AllowLanOnly||Disallow the use of extension outside the LAN||0 – Use of extension outside LAN is enabled
1 – Use of extension oudside LAN is disabled
|BlockRemoteTunnel||Block Remote Tunnel Connections||0 – Remote tunnel connections enabled
1 – Remote tunnel connections disabled
|PinProtect||Pin Protect||Numeric value in seconds – user has to type a pin to allow external calls in the time allocated|
|MAC_0||MAC Address||MAC Address of the first provisioned phone|
|InterfaceIP_0||Select Interface||3CX Phone System IP adress|
|UseTunnel||Use 3CX Tunnel for Remote Connections (3CX Phone only)||0 – Do not use tunnel for Remote Connections
1 – Use tunnel for Remote Connections
|DND||DND||0 – Do Not Disturb off
1 – Do Not Disturb on
|UseCTI||Configure default phone to use in 3CX Phone for windows||empty – default phone to use in 3CXPhone for windows not specified
0 – Use Inbuilt Softphone
1 – use IP Phone via CTI
|StartupScreen||Default Startup Screen||0 – Dialpad as Start up screen
1 – Presence screen as Start up screen
|HotelModuleAccess||Allow 3CX Hotel Module Access||0 – Extension cannot access 3CX Hotel module
1 – Extension can access 3CX Hotel module
|DontShowExtInPHBK||Do not show Extension in 3CX Company phonebook||0 – Extension is shown in 3CX Company Phonebook
1 – Extension is not shown in 3CX Company Phonebook
|DeskphoneWebPass||Phone Web Page Password||Alphanumeric – this is the password used to access the IP Phone’s web configuration pages.|
|SrvcAccessPwd||Access password for 3CX Web Services||Alphanumeric – this is the password used to access the 3CX Web services (3CX wallboard, 3CX Management Console,3CX Hotel module, 3CX Web Reports)|
|VoipAdmin||Voip Trunk Administrator||0 – User is not allowed to manage VoIP Gateways, VoIP Providers and 3CX Phone System Bridges
1 – User is allowed to manage VoIP Gateways, VoIP Providers and 3CX Phone System Bridges
|SysAdmin||System Administrator||0 – User is allowed to modify System Extensions (Queues, Ring groups, Digital Receptionists), change System Settings and perform 3CX Phone System Updates
1 – User is not allowed to modify System Extensions (Queues, Ring groups, Digital Receptionists), change System Settings and perform 3CX Phone System Updates
|SecureSIP||Enable Secure SIP (TLS)||0 – Secure SIP is not enabled for this user
1 – Secure SIP is enabled for this user
|PhoneModel14||Phone Model name||Model of the first provisioned phone|
|PhoneTemplate14||Template used for the hardphone for provisioning||Template file name|
|CustomTemplate||Custom template used for Hardpphone provisioning||Custom template file name|
|AllowAllRecordings||Ability to download All Recordings||0 – Not allowed to download all recordings
1 – Allowed to download all recordings
|PushExtension||Enable Push for Smartphones||0 – Push notifications disabled,
1 – Push notifications enabled
If using Microsoft Office to open CSV files, take care that the MAC Address column is NOT presented as a number. If the MAC Address starts with zeros, Excel might remove any leading zeros. This will break file formatting. To fix, right-click on the MAC address column, select “Format Cells…” and choose text.
Instead of following the method outlined above, you can create at least one extension then export your extensions to a .csv. When you export an extension, the columns required will be created in the exported .csv file. You can then populate this .csv file, with your users, and import it back in, using the method immediately below.
To import Extensions from the .csv file:
- Log in to the 3CX Management Console and click on the “Extensions” node.
- Click on the “Import extension” button.
- Browse for your extension CSV file, select it and click “Open” to import your extension to the 3CXPhone System.
If you need to export your extensions to a CSV file format to either save them as backup or to make a lot of changes to the users follow the next steps:
- Log in to the 3CX Management Console and click on the “Extensions” node.
- Select the extensions that you want to export and click on the “Export extension” button.(You can use Shift or Ctrl keys to choose multiple extensions)
- Type in a filename and save the CSV file.
- If a row is configured to an extension that already exists in 3CX Phone System, the whole row will be skipped.
- Provisioning information will be generated if the file name is exactly identical to the names of the models in the template.
- Provisioning information will not be generated if the IP Address Interface in field 25 does not match a valid IP on which the phone will request the provisioning file. This entry must match one of the entries shown in the “Edit Extensions” section > “Phone Provisioning” tab > “Select Interface” drop down.
- An error in Line 1 is expected. This is due to the excel sheet column headers. You can safely ignore this message.