Overview

Before starting to build your chat, it is important to understand that your Sendbird application has core functionalities to maintain a stable chat service and basic features for application management. This page presents how you can use a Sendbird application in your app to ensure optimal performance.

You can use one Sendbird application per app for your chat service, regardless of the platform. For example, your app released in both Android and iOS systems would require only one Sendbird application. Chat API allows you to manage multiple Sendbird applications as well as your apps.

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.
region	nested object	The region information of the application.
region.region_name	string	The name of the region where the application is running.
region.region_key	string	The unique key of the region where the application is running. Valid values are the following: - ap-1 is for Tokyo, Japan. - ap-2 is for Seoul, South Korea. - ap-5 is for Singapore. - eu-1 is for Frankfurt, Germany. - us-1 is for Northern Virginia, USA. - us-2 is for Oregon, USA.
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. (Default: 4380)
display_past_message	boolean	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 who newly joins 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 which a user is allowed to send to a channel during the time duration set by user_messages_per_channel_duration property. 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 duration of the time window in seconds which counts the number of a user's messages within a channel. For example, if the user_messages_per_channel property is 7 and the user_messages_per_channel_duration property is 3, the number of messages beyond 7 will be blocked for every 3 seconds. (Default: 1)

Actions

The following table shows a list of actions supported for your application. Pages linked to each action will explain further details.

API endpoints are relative to the base URL allocated to your Sendbird application.

Note: If you want to know the ID and base URL of your application, sign in to your Sendbird Dashboard, select the application, open the Overview, and then check the App credentials > App ID, API request URL.

List of actions for setting up an application

In the following table, the /applications/settings_global endpoint refers to https://api-{application_id}.sendbird.com/v3/applications/settings_global.

Action	HTTP request
View global application settings	`GET` /applications/settings_global Retrieves global application settings that are applied to channels within the application.
Update global application settings	`PUT` /applications/settings_global Updates the global application settings that are applied to all channels within the application.

List of actions that require only master API token authentication

In the following table, the /applications endpoint refers to https://api-{application_id}.sendbird.com/v3/applications.

Action	HTTP request
List secondary API tokens	`GET` /applications/api_tokens Retrieves a list of secondary API tokens. Only a request with the master API token can list up API tokens.
View a secondary API token	`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.
Generate a secondary API token	`POST` /applications/api_tokens Generates a secondary API token. Only a request with the master API token can generate a new secondary API token.
Revoke a secondary API token	`DELETE` /applications/api_tokens/{api_token} Revokes a secondary API token.

List of actions that require API token authentication

In the following table, the /applications endpoint refers to https://api-{application_id}.sendbird.com/v3/applications.

Action	HTTP request
Retrieve an IP whitelist	`GET` /application/settings/ip_whitelist Retrieves a list of all the allowed IP ranges and addresses.
Add an IP to a whitelist	`PUT` /application/settings/ip_whitelist Adds allowed IP ranges and addresses to the application’s settings.
Delete IPs from a whitelist	`DELETE` /application/settings/ip_whitelist Deletes all allowed IP ranges and addresses.
Check push notifications	`GET` /applications/push/settings Shows whether the push notifications feature is turned on for an application.
Turn on push notifications	`PUT` /applications/push/settings Determines whether to turn on the push notifications feature for an application.
List push configurations	`GET` /applications/push/{push_type} Retrieves a list of push configurations of an application.
View a push configuration	`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`.
Remove a push configuration	`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`.
Add an FCM push configuration	`POST` /applications/push/fcm Registers a FCM push configuration. To send push notifications to Android devices, you should first register the FCM push configuration.
Update an FCM push configuration	`PUT` /applications/push/fcm/{provider_id} Updates a specific FCM push configuration.
Add an HMS 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.
Update an HMS push configuration	`PUT` /applications/push/hms/{provider_id} Updates a specific HMS push configuration.
Add an APNs 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.
Update an APNs push configuration	`PUT` /applications/push/apns/{provider_id} Updates a specific APNs push configuration.
Delete an APNs certificate	`DELETE` /applications/push/apns/cert/{provider_id} Deletes the APNs certificate.
List push notification content templates	`GET` /applications/push/message_templates Retrieves a list of push notification content templates of an application.
View a push notification content template	`GET` /applications/push/message_templates/{template_name} Retrieves information on the specified push notification content template of an application.
Update a push notification content template	`PUT` /applications/push/message_templates/{template_name} Updates information on the specified push notification content template of an application.
List auto event messages	`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.
Configure auto event message settings	`PUT` /applications/settings/auto_event_message Determines whether to automatically send event messages to group channels when events take place in an application.