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.5
        • 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
  • SBE API changes
  • Added APIs
  • Updated APIs
  • Fixes
  • Other changes
  • Improved CSRF checks on backend APIs
  • Integration Bridge

Was this helpful?

Export as PDF
  1. Admin Guides
  2. Change Logs
  3. SBE (Pod API)

SBE - 20.16

Last updated 1 year ago

Was this helpful?

SBE API changes

Added APIs

  • - Added new admin API to list the streams of a particular user.

Updated APIs

  • : It is now possible to suppress a message in External rooms. Please note that if the counterpart pod is not yet on SBE 20.16, the message will only be suppressed on your end.

  • Room endpoints: Room management endpoints now return a groupChat property, which is true when the room is also a group chat (an unnamed chat between more than two users). If the stream is not a group chat, then groupChat is either false or not present. In the Symphony client, if an end user creates a new chat with more than one other member, it creates a group chat, or opens an existing group chat with the same members if one exists. The API does not offer this capability, but it allows to create MIMs (Multiple Instant Messages) which are similar to group chats but are less flexible. In the future, it will become possible to create group chats through the API, and MIMs will be deprecated. Below are the main differences between group chats and MIMs:

    • Group chats are similar to rooms: Users can be added and removed. A group chat is named automatically, based on the names of the participants. A group chat can also be renamed, but in that case, it automatically becomes a room. Chat properties of group chats can't be changed. All members of a group chat are also 'owners'. Most of the time, only one group chat exists with a fixed list of participants. However it is possible to create duplicates, for example by adding or removing a participant from another group chat.

    • MIMs are the previous version of group chats and are more similar to IMs. There can't be more than one MIM with a fixed list of participants. If a user is added or removed from a MIM, then a different MIM is opened with the new list of members, or if that MIM already exists, it opens. Group chats were introduced because they allow to bring new members into a conversation without losing the chat history, unlike MIMs.

Fixes

  • List Attachments endpoint now correctly returns attachments sent from Blast Message API

  • Room owner promotion behavior for bots: When an owner leaves a room, and there is no owner remaining, the previous behavior was that the elder member of the room became the owner of the room (even if it was a service user). Now, the elder end user will be picked instead.

Other changes

Improved CSRF checks on backend APIs

Important: Starting with SBE 20.16, we are improving the Cross-Site Request Forgery (CSRF) security checks on our public backend APIs.

This change is transparent for chatbots and automations configured with service user accounts using RSA or certificate-based authentication. However, this can impact bots using end-user accounts (browser-based authentication with login/password).

Symphony does not support the use of end-user accounts for automations, and recommends using service users instead, with a RSA-based authentication.

If you have automations or chatbots that log in using an end-user account, please perform additional verifications as you validate the new SBE 20.16 in your UAT environment.

Integration Bridge

End-of-life update for the Integration Bridge as a Symphony-hosted service

As previously notified, as of April 2022 the Integration Bridge is no longer supported by Symphony.

Starting with SBE 20.16, the Integration Bridge will also no longer be available as a Symphony-hosted component.

Effectively, this means that legacy integrations that rely on this component (Universal Webhook, Jira, Zapier, GitHub, Salesforce, Trello) will no longer work.

Symphony proposes replacement solutions for Jira, Salesforce & Universal Webhook. Please reach out to your Symphony representative for more information.

Customers who have installed the Integration Bridge on their premises are not impacted. However, as the Integration Bridge is no longer supported, we cannot recommend using it.

List User Streams (Admin)
Suppress Message