Create a poll
The polls feature allows group channel members and channel operators to create and send a poll attached to text messages. A poll usually consists of a question and at least one poll option that users can vote on. The functionality provides an easier way to gather feedback from groups of all sizes, collect data from customers, and drive user engagement. You can configure various settings for your poll, including when the poll will close and whether to allow users to add poll options or vote on multiple poll options.
Prerequisite
To use polls in your Sendbird application, you must activate the polls feature on Sendbird Dashboard. Go to Settings > Chat > Features and turn on Polls.
Limitations
Refer to the following limitations when using polls.
-
Polls can't be sent in the form of following message types: file messages, admin messages, and scheduled text messages.
-
Data on polls isn't included in the result when exporting message data.
-
The table below shows the types of channels that support polls. See the channel types section to learn about the differences among various channel types.
Open channel | Group channel | Supergroup channel | |
---|---|---|---|
Polls | Supported, except ephemeral channels | Supported, except ephemeral channels | Supported, except ephemeral channels |
Note: The maximum number of options that can be added to a poll differs depending on your Sendbird subscription plan. For further information, contact our sales team.
PollCreateParams
You can create a poll by creating and passing a PollCreateParams
object as an argument to the parameter in the create()
method.
List of parameters
Parameter name | Type | Description |
---|---|---|
title | String | Specifies the title of a poll. |
options | List | Specifies the texts of possible options for which a user can vote on. Note that this property is only valid when creating a poll, but is ignored when updating a poll. |
data | PollData | Specifies an additional data to accompany the poll. A use case might be to provide explanations for incorrect quiz answers. |
allowUserSuggestion | bool | Determines whether to allow users to make suggestions. (Default: |
allowMultipleVotes | bool | Determines whether to allow users to vote on more than one poll options. (Default: |
closeAt | int | Specifies the time when a poll has closed or will close in Unix seconds. If the value of this property is |