3CX Multi-Company / Multi-Tenant Setup Guide

Introduction

This guide walks you through setting up and configuring a multi-company environment within your 3CX Phone System.

Installation

1. Login to your 3CX Account.
2. Go to “Downloads”, select the distribution you are planning to install Multi-Tenant on and press “Install”.

3. Select a key to deploy the Multi-Tenant instance. All new PRO/ENT keys 16SC and above will be listed.
   Note: Individual license keys for every company on the Multi-Tenant Host are not required.
4. Select which deployment type and follow the instructions to complete the wizard.

5. Once the deployment is ready, the installation setup will set you up as a System Owner where you can login to the system via the 3CX Web Client.

Creating Companies

You have two main methods for creating companies:

• Manually using a System Owner
• 3CX Configuration API

Manually Using a System Owner

Once you login, you will the system owner of the system where you can add more System Owners or System Administrators in case you need assistance by adding them to the “Default” department.

Step 1: Set Up the “Default” Department

Go to "Departments", edit the "Default" department and add these system extensions to it: *777, *888, *0, *1, and Shared Parking Slots.

Step 2: Create a New Department

Go to "Departments" and select “+Add”, give it a name, choose a language and a prompt, and set the extension numbers it will use (e.g., 100-119 for users, 120-125 for call handling).

By doing so this new company you will create will set Department Prompts Set in the UK, all Users will use the Language UK and the Ranges which the owners can create Users & Call Handling within the range of 100-119 for users, 120-125 for call handling.

Step 3: Give the Department Some Shared Parking Slots

Add 2 shared parking spaces to this new department.

Important: Shared Parking must be unique for every new department you create. So if you have 2 companies you need to give Company 1 (SP0 and SP1), Company 2 (SP2 and SP3), etc.

Step 4: Create a New User and Make Them a Member of the New Department.

For example, create a user and set the role “Owner” and define the Main Department Membership so this user(s) will be automatically created and assigned to this department.

If you want to import all users you may by using the import feature by defining a role and a department, see below as an example.

102,James,Patterson,,,,,"<role name=""group_owners"" />",Company 3,0,0,jamespatterson,,,,,,,,1,8210986B-9412-497f-AD77-3A554F4A9BDB,0,024780,1,1,0,0,0,0,0,0,0,0,0,0,0,0,60,,1,,0,0,0,1,,,,,,<PhoneDevice><BLFS/></PhoneDevice>

For example, in the import you may specify the following roles:

• Owner: "<role name=""group_owners"
• Department Admin : “<role name=""group_admins"
• Manager: "<role name=""group_managers"
• Receptionist: "<role name=""group_receptionists"
• User: "<role name=""group_users"

Step 5: Setup a Trunk for a Department With Numbers

Create a SIP Trunk for this department with unassigned DIDs and go to Options and select the company you want to “Limit To” so this trunk can be created for this company. You can also do this for Call Handling by creating Ring Group, Queues and IVRs and assigning them to the Department directly.

Once you follow each step, the owner will receive an email with an explanation of how he can log in to the System. Once he logins to the Admin Console he will be able to configure and manage his company by setting up Office hours and Holidays, manage users, Ring Groups and Queues and also assign numbers to each one.

3CX Configuration API

Another way is to use our 3CX RestAPI to manage and configure your system programmatically.

Follow the steps to create an application:

1. Go to Admin Console > Integrations > API and create an application.
2. Enable option 3CX Configuration API Access.
3. Select Department “Default” with role “System Owner”.
4. Save and store the API Key.
5. You will need to use this to authenticate.

Once you authorize you can manage, add, and delete programmatically all of the following:

• Departments
• Users
• Call Handling
• Live Chat
• Configuration

Read more here on how to do this.