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

    Overview

    Reacting to a message using emojis provides users with a more engaging chat experience. You can use the emojis provided by default or add and manage emojis by category.

    Note: The APIs for emojis are only used for reactions. Therefore, enable reactions first before using emojis as reactions.


    Resource representation

    The following tables show the list of properties in an emoji category resource and emoji resource.

    Emoji category
    Property nameTypeDescription

    id

    int

    The unique ID of an emoji category.

    name

    string

    The name of an emoji category.

    url

    string

    The URL of an emoji category.

    application_id

    int

    The unique ID of the application that an emoji category belongs to.

    Emoji
    Property nameTypeDescription

    id

    int

    The unique ID of an emoji.

    key

    string

    The key of an emoji.

    url

    string

    The image URL of an emoji.

    application_id

    int

    The unique ID of the application that an emoji belongs to.

    emoji_category_id

    int

    The unique ID of the emoji category that an emoji belongs to.


    Actions

    The following table shows a list of actions supported for reactions and emojis. API endpoints are relative to the base URL allocated to your Sendbird application. The base URL for the following endpoints are https://api-{application_id}.sendbird.com/v3.

    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

    Enable reactions

    PUT /applications/settings/reactions
    Turns on and off message reactions in a Sendbird application.

    List reactions

    GET /{channel_type}/{channel_url}/messages/{message_id}/reactions
    Retrieves a list of reactions made to a specific message.

    Add a reaction

    POST /{channel_type}/{channel_url}/messages/{message_id}/reactions
    Adds a specific reaction to a message.

    Remove a reaction

    DELETE /{channel_type}/{channel_url}/messages/{message_id}/reactions
    Removes a specific reaction from a message.

    Use default emojis

    PUT /applications/settings/use_default_emoji
    Determines whether to use the seven default emojis initially provided by Sendbird.

    List all emojis

    GET /emojis
    Retrieves an array of all emojis registered to the application.

    View an emoji

    GET /emojis/{emoji_key}
    Retrieves a specific emoji.

    Add emojis

    POST /emojis
    Adds an array of new emojis to the application.

    Update an emoji URL

    PUT /emojis/{emoji_key}
    Updates the image URL of a specific emoji.

    Delete an emoji

    DELETE /emojis/{emoji_key}
    Deletes a specific emoji from the application.

    List all emoji categories

    GET /emoji_categories
    Retrieves an array of all emoji categories with their emojis.

    View an emoji category

    GET /emoji_categories/{emoji_category_id}
    Retrieves a specific emoji category with its emojis.

    Add emoji categories

    POST /emoji_categories
    Adds an array of new emoji categories to the application.

    Update an emoji category URL

    PUT /emoji_categories/{emoji_category_id}
    Updates the URL of a specific emoji category.

    Delete an emoji category

    DELETE /emoji_categories/{emoji_category_id}
    Deletes a specific emoji category from the application.