Node.js / Zoom API / Update Live Stream Status
Back to Collection Items
var os = require('os');
if (os.platform() == 'win32') {
if (os.arch() == 'ia32') {
var chilkat = require('@chilkat/ck-node21-win-ia32');
} else {
var chilkat = require('@chilkat/ck-node21-win64');
}
} else if (os.platform() == 'linux') {
if (os.arch() == 'arm') {
var chilkat = require('@chilkat/ck-node21-arm');
} else if (os.arch() == 'x86') {
var chilkat = require('@chilkat/ck-node21-linux32');
} else {
var chilkat = require('@chilkat/ck-node21-linux64');
}
} else if (os.platform() == 'darwin') {
if (os.arch() == 'arm64') {
var chilkat = require('@chilkat/ck-node21-mac-m1');
} else {
var chilkat = require('@chilkat/ck-node21-macosx');
}
}
function chilkatExample() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
var http = new chilkat.Http();
var success;
var req = new chilkat.HttpRequest();
req.HttpVerb = "PATCH";
req.Path = "/v2/webinars/:webinarId/livestream/status";
req.ContentType = "multipart/form-data";
req.AddParam("action","start");
req.AddParam("settings","start{\"active_speaker_name\":false,\"display_name\":\"reprehender\"}");
req.AddHeader("Authorization","Bearer <access_token>");
// resp: HttpResponse
var resp = http.SynchronousRequest("api.zoom.us",443,true,req);
if (http.LastMethodSuccess == false) {
console.log(http.LastErrorText);
return;
}
var respStatusCode = resp.StatusCode;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode !== 204) {
console.log("Response Header:");
console.log(resp.Header);
console.log("Response Body:");
console.log(resp.BodyStr);
console.log("Failed.");
return;
}
console.log("Success.");
}
chilkatExample();
Curl Command
curl -X PATCH
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'action=start'
--form 'settings=start{"active_speaker_name":false,"display_name":"reprehender"}'
https://api.zoom.us/v2/webinars/:webinarId/livestream/status
Postman Collection Item JSON
{
"name": "Update Live Stream Status",
"request": {
"auth": {
"type": "oauth2"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "action",
"value": "start",
"description": "Update the status of a live stream. This value can be one of the following:\n\n* `start` — Start a webinar live stream.\n\n* `stop` — Stop an ongoing webinar live stream. (This can only be one of start,stop)",
"type": "text"
},
{
"key": "settings",
"value": "{\"active_speaker_name\":false,\"display_name\":\"reprehender\"}",
"description": "Update the live stream session's settings. You can **only** update settings for a stopped live stream.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/livestream/status",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"livestream",
"status"
],
"variable": [
{
"key": "webinarId",
"value": "68423085",
"description": "(Required) The webinar's ID."
}
]
},
"description": "Zoom allows users to [live stream a webinar](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. Use this API to update the status of a webinar's live stream.<br><br>\n**Prerequisites:**<br>\n* Pro or higher plan with a Webinar Add-on.<br>\n* Live streaming details must have been [configured](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service#h_01589a6f-a40a-4e18-a448-cb746e52ebc5) for the webinar.<br><br>\n**Scopes:** `webinar:write:admin` `webinar:write`<br>\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` \n\n"
},
"response": [
{
"name": "**HTTP Status Code:** `204` <br>\nMeeting live stream updated.\n\n",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "action",
"value": "start",
"description": "Update the status of a live stream. This value can be one of the following:\n\n* `start` — Start a webinar live stream.\n\n* `stop` — Stop an ongoing webinar live stream. (This can only be one of start,stop)",
"type": "text"
},
{
"key": "settings",
"value": "{\"active_speaker_name\":false,\"display_name\":\"reprehender\"}",
"description": "Update the live stream session's settings. You can **only** update settings for a stopped live stream.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/livestream/status",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"livestream",
"status"
],
"variable": [
{
"key": "webinarId",
"value": "68423085",
"description": "(Required) The webinar's ID."
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `400` **Bad Request**<br>\n**Error Code:** `300` <br>\n* Webinar Id does not exist.<br>\n* Invalid Webinar Id.<br>\n**Error Code:** `3001` Webinar does not exist: {webinarId}.<br>\n**Error Code:** `1001` User does not exist: {userId}.<br>",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "action",
"value": "start",
"description": "Update the status of a live stream. This value can be one of the following:\n\n* `start` — Start a webinar live stream.\n\n* `stop` — Stop an ongoing webinar live stream. (This can only be one of start,stop)",
"type": "text"
},
{
"key": "settings",
"value": "{\"active_speaker_name\":false,\"display_name\":\"reprehender\"}",
"description": "Update the live stream session's settings. You can **only** update settings for a stopped live stream.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/livestream/status",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"livestream",
"status"
],
"variable": [
{
"key": "webinarId",
"value": "68423085",
"description": "(Required) The webinar's ID."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
