Symphony Messaging URI
Last updated
Last updated
This works both on desktop and mobile, as well as on the web version of Symphony Messaging.
Symphony now supports universal URIs (https links starting with open.symphony.com), but still supports the previous symphony:// URIs. See the section Compatibility with symphony:// URIs below for more info.
When a user clicks on a universal URI, a webpage opens and proposes several options relevant to the user, such as opening the link in the desktop or the mobile app, depending on the current context, but also opening in the browser (web version).
Note: On the desktop app, clicking on a URI will either replace an existing module, if one is unpinned, or otherwise open a new module in the grid.
If the desktop app is not running, it starts up and gets focus.
If the desktop app is already running, it focuses on the app. If the app is minimized, it brings the app to the foreground.
If the desktop app is already running and in focus, it has no effect (the app remains in focus).
Opens the 1-1 chat with the user specified by its userId.
Opens the group chat with the users identified by their userIds.
Displays the chat conversation identified by its streamId and streamType.
The streamType is set to chatroom for chat rooms or im for 1-1 chats.
If the app is not running, it starts up first then opens the chat.
If the app is minimized, it is brought to the foreground first.
If all provided user IDs are invalid, Symphony will open but no chat will be displayed.
If a chat room where the user is not a participant is specified, the user will be prompted to request access to the room.
The room creator's userID or userEmail must be included in the list of users alongside the other room members. If the current user is not included, the user will receive an error message: 'Please ensure your own email address is included in room creation URL'
The room name is mandatory. If it is not provided, nothing will happen.
It is possible to either directly create the room, or show a room creation modal where the user will be able to configure and confirm the room creation, see example below.
Note: The room name can contain spaces only if the link is opened in Google Chrome.
You can't create a chat room with external participants. To do this, please set the flag silent=false to spawn the room creation panel where the user can confirm the room creation, as described in the section below Create a chat room with room creation dialog.
By default, the create room URI silently creates the room. It is possible instead to show a room creation dialog, where the user will be able to configure settings, add members if needed, and initiate connection requests if some of the prepopulated members where not connected.
To do that, set the silent flag to false (default:true).
Display the profile of the user identified by its userId.
If an external userId of a user who is not entitled to external communications is specified, a blank user profile is opened.
Open an extension app, identified by its publisher, app id, app name, and optionally a module title.
The module title corresponds to the title of the navigation item registered by the app in the left navigation menu. It is useful when an app has registered several entries and you want to select one.
The appId, appName & publisher information can be found in the Admin Portal, under the App Management section.
Alternatively, you can simply open the app module you want to get a link to, click on the hamburger menu in the top right corner, and select Copy app link to copy the URI to your clipboard.
Extension apps are not supported on Mobile.
If the user is not entitled to the app, the Marketplace will open with the app card in focus
If the app does not exist in the user's Marketplace, an error will be displayed.
If no moduleTitle is specified, the first entry in the navigation will open.
If there is no app that matches all filters (publisher, appId, appName), an app that matches at least two of the filters will open.
Examples:
Previous URI links (symphony://) continue to work.
In certain cases they may still be the best option for you, for example, when you integrate Symphony with a native app and don't want the universal URI webpage to open.
To create legacy links, simply replace open.symphony.com with symphony:// in the URIs above.
