Skip to main content

Chat / Platform API

Current version: v3

Overview
Prepare to use API
- User
- Overview
- - Listing users
  - List users
  - Get a user
- - Creating users
  - Create a user
- - Managing users
  - Update a user
  - Delete a user
- - Managing session tokens
  - Issue a session token
  - Revoke all session tokens
- - Managing joined group channels
  - List group channels
  - Leave group channels
- - Getting group channel count
  - Get number of channels by join status
- - Marking messages as read
  - Mark all of a user's messages as read
- - Managing metadata
  - Get metadata
  - Create metadata
  - Update metadata
  - Delete metadata
- Channel
- Overview
- - Listing channels in an application
  - List open channels
  - Get an open channel
  - List group channels
  - Get a group channel
- - Creating a channel
  - Create an open channel
  - Create a group channel
- - Inviting a user
  - Invite as members
  - Accept an invitation
  - Decline an invitation
- - Managing metacounter
  - Get metacounter
  - Create metacounter
  - Update metacounter
  - Delete metacounter
- - Managing metadata
  - Get metadata
  - Create metadata
  - Update metadata
  - Delete metadata
- Message
- Overview
- - Message threading
  - Overview
  - List threaded replies of a parent message
  - Get a reply
  - Get thread information
  - Reply to a message
  - Delete a reply
- - Message search
  - Overview
  - Search a message
- - Migration
  - Overview
  - Migrate messages
- - Delivery receipts
  - Overview
  - Mark all messages as delivered
- - Read receipts
  - Overview
  - Get number of unread messages per member
  - Mark all messages as read
- - Translations
  - Overview
  - Translate a message into other languages
  - Translation engine
- - Typing indicators
  - Overview
  - Start typing indicators
  - Stop typing indicators
- Application
- Overview
- - Setting up an application
  - Get global application settings
  - Update global application settings
- - Managing API tokens
  - List secondary API tokens
  - Get a secondary API token
  - Generate a secondary API token
  - Revoke a secondary API token
- - Managing IP whitelist
  - Get an IP whitelist
  - Add an IP to a whitelist
  - Delete IPs from a whitelist
- - Managing auto event messages
  - List auto event messages
  - Configure auto event message settings
- - Understanding rate limits
  - Rate limits
- Organization
- Overview
- - Managing application
  - List applications
  - Get an application
  - Create an application
  - Delete an application
  - Copy application settings
- - Managing features
  - List features
  - Update a feature
- - Managing members
  - List members
  - Get a member
  - Update a member
  - Deactivate a member
- - Managing roles
  - List predefined roles
  - List custom roles
- Statistics
- Overview
- - Advanced analytics
  - Get advanced analytics metrics
- - Concurrent connections
  - Get number of concurrent connections
- - DAUs & MAUs
  - Get number of daily active users
  - Get number of monthly active users
- - Peak connections
  - Get number of peak connections
- Data export
- Overview
- - Listing data exports
  - List data exports by message, channel, or user
  - Get a data export
- - Scheduling data exports
  - Register and schedule a data export
- Bot
- Overview
- - Listing bots
  - List bots
  - Get a bot
- - Creating a bot
  - Create a bot
- - Sending a bot message
  - Send a bot message
- - Managing a bot
  - Update a bot
  - Join channels
  - Leave channels
  - Delete a bot
- Report
- Overview
- - Creating a report
  - Report a user
  - Report a channel
  - Report a message
- Webhook
- Overview
- - Managing subscribed events
  - Get a list of subscribed events
  - Choose events to subscribe
- Privacy
- Overview
- - Listing GDPR requests
  - List GDPR requests
  - Get a GDPR request
- - Creating a GDPR request
  - Register a GDPR request
- - Managing GDPR requests
  - Cancel the registration of a GDPR request
Deprecated
Error codes

Chat Platform API v3

Chat Platform API

Chat

Platform API

Home

/

Chat

/

Platform API

/

Message

List announcement groups

Retrieves a list of announcement groups.

HTTP request

GET https://api-{application_id}.sendbird.com/v3/announcement_group

Parameters

The following table lists the parameters that this action supports.

Optional

Parameter name	Type	Description
token	string	Specifies a token that indicates the starting index of results to retrieve. If not specified, the index is set as 0.
limit	int	Specifies the number of results to retrieve per page. Acceptable values range from 1 to 100, inclusive. (Default: 10)

Query string example

?limit=20&token=Z3UYLAYLAAoaTxgADAwNQD8~

Response

If successful, this action returns a list of announcement groups in the response body.

Status: 200 OK

{
    "announcement_group": ["insurance", "finance", ... ],
    "next": "Z3jk34n2uj=e23E2z"
}

List of response properties

Property name	Type	Description
next	string	The value that can be used in the `token` parameter to retrieve the next page in the result set.

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

Try API requests