Chat / Platform API
    Chat Platform API v3
    Chat Platform API
    Chat
    Platform API
    Version 3
    Home
    /
    Chat
    /
    Platform API
    /
    Message

    Get a message

    Copy link

    Retrieves information on a specific message.

    HTTP request

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

    Parameters

    Copy link

    The following table lists the parameters that this action supports.

    Note: The include_parent_message_info and include_thread_info parameters are related to Sendbird's message threading feature. To learn more, see the message threading page.

    Parameters
    RequiredTypeDescription

    channel_type

    string

    Specifies the type of the channel. Acceptable values are open_channels and group_channels.

    channel_url

    string

    Specifies the URL of the target channel.

    message_id

    long

    Specifies the unique ID of the message to retrieve.

    OptionalTypeDescription

    include_parent_message_info

    boolean

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

    include_thread_info

    boolean

    Determines whether to include thread information in the results. (Default: false)

    include_reactions

    boolean

    Determines whether to include reactions added to messages in a channel in the results. (Default: false)

    include_poll_details

    boolean

    Determines whether to include all properties of a poll resource with a full list of options in the results. If set to false, a selection of poll resource properties consisting of id, title, close_at, created_at, updated_at, status, and message_id are returned. (Default: false)

    * To use this property, the polls feature should be turned on in Settings > Chat > Features on Sendbird Dashboard.

    with_sorted_meta_array

    boolean

    Determines whether to include the sorted_metaarray property in the response. (Default: false)

    with_meta_array

    boolean

    (Deprecated) Determines whether to include the metaarray property in the response. (Default: false)

    ?with_sorted_meta_array=true

    Response

    Copy link

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

    Note: Sendbird Chat SDK supports the generation of a URL link preview within a message if the given URL has Open Graph (OG) tags, which are included as an og_tag property in your response as well. This feature is turned on by default for Sendbird applications. If this isn't available for your Sendbird application, contact our support team to enable the feature.

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