Webex · Schema

Poll

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string A unique identifier for the poll.
meetingId string A unique identifier for the [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) to which the poll belongs.
startTime string The date and time the poll started in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.
endTime string The date and time the poll ended in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format.
timerDuration number The length of time in the alarm box, in seconds.
displayName string The name of the poll coordinator.
email string The email of the poll coordinator.
personId string The ID of the polling coordinator.
questions array Poll's questions.
View JSON Schema on GitHub

JSON Schema

webex-poll-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Poll",
  "title": "Poll",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "1aea8390-e375-4547-b7ff-58ecd9e0b03d",
      "description": "A unique identifier for the poll."
    },
    "meetingId": {
      "type": "string",
      "example": "a2f95f5073e347489f7611492dbd6ad5_I_199075330905867928",
      "description": "A unique identifier for the [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) to which the poll belongs."
    },
    "startTime": {
      "type": "string",
      "example": "2021-07-06T09:22:34Z",
      "description": "The date and time the poll started in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
    },
    "endTime": {
      "type": "string",
      "example": "2021-07-06T09:25:51Z",
      "description": "The date and time the poll ended in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
    },
    "timerDuration": {
      "type": "number",
      "example": 300,
      "description": "The length of time in the alarm box, in seconds."
    },
    "displayName": {
      "type": "string",
      "example": "John Andersen",
      "description": "The name of the poll coordinator."
    },
    "email": {
      "type": "string",
      "example": "[email protected]",
      "description": "The email of the poll coordinator."
    },
    "personId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xYTY5MmE2Mi00MTNmLTRjYWEtYjdkOS0wYzg0ZDZmMDdlNzY",
      "description": "The ID of the polling coordinator."
    },
    "questions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Question"
      },
      "description": "Poll's questions."
    }
  }
}