Wazo Documentation Release 17.16 The Wazo Authors Nov 20, 2017 Contents 1 Table of Contents 3 1.1 Introduction...............................................3 1.2 Installation................................................3 1.3 Getting Started..............................................9 1.4 Upgrading................................................ 15 1.5 Wazo Client............................................... 63 1.6 System.................................................. 83 1.7 Ecosystem................................................ 158 1.8 Administration.............................................. 174 1.9 Contact Center.............................................. 335 1.10 High Availability (HA).......................................... 372 1.11 Scalability and Distributed Systems................................... 383 1.12 API and SDK............................................... 393 1.13 Contributors............................................... 476 1.14 Quality assurance............................................. 577 1.15 Troubleshooting............................................. 577 1.16 Community Documentation....................................... 586 1.17 Documentation changelog........................................ 588 1.18 Attribution Notice............................................ 588 2 Changelog 589 3 Indices and tables 591 i ii Wazo Documentation, Release 17.16 Wazo is an application suite based on several free existing components including Asterisk, and our own developments to provide communication services (IPBX, Unified Messaging, . ) to businesses. Wazo is free software. Most of its distinctive components, and Wazo as a whole, are distributed under the GPLv3 license. You may also check the Wazo blog for more information. Wazo documentation is also available as a downloadable HTML, EPUB or PDF file. See the downloads page for a list of available files or use the menu on the lower right. See Attribution Notice Contents 1 Wazo Documentation, Release 17.16 2 Contents CHAPTER 1 Table of Contents 1.1 Introduction Wazo is a PABX application based on several free existant components including Asterisk and our own developments. Wazo provides a solution for enterprises who wish to replace or add telephone services (PABX). Wazo is free software. Most of its distinctive components, and Wazo as a whole, are distributed under the GPLv3 license. 1.1.1 Wazo History Wazo is a fork of XiVO, which was created in 2005 in France by Sylvain Boily and the company Proformatique. In 2010, Proformatique merged with Avencall, and Avencall acquired the copyright and trademark of XiVO. Sylvain then moved to Quebec City and founded Proformatique, Inc. where the XiVO core development team worked from 2011 until November 2016. In November 2016, Proformatique Inc. was shut down and the development team forked XiVO to create Wazo. Its first release, Wazo 16.16, was released in December 2016. 1.2 Installation 1.2.1 Installing the System Please refer to the section Troubleshooting if ever you have errors during the installation. There are two official ways to install Wazo: • using the official ISO image • using a minimal Debian installation and the Wazo installation script 3 Wazo Documentation, Release 17.16 Wazo can be installed on both virtual (QEMU/KVM, VirtualBox, . ) and physical machines. That said, since Asterisk is sensitive to timing issues, you might get better results by installing Wazo on real hardware. Requirements For a small install of about 20 users, less than 20 calls per day: • RAM: 1 GiB is barely functional (with swap), 1.5 GiB gives a tight margin of operation, 2 GiB is quite com- fortable • Storage: 2.5 GiB of storage is a very tight minimum, 8 GiB is comfortable Installing from the ISO image • Download the ISO image. (latest version)(all versions) • Boot from the ISO image, select Install and follow the instructions. You must select a locale with charset UTF-8. • At the end of the installation, if you are installing version 16.13 or before, you need to configure your system to use the Wazo infrastructure, otherwise some errors might occur. • Continue by running the configuration wizard. Installing from a minimal Debian installation Wazo can be installed directly over a 32-bit or a 64-bit Debian jessie. When doing so, you are strongly advised to start with a clean and minimal installation of Debian jessie. The latest installation image for Debian jessie can be found at https://www.debian.org/releases/jessie/debian-installer. Requirements The installed Debian must: • use the architecture i386 or amd64 • have a default locale with charset UTF-8 In case you want to migrate a Wazo from i386 to amd64, see Migrate Wazo from i386 (32 bits) to amd64 (64 bits). Installation Once you have your Debian jessie properly installed, download the Wazo installation script and make it executable: wget http://mirror.wazo.community/fai/xivo-migration/wazo_install.sh chmod+x wazo_install.sh And run it: ./wazo_install.sh At the end of the installation, you can continue by running the configuration wizard. 4 Chapter 1. Table of Contents Wazo Documentation, Release 17.16 Alternatives versions The installation script can also be used to install an archive version of Wazo. For example, if you want to install Wazo 16.16: ./wazo_install.sh-a 16.16 You may also install development versions of Wazo with this script. These versions may be unstable and should not be used on a production server. Please refer to the usage of the script: ./wazo_install.sh-h Other installation methods It’s also possible to install Wazo by PXE. More details available on our blog: • http://blog.wazo.community/around-xivo-describe-industrial-installation-process.html • http://blog.wazo.community/around-xivo-pxe-server-setup.html • http://blog.wazo.community/around-xivo-pxe-and-preseeding.html 1.2.2 Running the Wizard After the system installation, you must go through the wizard before being able to use your Wazo. Open your browser and enter your server’s IP address in the navigation bar. (For example: http://192.168.1.10) Language You first have to select the language you want to use for the wizard. Fig. 1.1: Select the language License You then have to accept the GPLv3 License under which Wazo is distributed. 1.2. Installation 5 Wazo Documentation, Release 17.16 Fig. 1.2: Accept the license Fig. 1.3: Basic configuration 6 Chapter 1. Table of Contents Wazo Documentation, Release 17.16 Configuration 1. Enter the hostname (Allowed characters are : A-Z a-z 0-9 -) 2. Enter the domain name (Allowed characters are : A-Z a-z 0-9 - .) 3. Enter the password for the root user of the web interface, 4. Configure the IP address and gateway used by the VoIP interface 5. Finally, modify the DNS server information if needed. Entities and Contexts Contexts are used for managing various phone numbers that are used by your system. • The Internal calls context manages extension numbers that can be reached internally • The Incalls context manages calls coming from outside of your system • The Outcalls context manages calls going from your system to the outside Fig. 1.4: Entities and Contexts 1. Enter the entity name (e.g. your organization name) (Allowed characters are : A-Z a-z 0-9 - .) 2. Enter the number interval for you internal context. The interval will define the users’s phone numbers for your system (you can change it afterwards) 3. Enter the DID range and DID length for your system. 4. You may change the name of your outgoing calls context. Validation Finally, you can validate your configuration by clicking on the Validate button. Note that if you want to change one of the settings you can go backwards in the wizard by clicking on the Previous button. 1.2. Installation 7 Wazo Documentation, Release 17.16 Warning: This is the last time the root password will be displayed. Take care to note it. Congratulations, you now have a fully functional Wazo server. To start configuring Wazo, see Getting Started. 1.2.3 Post Installation Here are a few configuration options that are commonly changed once the installation is completed. Please note that these changes are optional. Display called name on internal calls When you call internally another phone of the system you would like your phone to display the name of the called person (instead of the dialed number only). To achieve this you must change the following SIP options: • Services ! IPBX ! General settings ! SIP Protocol ! Default: – Trust the Remote-Party-ID: yes, – Send the Remote-Party-ID: select PAI Incoming caller number display The caller ID number on incoming calls depends on what is sent by your operator. You can modify it via the file /etc/xivo/asterisk/xivo_in_callerid.conf. Note: The reverse directory lookup use the caller ID number after it has been modified by xivo_in_callerid. conf Examples: • If you use a prefix to dial outgoing numbers (like a 0) you should add a 0 to all the add = sections, • You may want to display incoming numbers in E.164 format. For example, you can change the [national1] section to: callerid = ^0[1-9]\d{8}$ strip = 1 add = +33 To enable the changes you have to restart xivo-agid: service xivo-agid restart Time and date • Configure your locale and default time zone device template => Configuration ! Provisioning ! Template Device by editing the default template • Configure the timezone in => Services ! IPBX ! General settings ! Advanced ! Timezone 8 Chapter 1. Table of Contents Wazo Documentation, Release 17.16 • If needed, reconfigure your timezone for the system: dpkg-reconfigure tzdata Codecs You should also select default codecs. It obviously depends on the telco links, the country, the phones, the usage, etc. Here is a typical example for Europe (the main goal in this example is to select only G.711 A-Law instead of both G.711 A-Law and G.711 µ-Law by default): • SIP : Services ! IPBX ! General settings ! SIP Protocol ! Signaling: – Customize codec : enabled – Codec list: G.711A-Law G.722 G.729A H.264 • IAX2 : Services ! IPBX ! General settings ! IAX Protocol ! Default: – Customize : enabled – Codec list: G.711A-Law G.722 G.729A H.264 1.3 Getting Started This section will show you how to create a user with a SIP line.