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. Currently, you can add up to 20 reaction keys per message. For further information, contact our sales team.
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 name | Type | Description |
---|---|---|
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 name | Type | Description |
---|---|---|
id | int | The unique ID of an emoji. |
key | string | The key of an emoji. The length is limited to 30 characters. |
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 such as
{user_id}
and{channel_url}
in API URLs be URL encoded.
List of actions
Action | HTTP request |
---|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|