Overview
AI-powered chatbots have greatly impacted the way businesses engage with their customers. They enable seamless and efficient communication by automating responses and providing personalized, and human-like interactions. Sendbird empowers businesses to incorporate AI chatbots into their apps, enhancing user experiences and streamlining customer support. On Sendbird Dashboard, you can easily create and manage your AI chatbot. See the list of available engines here.
Note: To ensure compliance with legal requirements and protect user privacy, review our terms and privacy notice.
Managing AI chatbots
With Sendbird Chat API and Sendbird Dashboard, you can easily integrate AI chatbots into your application.
Chat Platform API
Using Sendbird's existing bot API you can do the following:
- Create and update an AI chatbot.
- Retrieve a list of AI chatbots.
- Retrieve information on an AI chatbot.
- Delete an AI chatbot.
Sendbird Dashboard
To do the following, go to Chat > AI chatbots on your dashboard.
- Create and edit an AI chatbot.
- View a list of AI chatbot.
- View information on an AI chatbot.
- Manage file or URL sources that AI chatbots can refer to when generating answers.
Note: Managing file or URL sources can only be done on Sendbird Dashboard.
Resource representation
The following table shows the list of properties in a bot resource.
Property name | Type | Description |
---|---|---|
bot | nested object | The information on the bot. |
bot.bot_userid | string | The unique ID of the bot. |
bot.bot_nickname | string | The bot's nickname. |
bot.bot_profile_url | string | The URL of the bot's profile image. |
bot.bot_type | string | The bot's type that indicates its category. |
bot.bot_token | string | An opaque string that identifies the bot. This token should be added to all requests sent to |
bot.bot_metadata | object | One or more key-value pair items which store additional bot information like a user metadata. For more information, see user metadata and channel metadata. |
bot_callback_url | string | The server URL where the bot is located to receive all events, requests, and data forwarded from an application. |
is_privacy_mode | boolean | Indicates whether to only forward messages that meet specific conditions or forward all messages to the bot. If set to |
enable_mark_as_read | boolean | Indicates whether to mark the bot's message as read upon sending it. |
show_member | boolean | Indicates whether to include information about the members of each channel in a callback response. |
channel_invitation_preference | int | Indicates whether the bot automatically joins the channel when invited or joins the channel after manually accepting an invitation using the API. The value of |
created_at | timestamp | The timestamp at which the bot was created in Unix seconds format. |
ai | nested object | Indicates whether the bot is an AI bot, and holds information of an AI bot. This object only appears if the bot is an AI bot which can generate responses automatically and independently of your server-side operations. |
ai.backend | string | Indicates the system that powers the AI bot. Currently, only ChatGPT-powered bots are supported. |
ai.system_message | array of strings | Indicates a message used to help set the behavior of a ChatGPT bot. (Default: |
ai.temperature | number | The temperature of a ChatGPT bot which controls the randomness or creativity in the generated responses. A higher temperature value will result in more diverse and unpredictable responses, while a lower temperature value will produce more conservative and predictable responses. Valid values range from |
ai.max_tokens | integer | The maximum number of tokens to generate in the response by ChatGPT bots. One token generates roughly four characters for normal English text. Valid values range from |
ai.top_p | number | A value that determines the diversity of response generated by ChatGPT bots via nucleus sampling. Higher values can lead to a variety of responses, but less reliable answers.(Default: |
ai.presence_penalty | number | A value between |
ai.frequency_penalty | number | A value between |
Bot callback URL requirements
The following are the requirements for your bot callback URL:
- Your URL is required to handle
POST
requests withapplication/json; charset=utf8
type. - Your URL is required to return a
200 OK
HTTP code if you successfully receive a callback. Otherwise, Sendbird server calls your URL several times until it gets a200 OK
. - For security reasons, we recommend that you use an SSL server.
Note: If the
ai
property is specified, thebot_callback_url
property is no longer required but can be optionally specified.
Bot callback JSON body
Property name | Type | Description |
---|---|---|
category | string | The type of the bot notification. The only valid value is |
app_id | string | The unique App ID of the application where the message was sent. |
ts | long | The time that the message was sent in Unix milliseconds format. You can use this property to sort messages sent to the bot. |
sender | nested object | The user who sent the message. |
bot | nested object | The bot that received the message. |
members[] | array of objects | An array of users who are members of the channel. |
mentioned[] | array of strings | An array of unique IDs of the users mentioned in the message. |
message | nested object | The sent message that triggered the callback. |
channel | nested object | The group channel where the event occurred. |
Actions
The following table shows a list of actions supported for AI chatbots. Sendbird AI chatbots are based on API endpoints are relative to the base URL allocated to your Sendbird application. In this page, the /bots
endpoint refers to https://api-{application_id}.sendbird.com/v3/bots
.
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 in API URLs be urlencoded, such as
{botuser_id}
and{channel_url}
.
Action | HTTP request |
---|---|
| |
| |
| |
| |
|