Video Management

• OpenAPI Version: 3.1.0
• API Version: 1.0.0

Operations

POST video_management.video_quiz_completed

• Method: POST
• Path: video_management.video_quiz_completed
• Tags: video_management

Request Body

Content-Type: application/json

• event (required)

  string — The name of the event. video_management.video_quiz_completed.

• event_ts (required)

  integer, format: int64 — A timestamp when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the host who published the video channel.

  • object (required)

    object — The Zoom Event description.

    • channel_id (required)

      string — The ID of the channel.

    • completed_at (required)

      string, format: date-time — The the time the quiz was completed. yyyy-MM-ddTHH:mm:ssZ

    • quiz_id (required)

      string — The ID of the quiz.

    • video_id (required)

      string — The ID of the video.

    • quiz_name

      string — The name of the quiz.

    • user_id

      string — The ID of the user who completed the quiz.

    • video_name

      string — The name of the video.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "ACC9Dllddp39dagjLj9j",
    "object": {
      "channel_id": "iso9Dllddp39dagjLj9j",
      "video_id": "iso9Dllddp39dagjLj9j",
      "video_name": "Demo Video",
      "quiz_id": "csduzfv3JwTeyR5QpC3PXw52",
      "quiz_name": "Validation check",
      "user_id": "csduzfv3JwTeyR5QpC3P=",
      "completed_at": "2022-06-03T20:51:00Z"
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The name of the event. video_management.video_quiz_completed.

• event_ts (required)

  integer, format: int64 — A timestamp when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the host who published the video channel.

  • object (required)

    object — The Zoom Event description.

    • channel_id (required)

      string — The ID of the channel.

    • completed_at (required)

      string, format: date-time — The the time the quiz was completed. yyyy-MM-ddTHH:mm:ssZ

    • quiz_id (required)

      string — The ID of the quiz.

    • video_id (required)

      string — The ID of the video.

    • quiz_name

      string — The name of the quiz.

    • user_id

      string — The ID of the user who completed the quiz.

    • video_name

      string — The name of the video.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "ACC9Dllddp39dagjLj9j",
    "object": {
      "channel_id": "iso9Dllddp39dagjLj9j",
      "video_id": "iso9Dllddp39dagjLj9j",
      "video_name": "Demo Video",
      "quiz_id": "csduzfv3JwTeyR5QpC3PXw52",
      "quiz_name": "Validation check",
      "user_id": "csduzfv3JwTeyR5QpC3P=",
      "completed_at": "2022-06-03T20:51:00Z"
    }
  }
}

POST video_management.channel_video_added

• Method: POST
• Path: video_management.channel_video_added
• Tags: video_management

Request Body

Content-Type: application/json

• event (required)

  string — The name of the event. video_management.channel_video_added.

• event_ts (required)

  integer, format: int64 — A timestamp of when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the host who published the video channel.

  • object (required)

    object — The Zoom Event description.

    • channel_id (required)

      string — The channel ID.

    • video_id (required)

      string — The video ID.

    • meeting_id

      string — Zoom meeting ID or UUID. This is available only for recordings.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "channel_id": "iso9Dllddp39dagjLj9j",
      "video_id": "csduzfv3JwTeyR5QpC3PXw52",
      "meeting_id": "rec1zfv3JwTeyR5QpC3PXw52"
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The name of the event. video_management.channel_video_added.

• event_ts (required)

  integer, format: int64 — A timestamp of when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the host who published the video channel.

  • object (required)

    object — The Zoom Event description.

    • channel_id (required)

      string — The channel ID.

    • video_id (required)

      string — The video ID.

    • meeting_id

      string — Zoom meeting ID or UUID. This is available only for recordings.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "channel_id": "iso9Dllddp39dagjLj9j",
      "video_id": "csduzfv3JwTeyR5QpC3PXw52",
      "meeting_id": "rec1zfv3JwTeyR5QpC3PXw52"
    }
  }
}

POST video_management.channel_published

• Method: POST
• Path: video_management.channel_published
• Tags: video_management

Request Body

Content-Type: application/json

• event (required)

  string — The name of the event. video_management.channel_published.

• event_ts (required)

  integer, format: int64 — A timestamp when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the host who published the video channel.

  • object (required)

    object — The Zoom Event description.

    • channel_id (required)

      string — The channel ID.

    • name (required)

      string — The name of the channel.

    • owner_id (required)

      string — The ID of the channel owner.

    • description

      string — Channel description.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "channel_id": "iso9Dllddp39dagjLj9j",
      "name": "FoodieFlicks",
      "description": "A cinematic journey through the world of cuisine!.",
      "owner_id": "abc9Dllddp39dagjLj9j"
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The name of the event. video_management.channel_published.

• event_ts (required)

  integer, format: int64 — A timestamp when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the host who published the video channel.

  • object (required)

    object — The Zoom Event description.

    • channel_id (required)

      string — The channel ID.

    • name (required)

      string — The name of the channel.

    • owner_id (required)

      string — The ID of the channel owner.

    • description

      string — Channel description.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "channel_id": "iso9Dllddp39dagjLj9j",
      "name": "FoodieFlicks",
      "description": "A cinematic journey through the world of cuisine!.",
      "owner_id": "abc9Dllddp39dagjLj9j"
    }
  }
}

POST video_management.channel_unpublished

• Method: POST
• Path: video_management.channel_unpublished
• Tags: video_management

Request Body

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer, format: int64 — A timestamp of when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the host who published the video channel.

  • object (required)

    object — The Zoom Event description.

    • channel_id (required)

      string — The channel ID.

    • name (required)

      string — The name of the channel.

    • owner_id (required)

      string — The ID of the channel owner.

    • description

      string — The description of the channel.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "channel_id": "iso9Dllddp39dagjLj9j",
      "name": "FoodieFlicks",
      "description": "A cinematic journey through the world of cuisine!.",
      "owner_id": "abc9Dllddp39dagjLj9j"
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer, format: int64 — A timestamp of when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the host who published the video channel.

  • object (required)

    object — The Zoom Event description.

    • channel_id (required)

      string — The channel ID.

    • name (required)

      string — The name of the channel.

    • owner_id (required)

      string — The ID of the channel owner.

    • description

      string — The description of the channel.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "channel_id": "iso9Dllddp39dagjLj9j",
      "name": "FoodieFlicks",
      "description": "A cinematic journey through the world of cuisine!.",
      "owner_id": "abc9Dllddp39dagjLj9j"
    }
  }
}

POST video_management.channel_video_removed

• Method: POST
• Path: video_management.channel_video_removed
• Tags: video_management

Request Body

Content-Type: application/json

• event (required)

  string — The name of the event. video_management.channel_video_removed.

• event_ts (required)

  integer, format: int64 — The timestamp of when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the host who published the video channel.

  • object (required)

    object — The Zoom event description.

    • channel_id (required)

      string — The channel ID.

    • video_id (required)

      string — The video ID.

    • meeting_id

      string — Zoom meeting ID or UUID. This is available only for recordings.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "channel_id": "iso9Dllddp39dagjLj9j",
      "video_id": "csduzfv3JwTeyR5QpC3PXw52",
      "meeting_id": "rec1zfv3JwTeyR5QpC3PXw52"
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The name of the event. video_management.channel_video_removed.

• event_ts (required)

  integer, format: int64 — The timestamp of when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the host who published the video channel.

  • object (required)

    object — The Zoom event description.

    • channel_id (required)

      string — The channel ID.

    • video_id (required)

      string — The video ID.

    • meeting_id

      string — Zoom meeting ID or UUID. This is available only for recordings.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "channel_id": "iso9Dllddp39dagjLj9j",
      "video_id": "csduzfv3JwTeyR5QpC3PXw52",
      "meeting_id": "rec1zfv3JwTeyR5QpC3PXw52"
    }
  }
}