Chat / Platform API
Current version: v3
    Chat Platform API v3
    Chat Platform API
    Chat
    Platform API
    Home
    /
    Chat
    /
    Platform API
    /
    Message

    Overview

    Message threading is a feature that allows users to ask questions, give feedback, or add context to a specific message without disrupting the conversation flow. This feature has the following elements:

    • A message can have a thread of replies.
    • A message that has a thread of replies is a parent message.
    • A parent message and its threaded replies are collectively called a message thread.
    • Every message within a thread, whether it's parent or reply, is a threaded message.
    • A message that doesn't have any replies is an unthreaded message.


    Benefits

    Message threading can be widely used to help conversations flow smoothly while keeping users engaged. Message replies in a thread are common among popular messaging platforms, such as Slack and iMessage.

    • Conversation flow: Without message threading, it's hard to specify which message a channel member is responding to. Users would have to explain the context of their response, potentially confusing other channel members and distracting them from reading new messages. Message threads can help everyone stay engaged and carry on their conversation without any interference.

    • In-depth discussions: By allowing users to reply to each other's messages in a thread, they can have more in-depth conversations on one topic. They're able to ask follow-up questions or provide more detailed explanations to a specific message without interrupting others in the channel. Message threads can encourage users to start topic-specific discussions separate from the main channel conversation.


    Limitations

    Refer to the following limitations before using the message threading feature:

    • Message threading doesn't integrate with SyncManager.
    • SDK only supports 1-depth threads, meaning you can only add reply messages to non-reply messages. You can't add a reply to a reply message.
    • Message threading is limited to text and file messages. You can't send admin messages as replies or send replies to admin messages.

    Actions

    The following table shows a list of actions supported for message threading. API endpoints are relative to the base URL allocated to your Sendbird application. In this page, the /{channel_type}/{channel_url}/messages endpoint refers to https://api-{application_id}.sendbird.com/v3/{channel_type}/{channel_url}/messages.

    Note: If you want to know the ID and base URL of your application, sign in to the Sendbird Dashboard, go to the Settings > Application > General, and then check the Application ID and API request URL.

    • It's recommended that the parameter values in API URLs be urlencoded, such as {user_id} and {channel_url}.

    List of actions

    ActionHTTP request

    List threaded replies of a parent message

    GET /{channel_type}/{channel_url}/messages
    Retrieves replies of a specific parent message.

    Get a reply

    GET /{channel_type}/{channel_url}/messages/{message_id}
    Retrieves a specific reply in a thread.

    Get thread information

    GET /{channel_type}/{channel_url}/messages/thread_info
    Retrieves thread information on a specific message.

    Reply to a message

    POST /{channel_type}/{channel_url}/messages
    Replies to a specific message in a channel.

    Delete a reply

    DELETE /{channel_type}/{channel_url}/messages/{message_id}
    Deletes a specific reply from a channel.