Uniphore Customer Portal

Open a PowerShell for Windows session and enter the following commands:

#Ensure correct modules are installed
Install-Module PowerShellGet -Force -AllowClobber
Install-Module MicrosoftTeams 

#To check your MicrosoftTeams version:
Get-Module -Name MicrosoftTeams -ListAvailable

# Ensure you session has correction permissions
Set-ExecutionPolicy -ExecutionPolicy Unrestricted

Import-Module MicrosoftTeams

By default, the PowerShell Gallery (PSGallery) is not configured as a trusted repository for PowerShellGet. The first time you use the PSGallery, you'll see the following message:

Untrusted repository

You are installing the modules from an untrusted repository. If you trust this repository, change its InstallationPolicy value by running the Set-PSRepository cmdlet.

Are you sure you want to install the modules from 'PSGallery'?
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "N"):

Then authenticate with Microsoft Teams:

Connect-MicrosoftTeams

This will create the application instance required to hook the bot up to the Microsoft Teams tenant. The output of this command will include an ObjectId, save this value.

New-CsOnlineApplicationInstance -UserPrincipalname "{Application-Instance-UPN}" 
-DisplayName "{Display-Name}" -ApplicationId "{Application-Id}"

Using the Application-Instance-UPN , go to the Azure Active Directory blade in the Azure Portal, and under Users find the object matching the given UPN and apply the following steps:

This will synchronize the application instance from Azure Active Directory into the Agent Provisioning Service.

Sync-CsOnlineApplicationInstance -ObjectId "{ApplicationInstance-Object-Id}"

This section will create the policy that enables recording for Users and/or Groups.

New-CsTeamsComplianceRecordingPolicy -Identity "{Identity}" -Enabled $true 
-Description "{Description}"

Here we will instantiate an instance of the previously created application and assign it to the new policy.

Set-CsTeamsComplianceRecordingPolicy -Identity "{Identity}" 
-ComplianceRecordingApplications @(New-CsTeamsComplianceRecordingApplication 
-Id "{Object-ID}" -Parent "{Identity}")

We can configure the bot to refuse to connect calls if the bot is unavailable, using the following command:

Set-CsTeamsComplianceRecordingApplication -Identity "{Identity}" 
-RequiredBeforeCallEstablishment $true | $false 
-RequiredBeforeMeetingJoin $true | $false -RequiredDuringCall $true | $false 
-RequiredDuringMeeting $true | $false

This will create the application instance required to hook the bot up to the Microsoft Teams tenant.

New-CsOnlineApplicationInstance -UserPrincipalname "{Application-Instance-UPN}" 
-DisplayName "{Display-Name}" -ApplicationId "{Application-Id}"

The output of this command will include an ObjectId, save this value.

We need to ensure the new application instance has been correctly synchronised, so call the following using the ObjectId displayed in the last command:

Sync-CsOnlineApplicationInstance -ObjectId {Object-Id}

Now we’ll pair the newly created application instance with the application created with the primary bot. Execute the following command and copy the appropriate Identity:

Get-CsTeamsComplianceRecordingApplication

Here’s an example output:

Identity                              : Tag:redBoxRecordingPolicy/4a8b8286-ba…
Priority                              : 0
ComplianceRecordingPairedApplications : {}
Id                                    : 4a8b8286-bab2-4588-9642-6a31744fd5e6
RequiredBeforeMeetingJoin             : True
RequiredBeforeCallEstablishment       : True
RequiredDuringMeeting                 : True
RequiredDuringCall                    : True
ConcurrentInvitationCount             : 1

From this example, we would copy the Identity property which is set to:

Tag:redBoxRecordingPolicy/4a8b8286-ba… and the {Id} property which is set to:

4a8b8286-bab2-4588-9642-6a31744fd5e6. We’ll refer to the Id property as the SourceId.

Next we‘ll execute a series of commands to create the paired application and associate with our existing application and finally synchronise both the source and newly paired application.

# Create the new paired application and update the original.
Set-CsTeamsComplianceRecordingApplication -Identity {Identity} 
-ComplianceRecordingPairedApplications 
@(New-CsTeamsComplianceRecordingPairedApplication -Id {ObjectId}) 
# Synchronise both the new and original application instances.
Sync-CsOnlineApplicationInstance -ObjectId  {ObjectId}
Sync-CsOnlineApplicationInstance -ObjectId  {SourceId}

Finally, we‘ll verify that the application has been correctly created and updated by executing the following command:

Get-CsTeamsComplianceRecordingApplication | where {$_.Id -eq {SourceId}}

The output from here should now include the updated source application, where the ComplianceRecordingPairedApplications property has a new Id in the array:

Identity                              : Tag:redBoxRecordingPolicy/4a8b8286-ba…
Priority                              : 0
ComplianceRecordingPairedApplications : {Id=4a8b6175-cac3-1555-6642-5a31733cc4d7}
Id                                    : 4a8b8286-bab2-4588-9642-6a31744fd5e6
RequiredBeforeMeetingJoin             : True
RequiredBeforeCallEstablishment       : True
RequiredDuringMeeting                 : True
RequiredDuringCall                    : True
ConcurrentInvitationCount             : 1

Grant-CsTeamsComplianceRecordingPolicy -Identity "{User-Principal-Name}" 
-PolicyName "{Policy-Identity}"

Get-CsOnlineUser -Filter {Department -eq "{Department-Name}"} | 
Grant-CsTeamsComplianceRecordingPolicy -PolicyName "{Policy-Identity}"

Get-CsOnlineUser | Grant-CsTeamsComplianceRecordingPolicy 
-PolicyName "{Policy-Identity}"

All new users will be assigned the policy.

Grant-CsTeamsComplianceRecordingPolicy -PolicyName "{Policy-Identity}" -Global 

Grant-CsTeamsComplianceRecordingPolicy -Identity "{User-Principal-Name}" -PolicyName $null

During testing or verification stages it can be useful to disable and re-enable the policy at a global level. To do so, execute the following command:

Set-CsTeamsComplianceRecordingPolicy -Identity "{Policy-Identity}" 
-Enabled {Enabled-State}