How Does Callroute Microsoft Teams Provisioning Work?
To connect Callroute with your Microsoft tenancy, several different elements must be provisioned to allow calls to flow between Teams and the Callroute infrastructure. This article explains what these elements are and why they are necessary. Removing the Callroute integration is also outlined within this article.
As a guide the provisioning process typically takes between 2 – 5 minutes from start to finish assuming the Callroute prerequisites are met.
There are 4 steps to the provisioning process, and you will be required to sign into your Microsoft account twice.
The key to a successful integration is not to sign in with your personal Microsoft account. We recommend you create a dedicated user in your Microsoft tenancy for purposes of the Callroute connection, noting they must be assigned a Global Administrator role. For information and help on this topic please refer to the relevant guide on this subject, there is also additional guidance in the video at bottom of this page.
Step 1: Authorise Callroute App:
This allows Callroute to obtain the required permissions via generation of an access token in order to gain read / write access to your Microsoft Azure tenancy. The Microsoft account used to sign in must have a Global Administrator role.
Step 2: Run Readiness Check:
Callroute will use the access token generated during Step 1 to verify all prerequisites are met. Callroute prerequisites are outlined in a separate help article.
Step3: Integrate Callroute App:
You will be asked to sign into your Microsoft account for a 2nd time in order to generate a 2nd access (impersonation) token. This allows Callroute to impersonate and act on behalf of the user so that access to the Microsoft Teams admin centre is gained. This enables Callroute to create / update policies and other elements. Callroute will then commence domain provisioning.
- Creation of a subdomain in the Callroute environment for the target Microsoft tenancy to use as the virtual SBC. The subdomain will match your Microsoft ‘initial domain’ (e.g.
my-company.onmicrosoft.comand will yield a Callroute SBC subdomain of
my-company.gbr-lon-tgw.callroute.io). This subdomain is then pointed at the Callroute telephony infrastructure.
- Creating a record of the above domain within your Microsoft tenancy (see Microsoft Admin Centre: Domains).
- Verification of the domain. Please note that whilst this step typically takes a few minutes, factors relating to DNS propagation can result in a delay of 30-60 minutes and very rarely somewhat longer. This step is the most common reason for delays beyond the normal end to end provisioning time of 5 minutes.
- Creation of a new user with a principal name of Teams Gateway (
callroute.teams@<your Callroute domain>) in your Microsoft tenancy.
- Assignment of an available
MCOSTANDARD(also known as ‘SKYPE FOR BUSINESS ONLINE (PLAN 2)’) license to the new user (see this Microsoft article for information about this license type).
The next step provisions the various policies and other resources within your Microsoft tenancy to enable Direct Routing with Callroute, this uses the recently created subdomain as a virtual SBC. These new resources will only be used by the Callroute enabled users and will not have any effect on any existing Users, Dial plans, Voice routing policies etc that may already be configured in your tenant for another voice provider.
Provision Dial Plan
- Creation of a new Tenant Dial Plan called ‘Callroute-E164’, with relevant Voice Normalisation Rules (see Dial Plans)
- Creation of a new Online Voice Routing Policy called ‘Callroute-E164’ (see Voice Routing Policies).
- Enabling ‘Global’ Online PSTN Usage for the new ‘Callroute-E164′ Online Voice Routing Policy (allows this policy to work within Teams’ internal telephony routing; from Voice Routing Policies, click ‘Global (Org-wide default)’ to edit the Global policy.
- Creation and enablement of specific ‘Callroute-E164’ Online PSTN Usage for the ‘Callroute-E164’ online voice routing policy (enables this policy to work with the Callroute telephony routing, for failover and such).
- Creation of a new Online PSTN Gateway using the Callroute domain specified above (using SIP signalling port 5061; TLS encrypted SIP traffic; see Direct Routing).
- Creation of a new Online Voice Route called ‘Callroute-E164’ to allow usage of the above Online PSTN Gateway (see Voice Routes).
Step 4: Synchronise Users
Callroute will synchronise all users in your Microsoft tenancy to the Callroute database. Once the synchronisation is complete all users that have the required Microsoft licensing will be displayed in Callroute as Inactive, these users are then ready to be activated (assigned a phone number). Users that are missing the required licensing can be viewed by selecting the filter Unavailable.
Tip: If you make any changes to the Microsoft tenancy directly (via 365 or Teams admin centre) that relates to user license assignment, user roles, addition or deletion of users or phone number assignment please be sure to synchronise the service. This can be done on a individual user or all user basis. Note large user counts can take a considerable time (for example 10,000 users takes between 1-2 hours for a full sync). Individual user syncs or user fetches take just a few seconds.
Removing Callroute or integrating to a different Microsoft tenancy
To change to a different tenancy, or to remove the Callroute integration altogether, simply delete the Teams service in the Callroute portal. Navigate to Services, select the Microsoft Teams service and then click on the bin icon.
This action will de-provision all Callroute associated resources and policies within your Microsoft tenancy before deleting the access tokens Callroute holds. This step severs the connection between Callroute and the Microsoft tenancy altogether. The following de-provisioning tasks are run:
- Un-assignment of Direct Routing telephony (Tenant Dial Plans, Online Voice Routing Policies and Phone Number Assignments) from all users with ‘Callroute-E164’ Online Voice Routing Policies. This is required to allow us to delete these policies. Please note that resource accounts cannot be unassigned in this way since they do not have associated Online Voice Routing Policies when their line URIs are assigned.
- Removal of the Online Voice Route ‘Callroute-E164’.
- Removal of the Online Voice Routing Policy ‘Callroute-E164’.
- Removal of the Tenant Dial Plan ‘Callroute-E164’
- Removal of the Online PSTN Gateway SBC connection from your Microsoft Teams tenancy to your Callroute domain.
- Deletion of access tokens that Callroute holds.
After the delete process has run all settings, policies and phone number assignments previously associated to Callroute will have been deleted. This can be verified by inspecting the Microsoft Teams admin centre.
Optional step: If you created a service user for purposes of the Callroute connection, this user can now be deleted from your tenancy.
Important note regarding deletion:
The delete process cannot be undone and is permanent in the respect of the Microsoft tenancy. There is no “undo” option so please verify this is the course of action you wish to take before confirming deletion. The same tenancy can however be added again and configured per the above (noting none of the previous settings or assignments will have been remembered).
A full overview of the provisioning process that includes more information around the prerequisites are contained within the following video: