Symphony Messaging Dev Docs
Developer CertificationREST API
  • Start Your Developer Journey
  • Bots
    • Building Bots
    • Planning Your Bot
      • Conversational Bot
      • Interactive Bot
      • Headless Bot
    • Getting Started
      • Getting Started with BDK
      • Creating a Service Account
      • Configuration
      • Truststores
    • Overview of REST API
      • REST API Architecture
      • Overview of Pod API
      • Overview of Key Manager API
      • Overview of Agent API
      • Bot Permissions
      • REST API Reference
    • Authentication
      • RSA Authentication Workflow
      • Certificate Authentication Workflow
    • Datafeed
      • Real-Time Events
      • Overview of Streams
    • Messages
      • MessageML
        • MessageML Basics
          • Content Grouping
          • Text formatting and semantics
          • Tables
          • Images
          • Tags and mentions
            • Enhanced tags notice
          • Style Attributes
          • Special Characters
          • Emojis
        • Elements Interactive Forms
          • Buttons
            • Icon set for Buttons
          • Text Field
          • Masked Text Field
          • Text Area
          • Checkbox
          • Radio Button
          • Dropdown Menu
          • Person Selector
          • Room Selector
          • Date Picker
          • Time Picker
          • Timezone Picker
          • Table Select
          • Regular Expressions - Regex
        • Extensibility UI Actions
          • OpenChat
          • Dialog
        • Entities
          • Standard Entities
          • Custom Entities
      • PresentationML
    • Bots Best Practices
    • Open Source Code Samples
  • Extension Apps
    • Building Extension Apps
    • Planning Your App
    • Getting Started
      • Getting Started with ADK
      • Application Manifest Bundle
      • Add an Extension App to a Symphony Pod
    • Overview of Extension API
      • Initialization
      • Register and Connect
      • Extension API Services
        • Service Interface
        • Register and Subscribe
        • Modules Service
        • Entity Service
          • Entity Advanced Templating
          • Message Format - ExtensionML
        • Applications-Nav Service
        • Share Service
        • Commerce Service
        • Dialogs Service
        • UI Service
          • Receiving Conversation and User Information
          • Filter Function
    • App Authentication
      • Circle of Trust Authentication
      • OBO Authentication
  • Developer Tools
    • Symphony Messaging Generator
    • Bot Developer Kit for Java
      • Build a Conversational Bot
      • Build an Interactive Bot
      • Build a Headless Bot
      • Integrate a Bot with an Identity Provider
    • Bot Developer Kit for Python
    • App Developer Kit
      • Build a Basic Extension App
      • Build an Extension App with App Views
        • Add Buttons and Handlers to an Extension App
        • Add BDK to an Extension App for Circle of Trust
      • Build an Extension App with Message Renderers
    • Postman
    • UI Style Guide
      • Colors
      • Form Elements
      • Buttons
  • Embedded Modules
    • Symphony Messaging URI
      • Symphony Messaging URI for Mobile (deprecated)
    • Desktop interoperability
      • FDC3 intents
        • Message format
      • Configuration guide
        • Configure Interop.io
        • Configure Here Core
        • Configure Finsemble
        • Configure with Embedded Mode
        • Troubleshooting
      • Change log
    • Embedded Mode
      • Get started
      • Configuration parameters
      • Open a chat
      • Send a message
      • Create a room
      • Pin a message
      • Notifications
      • Support for extension applications
      • Open an app
      • Embedded Mode with Sponsored Access
      • Pricing tiers
      • Logout
    • Universal Webhook
      • User guide
        • Example with Splunk
      • Installation guide
  • Symphony REST API
    • Messaging REST API
    • Federation
    • Sponsored Access API
    • Enhanced Directory API
  • Developer Certification
    • Developer Certification
  • Mobile Frameworks
    • Blackberry
    • MobileIron
  • Admin Guides
    • Change Logs
      • API Agent
        • Agent - 25.3 (LTS)
        • Agent - 24.12 (LTS)
        • Agent - 24.9 (LTS)
        • Agent - 24.6 (LTS)
        • Archives
          • Agent - 24.11
          • Agent - 24.10
          • Agent - 23.9 (LTS)
          • Agent - 24.8
          • Agent - 24.3 (LTS)
          • Agent - 24.2
          • Agent - 24.1
          • Agent - 23.12 (LTS)
          • Agent - 23.11
          • Agent - 23.10
          • Agent - 23.7
          • Agent - 23.6 (LTS)
          • Agent - 23.4
          • Agent - 23.3 (LTS)
          • Agent - 23.1
          • Agent - 22.12 (LTS)
          • Agent - 22.11
          • Agent - 22.10
          • Agent - 22.9 (LTS)
          • Agent - 22.8
          • Agent - 22.7
          • Agent - 22.6 (LTS)
          • Agent - 20.14
          • Agent - 20.13
          • Agent - 20.12
          • Agent - 20.10
          • Agent - 20.9 (2.62)
          • Agent - 20.7 (2.61)
          • Agent - 20.6 (2.60)
          • Agent - 20.5 (2.59)
          • Agent - 20.4 (2.58)
      • SBE (Pod API)
        • SBE - 24.1
        • SBE - 20.16
        • SBE - 20.15
        • Archives
          • SBE - 20.14
          • SBE - 20.13
          • SBE - 20.12
          • SBE - 20.10
          • SBE - 20.9 (1.62)
          • SBE - 20.7 (1.61)
          • SBE - 20.6 (1.60)
          • SBE - 20.5 (1.59)
          • SBE - 20.4 (1.58)
      • Client 2.0 APIs
        • Client 2.0 - 25.05
        • Client 2.0 - 25.03
        • Client 2.0 - 24.12
        • Client 2.0 - 24.05
        • Client 2.0 - 23.02
        • Client 2.0 - 22.11
        • Archives
          • Client 2.0 - 20.4
          • Client 2.0 - 20.5
          • Client 2.0 - 20.6
          • Client 2.0 - 20.7
          • Client 2.0 - 20.9
          • Client 2.0 - 20.10
          • Client 2.0 - 20.12
          • Client 2.0 - 22.8
          • Client 2.0 - 22.10
      • Universal Webhook
        • Univ Webhook - 2.6
        • Univ Webhook - 2.4
        • Univ Webhook - 2.2
        • Univ Webhook - 2.1
        • Univ Webhook - 2.0
    • API Change Management
    • Global Throttling
    • Agent Guide
      • Network Topology
      • Agent Download
      • Agent Installation
      • Agent Configuration Fields
      • Agent Server High Availability
      • Agent Performance Tuning
Powered by GitBook
On this page
  • Universal URIs
  • Launch the desktop app
  • Open a chat
  • Open a chat with a single user
  • Open a chat with several users
  • Open a chat identified by its streamId
  • Create a chat room
  • Create a chat room with user IDs
  • Create a chat room with user emails
  • Create a chat room with room creation dialog
  • Federation
  • Start a SMS chat with a contact using SMS & Voice
  • Call a contact using SMS & Voice
  • Start a chat with a contact or onboard a contact
  • Display the profile of a user
  • Open an extension app
  • Compatibility with symphony:// URIs

Was this helpful?

Export as PDF
  1. Embedded Modules

Symphony Messaging URI

Last updated 1 month ago

Was this helpful?

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 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}
  • 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.

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.

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  

Error management: for both SMS and PHONE_CALL, if the targeted phone number has no country indicator, or does not seem valid, the phone left rail will open with the requested phone number, in order for the user to complete the intended action.

Start a chat with a contact or onboard a contact

Available starting with C2 25.5 (May 2025)

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=john.doe@symphony.com&company=Symphony
Parameter
Description

triggerAction

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}

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

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.

  • 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:

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%20Cloud

Compatibility 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.

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
Compatibility with symphony:// URIs
Universal URI landing page