WebSocketConnectionObject

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/WebSocketConnectionObject",
  "title": "WebSocketConnectionObject",
  "type": "object",
  "properties": {
    "endpoint": {
      "type": "string",
      "description": "WebSocket endpoint URL, from the 'url' field in the API response.",
      "example": "wss://site4-example.webex.com/wbxrestfulapi/websocket"
    },
    "headers": {
      "type": "object",
      "properties": {
        "channelName": {
          "type": "string",
          "description": "WebSocket header 'channelName', from the 'channelName' field in the API response.",
          "example": "089b137c3cf34b578896941e2d49dfe8.ba78e451-ba27-4bac-b099-5e4680bb30fb"
        },
        "Authorization": {
          "type": "string",
          "description": "WebSocket header 'Authorization', use your service app token."
        },
        "token": {
          "type": "string",
          "description": "WebSocket header 'token', from the 'token' field in the API response."
        }
      },
      "required": [
        "channelName",
        "Authorization",
        "token"
      ]
    },
    "closedCaptionResponse": {
      "type": "object",
      "description": "Closed caption message received from the WebSocket.",
      "example": {
        "userName": "john.andersen@example.com",
        "content": "Can you hear me?",
        "sequenceNumber": 19,
        "timestamp": 1772603822410,
        "id": "954b53be-4ae9-43c8-4a28-20e349ae5235"
      }
    },
    "pingResponse": {
      "type": "object",
      "description": "Ping message received from the WebSocket.",
      "example": {
        "type": "ping"
      }
    }
  },
  "required": [
    "endpoint",
    "headers"
  ]
}