Webex · Schema

ControlsResponseObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
url string WebSocket endpoint URL.
channelName string Channel name for the WebSocket connection.
expiresInSeconds integer Seconds until the channel expires.
streamOut boolean Whether stream out is enabled.
View JSON Schema on GitHub

JSON Schema

webex-controlsresponseobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ControlsResponseObject",
  "title": "ControlsResponseObject",
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "WebSocket endpoint URL.",
      "example": "wss://site4-example.webex.com/wbxrestfulapi/websocket"
    },
    "channelName": {
      "type": "string",
      "description": "Channel name for the WebSocket connection.",
      "example": "089b137c3cf34b578896941e2d49dfe8.ba78e451-ba27-4bac-b099-5e4680bb30fb"
    },
    "expiresInSeconds": {
      "type": "integer",
      "description": "Seconds until the channel expires.",
      "default": 300,
      "example": 300
    },
    "streamOut": {
      "type": "boolean",
      "description": "Whether stream out is enabled.",
      "example": true
    }
  },
  "required": [
    "url",
    "channelName",
    "expiresInSeconds",
    "streamOut"
  ]
}