Zoom

Links

    Zoom API

    Getting access, Developing, Testing

    Back to Zoom

    Webinar Live Stream Status Update

    Zoom allows users to live stream a webinar to a custom platform. Use this API to update the status of a webinar's live stream.

    Prerequisites:

    • Pro or higher plan with a Webinar Add-on.
    • Live streaming details must have been configured for the webinar.

      Scopes: webinar:write:admin webinar:write
      Rate Limit Label: Light

    Input

    type: object properties: parameters: type: object properties: webinarId: format: int64 type: integer example: 99289110036 description: The webinar's ID. required: - webinarId title: Parameters data: type: object properties: action: description: >- Update the status of a live stream. This value can be one of the following: * `start` — Start a webinar live stream. * `stop` — Stop an ongoing webinar live stream. enum: - start - stop type: string x-enum-descriptions: - Start a webinar live stream. - Stop a webinar live stream. example: start settings: type: object properties: active_speaker_name: description: Display the name of the active speaker during a live stream. type: boolean example: true display_name: description: Display the name of the live stream. maxLength: 50 minLength: 1 type: string example: Jill Chill title: Data