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

    View a reply

    Retrieves a specific reply in a thread.


    HTTP request

    GET https://api-{application_id}.sendbird.com/v3/{channel_type}/{channel_url}/messages/{message_id}
    

    Parameters

    The following table lists the parameters that this action supports.

    Parameters
    RequiredTypeDescription

    message_id

    long

    Specifies the unique ID of a reply to retrieve.

    channel_url

    string

    Specifies the URL of the channel where the target reply was made.

    channel_type

    string

    Specifies the type of the channel where the target reply belongs. Acceptable values are open_channels and group_channels.

    OptionalTypeDescription

    include_reply_type

    string

    Specifies the type of message to include in the results.
    - NONE (default): All messages that are not replies. These messages may or may not have replies in its thread.
    - ALL: All messages including threaded and non-threaded parent messages as well as its replies.
    - ONLY_REPLY_TO_CHANNEL: Messages that are not threaded. Only the parent messages and replies that were sent to the channel are included.

    include_parent_message_info

    boolean

    Determines whether to include the information of the parent messages in the results. (Default:false)

    include_thread_info

    boolean

    Determines whether to include thread-related information in the response. (Default: false)

    include_parent_message_text

    boolean

    (Deprecated) Determines whether to include the text of parent messages as the parent_message_text property in the results. This property can be used to simultaneously display the content of parent messages and their thread of replies. (Default: false)


    Response

    If successful, this action returns a reply message resource in the response body.

    In the case of an error, an error object is returned. A detailed list of error codes is available here.