Skip to main content

Tenant Settings

The Vodia PBX system has multi-tenant capability. To implement this functionality, the Vodia PBX uses domains. A domain can be thought of as a logical group of users and is very similar to email domains. Users within the same domain on the Vodia PBX can call each other without going through a trunk. They can also access the same address book and share features, such as call monitoring and call park/pickup.

A Vodia PBX domain name should be fully qualified and configured in the DNS server so that traffic can be routed to the proper IP address of the PBX. If this is not possible, then you can set the outbound proxy field in the system. This will configure the registrar to the domain name. If you have only one domain on the system, be sure to leave the alias local host as the domain name or as the alias to it. This will enable the Vodia PBX to locate extensions without looking at the domain name.

Entire domains can be exported for use for other domains using a .tar file.

General Settings

Go to your selected domain in the Vodia PBX web interface. Click on General Settings under Advanced as shown above.


If you have more than one emergency number, use a space between the numbers (e.g., 911 199). By default, this setting is blank (i.e., it is not set to 911).

  • Name of the Domain: This field allows you to give the domain a descriptive name. The name can contain special characters and spaces and may include upper and lowercase characters. The name will be used by the system when sending emails with call data records for the domain. This name is independent from the domain name that is set by the system administrator.
  • Default Dial Plan: This dial plan will be used by the domain, but users can override this with their own dial plan based on need. Most of the accounts in a domain will use the default dial plan. If you do not set a default dial plan, you will likely have problems placing outbound calls. Therefore, it is strongly recommended to choose a default dial plan.
  • Default IVR Language: This setting can be configured by the administrator and is not needed on the domain level in single-domain environments.
  • Google sign in client ID: The ID for signing in with Google, see Login with Google .
  • Google contacts client ID: The ID for the Google address book, see Google Contacts .
  • Google contacts client secret: The secret for the Google address book, see Google Contacts .
  • Pattern list for setting the IVR language from caller-ID: When determining the language for the audio prompts, the PBX can try to match a list of patterns against the caller-ID for the incoming call and if it matches, set the language accordingly. The format for this list is (space-seperated) "pattern:lang". The pattern is matched against the first digits of the caller-ID, which is first converted into the global format. The language must be one of the installed languages. For example "49:de 33:fr" would choose German if the call comes from a number starting with "+49xxx".
  • Tone Language: This setting can be configured by the administrator and is not needed on the domain level in single-domain environments.
  • Default Web Language: This setting can be configured by the administrator and is not needed on the domain level in single-domain environments.
  • Music on Hold Source: You can select the source of music that will be used when a call is put on hold. The party who is on hold hears the music that is chosen here. See also Chapter 21, "Music on Hold."
  • Ringback source This settings overrides the system default ringback tone for the domain.
  • Ringback when busy This settings overrides the system default ringback tone when busy for the domain.
  • Timezone: The system can handle multiple time zones simultaneously, making it possible for users to select a time zone that corresponds with their geographic location. This setting influences the time on mailbox messages and the telephone display. Before the system can apply the time zone to the user's extension, it needs a time zone configuration file (timezones.xml). The name of the time zones is reflected in the lang_xx.xml file, where xx is replaced by the respective language.
  • Default location If there is no location assigned to an extension, this setting will be used.
  • Country Code: This setting determines how phone numbers are processed. Typically the setting is set automatically during installation. Leaving the setting empty will disable processing phone numbers.
  • Area Code: This is the telephone area code for the domain. This is generally NPA in the NPA-NXX-XXXX number (e.g., 978, 212, etc.). If you put a "-" there, it means that the area code is explicitly set to null; this is necessary in some countries that don't use 0 as the domestic calling prefix.
  • Starting characters to be removed from outbound numbers: In old PBX systems, users had to dial prefix numbers in order to make outbound calls (for example, "9"). Even though with modern PBX that pattern is not useful anymore, there are still users that can't dial numbers without such a prefix. In such situations, this setting defined what number the PBX will remove from the beginning of the number that the user has dialed.
  • Default ANI Using this setting, you can configure each domain with a default ANI (Automatic Number Identification). For more information, see Trunk ANI .
  • Classroom DND Override - Use this setting to give the admin permissions to over ride the DND set for any classroom extensions.
  • Classroom DND Control - The service flag can be assigned to this setting, to take effect permissible by time set under different service flags.
  • Extensions may use star code to change ANI This setting determines weather users in the domain may use the code for changing the ANI (*59 by default). There are several possibilities for this setting:
    • Cannot change ANI (default): This essentially disables the feature.
    • Only own ANI: Every account may have several ANI. This option will put the selected ANI at the front of the list, essentially making it the primary ANI of the account. This option makes sure that the user cannot take a ANI from another account.
    • Any ANI in this domain: With this option, the user can assign any ANI that exists in the domain to the account. This makes it possible to move ANI around in the domain.
    • Any NANPA ANI: With this option, the user can set up any ANI with 10-digits (NANPA = North American Numbering Plan Association). The SIP trunk provider has to be able to present that number.
    • Enter any ANI: Using this option, the user can assign any number as ANI for the extension. This will again require that the SIP trunk provider will be able to present the number.
  • Trust Caller-ID This setting is used to specify whether the caller-ID should be used to authenticate, rather than asking users to enter their PIN numbers.
  • Emergency Numbers This setting allows you to establish which numbers will be considered "emergency numbers" on the domain. Once the user dials an emergency number, the system sends an email alert to the configured extension if an alert has been configured for this type of system event . The system also dials the local police station number that was entered into the user's Emergency Destination Number setting. To set the callback number for the user, see the EPID setting. A general callback number for all users across the domain can also be set using the ANI for emergency setting.
  • Emergency call emails The system will send an email to the provided addresses when someone dials an emergency number. The list is seperated by semicolons.
  • ANI for emergency calls This ANI will be used when a user dials an emergency number unless there is more specific information available on extension level.
  • Paging account for emergency call notifications The system will initiate a page to the specified account when someone dials an emergency number.
  • Default auto attendant The default auto attendant is used when the system needs an auto attendant number, for example in the virtual private assistant. The setting is also used when there is no routing rule for a trunk and the destiantion cannot be found.
  • Use last 7 digits when cellphone matching: In some cases, the admin might have saved only last 7 digits of the cell phone in the PBX database. This setting comes in handy to force the PBX to perform a search based on the last 7 digits of the received number.
  • Send welcome email when an extension is created: If this setting is checked, new users will automatically receive a welcome email.
  • Delete all aliases when deleting the primary account: Aliases will be deleted when primary accounts are deleted.
  • Send P-Asserted Header in calls to extensions: When this setting is turned on, the system will include the header when calling extensions. This is useful in some environments when the extension name should be on the display.
  • Park reminder: When someone parks a call, there is a risk that this call stays in the park orbit for a long time, without anybody taking care about the caller. The park reminder will call the one who parked the call back after a certain timeout if the call was not picked up by somebody else.
  • Transfer reminder after: Similar to the park reminder, there is a risk that after a blind transfer the caller ends up with a ringing call, but nobody picking up. The transfer reminder will transfer the call back if the call could not be connected.
  • Disconnect the call on these error codes from a forked leg: This setting affects the behavior of the auto attendant and the call of extensions outside of group calls. If the PBX receives an error code that is listed in the space-separated list in this setting, it terminates also all other forked calls to the extension and treats the call as rejected by the user.
  • URL for sending text messages to cell phones: When the PBX needs to send a text message to the domain administrator, it uses the URL provided in this setting. For more information, see Event Notifications .


Incoming calls from a trunk into the tenant can be generally redirected. This takes precedence over the general trunk routing to an account.

  • When service flag is active/not active: The redirection depends on the state of a service flag.
  • Always: The redirection is always active. This setting can be useful when set automatically through an external program.
  • Use call forward all from extension: This condition will use the call forwarding from an extension and use the destination as the target, if set. This is useful when users can set call forward through a VoIP phone without the need to log into the user front end.

From/To Headers

  • Change names in To/From-headers: Usually it is okay if the system changes the names in the To/From headers in the SIP packets. For example, this makes sense when the address book matches the caller-ID and the system should present the address book entry. However, if the system is used as a SIP device in an operator environment, you may want to make sure that the system does not change headers. In such cases, this setting should be set to No .
  • Use extension ANI for DISA: When a user places an outbound call from from his cell phone, the system uses the ANI of the extension and not not the Caller-ID of the cell phone. With this settings this behavior can be changed on domain level.
  • Account name display format: This setting controls how names are put together when the first name and the last name needs to be represented in one string.

CDR Settings

  • CDR URL: The CDR URL field controls where CDRs are written. The system can write CDRs to a CSV file, an email address, a server address, or to a SOAP destination. To populate the CDR URL field, use the syntax shown below. CDRs can be viewed only after they have been collected and organized through an external call accounting application. For more information, see the CDR documentation.

Billing Settings

Use address book: The system will automatically take the CMC from the address book record.

  • CMC authentication for outbound calls: This setting works in tandem with the "C" checkbox located in the dial plan. When the "C" is checked on a particular trunk in the dial plan, this domain setting will be used to generate the CMC for the CDR when that trunk is used for an outbound call; otherwise, it will be ignored. The following indicates how the CMC will be generated for the CDR:

  • These next options apply to CMC codes that have been generated by the third-party software that is being used to do the billing. If the CMC codes are 4 digits, choose the "4 digit" option; if they are 5 digits, choose the "5 digit" option, etc. If they are a combination of digits, then use the "Terminate CMC with #" option. This will enable the caller to enter CMC codes are varying lengths, followed by the # sign.

    • Terminate CMC with #: The CMC has to be terminated explicitly with a # sign
    • 4..10 digits: The length of teh CMC is fixed to 4..10 digits. There is no need to terminate the CMC.
  • Billing Tones: This field allows you to configure whether domain users will hear a beep during the call when using the pre-pay feature of the system.

    • No tones: The system does not play any tones
    • Beep for every charge unit: The system plays a short beep for every minute which is charged
    • Beep only for last charge unit The system plays a tone only when the last available minute has started
  • Credit for outbound calls: This setting allows you to place a limit on outbound calling for the entire domain. Once the extensions as a group have reached the maximum, outbound calls can no longer be placed.

Recording Default for this Domain

This section allows you to define domain-level call recording settings. Recorded calls will be saved in the recordings directory.

  • Record incoming calls from hunt group: This setting controls the recording on an extension (applies to calls coming from the hunt group for the entire domain).
  • Record incoming calls from agent group: This setting controls the recording on an extension (applies to calls coming from the agent group for the entire domain).
  • Record incoming calls from extension: This setting controls the recording on an extension (applies to calls coming from another extension for the entire domain).
  • Record outgoing calls to internal numbers: This setting controls the recording on an extension (applies to calls going to another extension for the entire domain).
  • Record outgoing calls to external numbers: This setting controls the recording on an extension (applies to calls going to external numbers for the entire domain).
  • Record outgoing calls to emergency numbers: This setting controls the recording on an extension (applies to calls going to an emergency number).
  • Play a message before start recording: When this setting is turned on, the PBX will play a message when recording has started. This is to tell the involved parties that recording is in progress.
  • Customer ID and Site ID: These settings can be referenced in the file names, so that each domain can have a unique identifier. This is important when using external tools that process the recording files. This setting is available since version 5.3.2.

Midnight Events

At midnight, the system can perform several maintenance tasks, including the generation and sending of CDR reports.

  • Send daily CDR report to: The system sends daily CDR reports to the email addresses listed in this field. Use semicolons between multiple email addresses, since email addresses may contain spaces (e.g., Fred Feuerstein < >; Carl Clements < >). To test this feature, click theTry button once you've entered an email address rather than waiting until midnight. Keep in mind that this is just a link, and you may have to save your list before clicking the link.
  • Reset DND Flags: DND is a major problem if users forget that they've set their extensions to DND and then open a trouble ticket next morning because they've stopped receiving calls! This setting can prevent that. When the Reset DND Flags has been enabled, the system resets all DND flags on the domain each day at midnight.
  • Reset Hot Desking: Forgetting to deactivate a Hot Desking situation has similar consequences to forgetting to turn off DND, so use this setting if you want the system to reset hot desking each day at midnight.
  • Reset Block CID: As with the previous two settings, this is another setting that is beneficial to reset each day at midnight.
  • Send emails to CDR email address for domain level blacklisted calls: When someone calls into the auto attendant, hunt group, or agent group and is put onto the blacklist, the system will notify the person who receives the CDR report. The report will be sent daily at midnight.
  • Log out agents from all ACDs: When this setting is enabled, all agents will be logged out of all agent groups each day at midnight.

Provisioning Parameters

When the system automatically generates files for the configuration of extensions, it needs a few settings from the domain.

  • Default PnP Dialplan Scheme: This setting allows you to set auto-dial and configure timeout-based dialing. These settings are used by the phone and not the system . The PnP Dialplan Scheme setting allows you to tell the system how many numbers your extensions contain (either 2, 3, or 4 digits). This will initiate automatic dialing once the required number of digits has been entered. If your extensions are all 3 digits long and include only digits 2 through 7, you should choose 3-digit extensions [2-7]xx. Then if a user dials 201, the system will identify that an extension has been dialed and will not wait for more digits. If NA is set and Country Code 1 is used, then anytime someone dials 1, the system will know to dial that country. For this reason, extensions should not begin with a 1.

User must press enter: When this scheme is selected, the user of the extension will be required to press the confirm button on the phone before the dialing will begin. This behavior is similar to cell phones, where users are required to press the green send button. This scheme can prevent problems because it is difficult to predict how many digits the phone must collect before it has enough digits for a complete number.

When the user is located in the North America area ( ), the length of the number is predictable for national calls and calls of other extensions in the domain. However, calls to international destinations or star codes are difficult to predict, so users will be required to press the confirm button to start the call.

For other countries, the "Europe" scheme might be appropriate. As with the rest of the world outside of NANPA, the length of a telephone number is practically unpredictable and users will be required to press the confirm button to start the call. The "Europe" scheme will dial automatically only if the destination is another extension.


Note : If you want to create a customized dial plan, you can do this from either the snom phone or through the binary files of the system. In the case of the latter, you will need to request the appropriate file from snom and place it into the /html directory (you may need to create the html directory). After you have modified the file, save it and reboot both the phone and the system.


Example : In the event you want to exclude numbers higher than 5 from the default of [2-7]xx so that users will not be required to enter a 1 when dialing local numbers beginning with 604 or 778, you need to replace [2-7] with [2-5] in the file named snom_3xx_dialplan_usa3.xml (assuming you are using a snom phone).

  • Authentication User/Password: This setting makes it easier to carry out domain level settings of phones. Using this setting, the administrator can create identical user names and passwords for all devices in a domain.

This password will bypass users passwords. However, an extension@domain is still required. The default user name is admin, and the default password is password.

  • Authentication PIN: This setting allows you to override the user's PIN, which is used on the phone itself. Administrative access to the phone allows you to reset the phone.
  • Outbound proxy pattern: Using this pattern, the outbound proxy that is provisioned into the phones can be controlled. For more information on this subject, see Outbound Proxy .

When logging into the phone you will see a pop up of user/pass. You will use the credentials you have entered into the Provisioning Parameters section.

In most cases administrators overlook this setting but it should be the 1st setting you configure on the system if you plan to plug and play snom devices so that you can enter your phone's web interface.

If you want to use admin mode on the phone you will have to enter the Authentication pin.