Create a poll

realtime_kit.active_session.create_poll(, ) -> ActiveSessionCreatePollResponse

POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/poll

Creates a new poll in an active session for the given meeting ID.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Realtime AdminRealtime

ParametersExpand Collapse

account_id: str

The account identifier tag.

maxLength32

app_id: str

The app identifier tag.

maxLength32

meeting_id: str

options: SequenceNotStr[str]

Different options for the question

question: str

Question of the poll

anonymous: Optional[bool]

if voters on a poll are anonymous

hide_votes: Optional[bool]

if votes on an option are visible before a person votes

ReturnsExpand Collapse

class ActiveSessionCreatePollResponse: …

data: Optional[Data]

action: Optional[str]

poll: Optional[DataPoll]

id: str

ID of the poll

options: List[DataPollOption]

Answer options

count: float

text: str

Text of the answer option

votes: List[DataPollOptionVote]

id: str

name: str

question: str

Question asked by the poll

anonymous: Optional[bool]

created_by: Optional[str]

hide_votes: Optional[bool]

voted: Optional[List[str]]

success: Optional[bool]

Create a poll

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
response = client.realtime_kit.active_session.create_poll(
    meeting_id="meeting_id",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    app_id="app_id",
    options=["string"],
    question="question",
)
print(response.data)

{
  "data": {
    "action": "action",
    "poll": {
      "id": "id",
      "options": [
        {
          "count": 0,
          "text": "text",
          "votes": [
            {
              "id": "id",
              "name": "name"
            }
          ]
        }
      ],
      "question": "question",
      "anonymous": true,
      "created_by": "created_by",
      "hide_votes": true,
      "voted": [
        "string"
      ]
    }
  },
  "success": true
}

Returns Examples

{
  "data": {
    "action": "action",
    "poll": {
      "id": "id",
      "options": [
        {
          "count": 0,
          "text": "text",
          "votes": [
            {
              "id": "id",
              "name": "name"
            }
          ]
        }
      ],
      "question": "question",
      "anonymous": true,
      "created_by": "created_by",
      "hide_votes": true,
      "voted": [
        "string"
      ]
    }
  },
  "success": true
}