PATCH /meetings/{meetingId}/livestream/status
Zoom allows users to live stream a meeting to a custom platform. Use this API to update the status of a meeting's live stream.
Prerequisites:
- Meeting host must have a Pro license.
Scopes:meeting:write:adminmeeting:write
Rate Limit Label:Light
Servers
- https://api.zoom.us/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
meetingId |
Integer | Yes |
The meeting ID in long format. The data type of this field is "long"(represented as int64 in JSON). While storing it in your database, store it as a long data type and not as an integer, as the Meeting IDs can be longer than 10 digits. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
action |
String | No |
Update the status of a livestream. The value can be one of the following: Valid values:
|
settings |
Object | No |
Update the settings of a live streaming session. The settings can only be updated for a live stream that has been stopped. You can not update the settings of an ongoing live stream. |
settings.display_name |
String | No |
Display name of the live stream. |
settings.active_speaker_name |
Boolean | No |
Display the name of the active speaker during a live stream. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.