How do I use Switchvox for Microsoft Teams

Overview

The Switchvox app for Microsoft Teams allows users to start a phone call using their Switchvox phone.

Prerequisites

To use the Switchvox app you will need:

• A Cloud or on-premise Switchvox PBX environment. To set up a Switchvox Cloud trial, please visit https://www.sangoma.com/products/communications-services/unified-communications-business-phone-systems/switchvox-cloud/

• A Switchvox Phone Extension on your Switchvox

• A Switchvox phone, for example the Switchvox Desktop Softphone or a D-Series Phone connected to your phone extension on Switchvox. (Your Switchvox administrator assigns a Softphone to you, and will provide a download link.)

• External network access to Switchvox. In Server > Access Control rules, User Web Portal service is required for any network that users are on who need to use the app. Also, be sure that your firewall allows the appropriate access to Switchvox: see Firewall/NAT Checklist.

• Switchvox 8.x.x

To allow directory lookup functionality, please refer to the Notes to administrators section.

Admin Installation

1. Download the app package from 

2. As Microsoft Teams env administrator, open https://admin.teams.microsoft.com/

3. Select Teams apps > Manage apps

   Open

   

4. Select Actions >Upload new app

   Open

   

5. Choose the downloaded package file (switchvox-teams-1.0.97.zip) and then Upload

6. Adjust 'Permissions' and other options as required, so that users can use the app

Now the app will appear in the list of apps for regular users, in the 'Built for your org' section.

Using the App

After installation you will see the Switchvox app icon on the shortcuts bar of Microsoft Teams. You can use this icon to open the Switchvox bot conversation.

The Switchvox app will send a welcome prompt with a Setup action. Use the Setup action to configure the app. You will need to provide the following information:

• Switchvox PBX server address (e.g., switchvox.mybiz.com)

• Extension number

• Extension password (your web password, not your voicemail numeric PIN)

Commands

The Switchvox app supports several commands allowing you to interact with Switchvox and initiate phone calls.

Help

When the Switchvox app receives a command it cannot handle, or when the Help command is sent, the bot channel will reply with quick usage info.

Configuration

You need to configure the Switchvox app before you can begin making calls. This could be done using the Setup command on initial welcome prompt

Or you can send the Configuration command and click Edit configuration

In both cases the Switchvox app will open a form to configure your Switchvox PBX connection.

Once configuration is defined and saved, Switchvox app will try to connect to Switchvox and will send updated configuration information in bot conversation.

Dial

Dialing is the primary use case for the Switchvox app. Whenever you need to place a call you no longer need to leave Microsoft Teams. You have several ways to can initiate dialing:

• Send the Dial <number> command. If you are already connected to your Switchvox PBX, then dialing will start immediately. Otherwise you might be prompted to define your PBX configuration.

• Send the Dial <name> command.

• Click the Switchvox action in the Microsoft Teams compose box.

• Type @Switchvox in Microsoft Teams command box. This can now be treated as your Switchvox dialpad. Once the @Switchvox command is entered in compose box, it will stay there. Enter a phone number, press Enter on keyboard and a new call will be placed.

After placing a call, the Switchvox app will notify you, by replying with a message. You can click this message to redial the same number.

Redial

The Switchvox app tracks a list of numbers dialed using the app. To show your recent calls list use the Redial command.

Clicking an item in redial list will open Dial form.

Select or enter a number when prompted and click Dial to start a call.

Sign out

Sign out clears all information collected by the application for the user, including configuration, recent calls list, and authentication information. Please note that even though configuration is fully cleared on the server, your bot conversation history will be preserved.

Once a user is signed out, the Switchvox app will send a welcome message to start app configuration again.

Contextual dialing

The Switchvox app adds an action at the bottom of Microsoft Teams compose box. This action behaves differently depending on your current context.

• When used in a personal chat, it will lookup phones numbers of people you are in a conversation with and will open the Dial form.

• When used in group chat, it will present a list of all members of the chat. Select a contact to dial and the Switchvox app will present the Dial form.

• When used in a channel, it will present a list of channel members. You can also search contact in this form by name.

• When the context is neither of above, for example you use the Switchvox action within a bot conversation, it will present a form with the entire organization directory. You can also search contact in this form by name.

Notes to administrators

The Switchvox app has to be granted access to several scopes in your Active Directory, to allow the app to perform contact information lookups in Active Directory on behalf of a user. This step can be performed only by an account with administrative permissions. List of scopes:

• Chat.Read - used by the app to resolve chat members

• Groups.Read - used by the app to resolve channel members

• User.ReadAll - used by the app to get information about user phones and image

Procedure of granting such access to the app is very simple.

1. Open https://ms-teams-swvx.sangoma.com/admin/

2. Enter your Azure Tenant ID (e.g. 00000000-0000-0000-0000-000000000000) or Tenant FQDN (example.onmicrosoft.com)

3. Click Continue