Webex · Schema

ControlsRequestObject

One of `meetingId`, `meetingNumber`, or `webLink` must be specified.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
meetingId	string	Unique identifier for the meeting. Required if meetingNumber and webLink are not provided.
meetingNumber	string	Meeting number. Required if meetingId and webLink are not provided.
webLink	string	Link to a meeting information page where the meeting client is launched if the meeting is ready to start or join. Required if meetingId and meetingNumber are not provided.
streamOut	boolean	Whether to enable stream out. It is an optional field and default value is true.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ControlsRequestObject",
  "title": "ControlsRequestObject",
  "type": "object",
  "description": "One of `meetingId`, `meetingNumber`, or `webLink` must be specified.",
  "properties": {
    "meetingId": {
      "type": "string",
      "description": "Unique identifier for the meeting. Required if meetingNumber and webLink are not provided.",
      "example": "089b137c3cf34b578896941e2d49dfe8"
    },
    "meetingNumber": {
      "type": "string",
      "description": "Meeting number. Required if meetingId and webLink are not provided.",
      "example": "123456789"
    },
    "webLink": {
      "type": "string",
      "example": "https://site4-example.webex.com/site4/j.php?MTID=md41817da6a55b0925530cb88b3577b1",
      "description": "Link to a meeting information page where the meeting client is launched if the meeting is ready to start or join. Required if meetingId and meetingNumber are not provided."
    },
    "streamOut": {
      "type": "boolean",
      "description": "Whether to enable stream out. It is an optional field and default value is true.",
      "example": true
    }
  }
}