Webex · Schema

QAObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string A unique identifier for the question.
meetingId string A unique identifier for the [meeting instance](/docs/meetings#meeting-series-scheduled-meetings-and-meeting-instances) to which the Q&A belongs.
totalAttendees number The total number of attendees in the meeting.
totalRespondents number The total number of respondents in the meeting.
displayName string The name of the user who asked the question.
email string The email of the user who asked the question.
question string The question that was asked.
answers object Question's answers.
View JSON Schema on GitHub

JSON Schema

webex-qaobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/QAObject",
  "title": "QAObject",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "1aea8390-e375-4547-b7ff-58ecd9e0b03d",
      "description": "A unique identifier for the question."
    },
    "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 Q&A belongs."
    },
    "totalAttendees": {
      "type": "number",
      "example": 10,
      "description": "The total number of attendees in the meeting."
    },
    "totalRespondents": {
      "type": "number",
      "example": 10,
      "description": "The total number of respondents in the meeting."
    },
    "displayName": {
      "type": "string",
      "example": "John Andersen",
      "description": "The name of the user who asked the question."
    },
    "email": {
      "type": "string",
      "example": "[email protected]",
      "description": "The email of the user who asked the question."
    },
    "question": {
      "type": "string",
      "example": "Are you ok?",
      "description": "The question that was asked."
    },
    "answers": {
      "type": "object",
      "properties": {
        "links": {
          "type": "object",
          "properties": {
            "prev": {
              "type": "string",
              "example": "https://webexapis.com/v1/meetings/q_and_a/d513da2b-547b-4c69-b717-d83c6b02b657_M_7b789da198e531ce0c4d84243abd9fee_I_231245894851233679/answers?meetingId=7b789da198e531ce0c4d84243abd9fee_I_231245894851233679&offset=0&max=10",
              "description": "Link to the previous page of answers to this question."
            },
            "self": {
              "type": "string",
              "example": "https://webexapis.com/v1/meetings/q_and_a/d513da2b-547b-4c69-b717-d83c6b02b657_M_7b789da198e531ce0c4d84243abd9fee_I_231245894851233679/answers?meetingId=7b789da198e531ce0c4d84243abd9fee_I_231245894851233679&offset=10&max=10",
              "description": "Link to the current page of this answers to this question."
            },
            "next": {
              "type": "string",
              "example": "https://webexapis.com/v1/meetings/q_and_a/d513da2b-547b-4c69-b717-d83c6b02b657_M_7b789da198e531ce0c4d84243abd9fee_I_231245894851233679/answers?meetingId=7b789da198e531ce0c4d84243abd9fee_I_231245894851233679&offset=20&max=10",
              "description": "Link to the next page of answers to this question."
            }
          },
          "description": "The pagination links of the question's answers."
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/AnswerObject"
          },
          "description": "An array of answer objects for this question."
        }
      },
      "description": "Question's answers."
    }
  }
}