Skip to main content

Chat / Platform API

Current version: v3

Overview
Prepare to use API
- User
- Overview
- - Listing users
  - List users
  - View 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
- - Retrieving group channel count
  - View number of channels by join status
- - Marking messages as read
  - Mark all of a user's messages as read
- - Managing metadata
  - View metadata
  - Create metadata
  - Update metadata
  - Delete metadata
- Channel
- Overview
- - Listing channels in an application
  - List open channels
  - View an open channel
  - List group channels
  - View 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
  - View metacounter
  - Create metacounter
  - Update metacounter
  - Delete metacounter
- - Managing metadata
  - View metadata
  - Create metadata
  - Update metadata
  - Delete metadata
- Message
- Overview
- - Message threading
  - Overview
  - List threaded replies of a parent message
  - View a reply
  - View 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
  - View number of unread messages per member
  - Mark all messages as read
- - Translations
  - Overview
  - Translate a message into other languages
  - Translation engine
- Application
- Overview
- - Setting up an application
  - View global application settings
  - Update global application settings
- - Managing API tokens
  - List secondary API tokens
  - View a secondary API token
  - Generate a secondary API token
  - Revoke a secondary API token
- - Managing IP whitelist
  - Retrieve 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
  - View an application
  - Create an application
  - Delete an application
  - Copy application settings
- - Managing features
  - List features
  - Update a feature
- - Managing members
  - List members
  - View a member
  - Update a member
  - Deactivate a member
- - Managing roles
  - List predefined roles
  - List custom roles
- Statistics
- Overview
- - Advanced analytics
  - Retrieve advanced analytics metrics
- - Concurrent connections
  - View number of concurrent connections
- - DAUs & MAUs
  - View number of daily active users
  - View number of monthly active users
- - Peak connections
  - View number of peak connections
- Data export
- Overview
- - Listing data exports
  - List data exports by message, channel, or user
  - View a data export
- - Scheduling data exports
  - Register and schedule a data export
- Bot
- Overview
- - Listing bots
  - List bots
  - View 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
  - Retrieve a list of subscribed events
  - Choose events to subscribe
- Privacy
- Overview
- - Listing GDPR requests
  - List GDPR requests
  - View 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

List bots

Retrieves a list of all bots within an application.

HTTP request

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

Parameters

The following table lists the parameters that this action supports.

Optional

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

Response

If successful, this action returns a list of bot resources in the response body.

Status: 200 OK

{
    "bots": [
        {
            "bot": {
                "bot_userid": "lunch_helper_bot",
                "bot_nickname": "Lunch helper",
                "bot_type": "marketer",
                "bot_profile_url": "https://mealadvisor.com/bots/img/sendbird_01_512px.png",
                "bot_token": "753afa86d980feea00657f040535fe4f73755e05",
                "bot_metadata": {}
            },
            "bot_callback_url": "https://mealadvisor.com/bots/sendbird/lunch/",
            "enable_mark_as_read": true,
            "is_privacy_mode": false,
            "show_member": false,
            "channel_invitation_preference": 0
        },
        ... # More bots
    ],
    "next": "FdW6RsFRQ1ArRafXA1RcE2d0FUZSUlkJFdeRHB863DAgNn8eDRS3dBNFX11fUlsDRs3E"
}

List of response properties

Property name	Type	Description
bots[]	array of objects	An array of bots.
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.