Symphony URI for Mobile

The symphony: URI can be used to launch the Symphony Android or iOS application from another application.

Launch the Symphony mobile app from another app

Launch the Symphony mobile app (Android & iOS) with a chat

symphony://chat_with?streamId=STREAM_ID&streamType=STREAM_TYPE
  • streamId is the Symphony stream ID of the chat.

  • streamType is the stream type of the chat (CHATROOM for room or IM for 1-1 chat).

symphony://chat_with?streamId=Adf7bo7AH%2F%2F%2FqxBLjLwdA%3D%3D&streamType=CHATROOM

When the app is launched with the above URL, the UI should pop to the root view controller (if necessary) and then automatically dive into a room with the stream ID Adf7bo7AH///qxBLjLwdA==.

The stream ID should be URL encoded. For instanceAdf7bo7AH///qxBLjLwdA== will be URL encoded asAdf7bo7AH%2F%2F%2FqxBLjLwdA%3D%3D.

Launch the Symphony iOS app with a username

symphony://chat_with?username=USERNAME&name=USER_FULL_NAME
  • username is the Symphony username of the person with whom the user wants to start/continue a 1-1 chat.

  • name is an optional parameter used to specify the first and last name of the person with whom the user wants to start/continue a 1-1 chat. This will be used for a fallback option if no user could be found with the provided username.

symphony://chat_with?username=john.smith&name=John%20Smith

When the app is launched with the above URL, the UI should pop to the root view controller (if necessary) and then automatically dive into a 1-1 chat with John Smith.

  • If there was an existing 1-1 with the user john.smith, all the conversation history would be expected to be present.

  • If there was no existing 1-1 conversation with the user john.smith, a new 1-1 conversation would be created.

  • If there was no such user with the username john.smith, the user should be directed to a Global Search on the People tab with the search text field pre-populated with the user's full name.

Note: The symphony URI only supports internal use cases, as look up by username is only possible within the same company.