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

    Overview

    Message essentials contain basic message functionalities, such as sending or viewing a message, and forms the operational basis for advanced message features and other functionalities in the Chat API.


    Actions

    The following table shows a list of actions supported for message essentials. 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 messages

    GET /{channel_type}/{channel_url}/messages
    Retrieves a list of past messages of a specific channel.

    Get a message

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

    Send a message

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

    Update a message

    PUT /{channel_type}/{channel_url}/messages/{message_id}
    Updates specific information on a message.

    Delete a message

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

    Add metadata

    POST /{channel_type}/{channel_url}/messages/{message_id}/sorted_metaarray
    Adds key-values items to store additional information for a message.

    Update metadata

    PUT /{channel_type}/{channel_url}/messages/{message_id}/sorted_metaarray
    Updates values of specific items by their keys.

    Remove metadata

    DELETE /{channel_type}/{channel_url}/messages/{message_id}/sorted_metaarray
    Removes specific items from a message by their keys.

    Get total number of messages in a channel

    GET /{channel_type}/{channel_url}/messages/total_count
    Retrieves the total number of messages in a specific channel.

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