Chat / JavaScript
Chat JavaScript v4
Chat JavaScript
Chat
JavaScript
Version 4
Home
/
Chat
/
JavaScript
/
Message

Create a poll

Copy link

The polls feature allows group channel members and 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

Copy link

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

Copy link

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 channelGroup channelSupergroup channel

Polls

Not supported

Supported, except ephemeral channels

Not supported

Note: The maximum number of options that can be added to a poll differs depending on your Sendbird plan. For further information, contact our sales team.


PollCreateParams

Copy link

You can create a poll by creating and passing a PollCreateParams object as an argument to the parameter in the sb.poll.create() method.

const params: PollCreateParams = {
  title: 'My poll',
  optionTexts: [
    'First option',
    'Second option',
  ],
  data: { text: 'My poll data' },
  isAnonymous: true,
  allowUserSuggestion: true,
  allowMultipleVotes: true,
  closeAt: Math.floor(Date.now() / 1000 + oneDayInSeconds),
};
const poll: Poll = await sb.poll.create(params);

PollCreateParams

Copy link
Parameter nameTypeDescription

title

string

Specifies the title of a poll.

optionTexts

string[]

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.

isAnonymous?

boolean

Determines whether to make votes anonymous. (Default: false)

allowUserSuggestion?

boolean

Determines whether to allow users to make suggestions. (Default: false)

allowMultipleVotes?

boolean

Determines whether to allow users to vote on more than one poll options. (Default: false)

closeAt?

number

Specifies the time when a poll has closed or will close in Unix seconds.