Your Sendbird application provides core functionalities that ensure optimal performance of your chat service. The Chat API allows you to manage multiple Sendbird applications as well as your apps.
You can use one Sendbird application per app regardless of the platform. For example, your app released in both Android and iOS systems would require only one Sendbird application. If multiple apps share a single user base, we recommend using one Sendbird application.
Resource representation
The following table shows the list of properties in an application resource.
Property name
Type
Description
app_id
string
The unique ID of the application.
app_name
string
The name of the application.
api_token
string
The credential of the application for accessing the Chat API. It is an opaque string which should be submitted to Sendbird server for application identification when requesting.
created_at
long
The time when the credentials were registered to Sendbird server.
plan
string
The subscription plan of the application. Valid values are free and enterprise.
message_retention_hours
int
The length of time in hours that the messages are retained for. The maximum message retention period is six months, or 4,380 hours. (Default: 4380)
Indicates whether to display past messages to new members of a group channel. If true, the entire message history of the channel is shown to those newly joining the channel. (Default: false)
allow_links
boolean
Indicates whether to allow clickable links in a message within the application. (Default: true)
max_message_length
int
The maximum length of a message allowed to be sent within the application. Valid values are 50, 100, 200, 500, 1,000, 5,000, 10,000, and 20,000. (Default: 5,000)
user_messages_per_channel
int
The maximum number of messages that a user is allowed to send to a channel during the time set by user_messages_per_channel_duration. The value of -1 indicates that the system limit is imposed. The system allows a user to send up to 5 messages per second. (Default: -1)
user_messages_per_channel_duration
int
The time period in seconds during which user_messages_per_channel is applied. For example, if user_messages_per_channel is set to 7 and user_messages_per_channel_duration is set to 3, users can send up to seven messages for every three seconds. (Default: 1)
Actions
The following table shows a list of actions supported for your application. The 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: To find the application ID and base URL of your application, sign in to Sendbird Dashboard, go to Settings > Application > General, and then check Application ID and API request URL.
GET/applications/api_tokens/{api_token} Retrieves information of the secondary API token. Only a request with the master API token can view information on any of the secondary API tokens.
GET/applications/push/{push_type}/{provider_id} Retrieves a specific push configuration of an application. The type of a push configuration is one of fcm, huawei, or apns.
DELETE/applications/push/{push_type}/{provider_id} Cancels the registration of the push configuration of an application. The type of a push configuration is one of fcm, huawei, or apns.
POST/applications/push/fcm Registers a FCM push configuration. To send push notifications to Android devices, you should first register the FCM push configuration.
POST/applications/push/hms Registers an HMS push configuration. To send push notifications to Android devices for HMS, you should first register the HMS push configuration.
POST/applications/push/apns Registers an APNs push configuration. To send push notifications to iOS devices, you should first register the APNs push configuration.
GET/applications/settings/auto_event_message Retrieves a list of auto event messages that are sent in a specified application and indicates which ones are in use.
PUT/applications/settings/auto_event_message Determines whether to automatically send event messages to group channels when events take place in an application.
