Reference13r2:Concept myApps Custom App for MS Teams

From innovaphone wiki
Jump to navigation Jump to search

Applies To

This information applies to

  • innovaphone PBX from version 13r2

Overview

  • The feature is intended to integrate the myApps web client into MS Teams as a custom app.
  • The PBX offers a download link for that custom app that can then be uploaded into MS teams.
  • The app is auto-configured with the URL and Domain Names of the PBX.

Note: The custom app offers no further integration into Teams in 13r2 besides opening the web client. Deeper intergrations might follow in future releases.

Requirements

PBX

  • Firmware version 13r2 or higher
  • The PBX must have a DNS name configured
  • The PBX (and the Reverse Proxy) must have an official signed device certificate with a name matching the DNS name

MS Teams

  • Side-loading of custom apps has to be enabled for the organization

Details

Download

Custom App Details

The custom app is a ZIP file containing icons and a manifest.json.

Please see the Microsoft documentation for details on the manifest format: https://docs.microsoft.com/en-us/microsoftteams/platform/resources/schema/manifest-schema

Dynamic parts of the auto-generated manifest

version
The build number of the PBX firmware.
id
An app ID that is unique per PBX DNS name.
name.full
Contains the DNS name of the PBX.
description.full
Contains the DNS name of the PBX.
description.short
Contains the DNS name of the PBX.
staticTabs[0].contentUrl
The myApps-URL of the PBX.
validDomains
The DNS name of the PBX.

Example manifest

The following example shows a manifest created for a PBX with the following configuration: 

 config change PBX0 /gk-id example.com /dns pbx.example.com /gk-domain
System Name
example.com
Use as Domain
on
DNS
pbx.example.com


 {
   "$schema": "https://developer.microsoft.com/en-us/json-schemas/teams/v1.8/MicrosoftTeams.schema.json",
   "manifestVersion": "1.8",
   "version": "135724",
   "id": "0e33ff1e-7744-8dda-11ee-fee8459a836f",
   "packageName": "com.innovaphone.myapps",
   "developer": {
     "name": "innovaphone AG",
     "websiteUrl": "https://innovaphone.com",
     "privacyUrl": "https://innovaphone.com",
     "termsOfUseUrl": "https://innovaphone.com"
   },
   "icons": {
     "color": "color.png",
     "outline": "outline.png"
   },
   "name": {
     "short": "innovaphone myApps",
     "full": "innovaphone myApps (pbx.example.com)"
   },
   "description": {
     "short": "innovaphone myApps (pbx.example.com)",
     "full": "This app shows the innovaphone myApps client for pbx.example.com."
   },
   "accentColor": "#FFFFFF",
   "staticTabs": [
     {
       "entityId": "com.innovaphone.myapps.client",
       "name": "myApps",
       "contentUrl": "https://pbx.example.com/PBX0/APPCLIENT/appclient.htm",
       "scopes": [
         "personal"
       ]
     }
   ],
   "permissions": [
     "identity",
     "messageTeamMembers"
   ],
   "validDomains": [
     "pbx.example.com"
   ],
   "devicePermissions": [
     "media",
     "geolocation",
     "notifications",
     "openExternal"
   ]
 }

Troubleshooting

Duplicated myApps app under "more added apps (the three dot "..." on the left side bar menu)

This can occur when user has added myApps app from his organisation and also uploaded by himself the customised app.

Upload fail

Be sure to upload the zip file that was previously download under PBX/Config/myApps and that the requirements are fulfilled.

myApps does not load in MS Teams client (white page)

Be sure that all involved devices have a proper signed certificate loaded. Devices can be PBX, Reverse Proxy, App Platform.

It seems that MS Teams does not allow to display apps when a certificate error happens.

However we have seen that via a web browser MS Teams does not "complain" about that and will display myApps.

See more about certificate and requirement:

Expected restrictions of MS Teams

No WebRTC screen sharing

Teams does not support WebRTC screen sharing. So the softphone app inside teams won't support it either.

Pop-out apps in native teams client do not support WebRTC

So the softphone app can just work in the main teams window. Also undocking the video window won't work.

Switching to a different app closes the current app

In Teams client, Apps are closed when you switch to a different app/menu from the left side bar. The same will happen for myApps.

Retrieved from "https://wiki.innovaphone.com/index.php?title=Reference13r2:Concept_myApps_Custom_App_for_MS_Teams&oldid=60945"