Symphony Messaging URI
URIs allow you to launch Symphony Messaging with a predefined context, from a simple link.
This works both on desktop and mobile, as well as on the web version of Symphony Messaging.
Universal URIs
Symphony Messaging 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.
Launch the desktop app
https://open.symphony.com/?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).
Open a chat
Open a chat with a single user
Opens the 1-1 chat with the user specified by its userId.
https://open.symphony.com/?startChat={userId}Open a chat with several users
Opens the group chat with the users identified by their userIds.
https://open.symphony.com/?startChat={userId1},{userId2},{userId3}Open a chat identified by its streamId
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.
https://open.symphony.com/?streamId={streamId}&streamType={streamType}Create a chat 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.
Create a chat room with user IDs
https://open.symphony.com/?startRoom=RoomName={roomName}&userIds={userId1},{userId2},{userId3}Create a chat room with user emails
Protocol example with userEmails
https://open.symphony.com/?startRoom=RoomName={roomName}&userEmails={email1},{email2}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).
https://open.symphony.com/?startRoom=RoomName={roomName}&silent=false&userEmails={email1},{email2}Federation
Users entitled to the SMS & Voice channel of our Federation product are able to directly start a chat over SMS and place a phone call, using the URI schemes described below.
Start a SMS chat with a contact using SMS & Voice
// Start SMS chat with contact +441234567890
https://open.symphony.com/#phoneNumber=+441234567890&triggerAction=SMS Call a contact using SMS & Voice
// Start phone call with contact +19291234567
https://open.symphony.com/#phoneNumber=+19291234567&triggerAction=PHONE_CALL Start a chat with a contact or onboard a contact
Depending on the contact, this URI will:
Open the existing chat if the chat with this contact already exists
Create and open the chat, if the contact is already onboarded but no chat exists
Open the contact onboarding modal, if the contact doesn't exist yet.
https://open.symphony.com/#triggerAction=CHAT&channel=WHATSAPP&phoneNumber=+33612345678&firstName=John&lastName=Doe&[email protected]&company=SymphonytriggerAction
Enum: CHAT
Mandatory
channel
Enum: WHATSAPP, SMS-DIRECT, WECHAT, LINE, SMS
Mandatory.
phoneNumber
Phone number of the contact. Mandatory.
firstName
Contact first name. Optional.
lastName
Contact last name. Optional.
email
Contact email. Optional.
company
Contact company. Optional.
Display the profile of a user
Display the profile of the user identified by its userId.
https://open.symphony.com/?userId={userId}Open an extension app
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.
https://open.symphony.com/?app/{publisher}/{appId}/{appName}/{moduletitle}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.
Examples:
Module specified:
https://open.symphony.com/?app/Symphony/com.symphony.sfs.admin-app/Federation%20Suite/WeChat%20Connect
No module specified:
https://open.symphony.com/?app/Symphony/com.symphony.zoom/Zoom%20CloudCompatibility with symphony:// URIs
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.
Last updated
Was this helpful?