Chilkat Online Tools

phpAx / Zoom API / Update a live stream

Back to Collection Items

<?php

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.HttpRequest')
$req = new COM("Chilkat.HttpRequest");
$req->HttpVerb = 'PATCH';
$req->Path = '/v2/meetings/:meetingId/livestream';
$req->ContentType = 'multipart/form-data';
$req->AddParam('stream_url','aute');

$req->AddParam('stream_key','auteofficia');

$req->AddParam('page_url','auteofficiahttps://IBrRnEbZoeJwPd.ixq+PqOQQZC-z42EWi');

$req->AddHeader('Authorization','Bearer <access_token>');

// resp is a Chilkat.HttpResponse
$resp = $http->SynchronousRequest('api.zoom.us',443,1,$req);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode != 204) {
    print 'Response Header:' . "\n";
    print $resp->Header . "\n";
    print 'Response Body:' . "\n";
    print $resp->BodyStr . "\n";
    print 'Failed.' . "\n";

    exit;
}

print 'Success.' . "\n";

?>

Curl Command

curl -X PATCH
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: multipart/form-data"
	--form 'stream_url=aute'
	--form 'stream_key=auteofficia'
	--form 'page_url=auteofficiahttps://IBrRnEbZoeJwPd.ixq+PqOQQZC-z42EWi'
https://api.zoom.us/v2/meetings/:meetingId/livestream

Postman Collection Item JSON

{
  "name": "Update a live stream",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "PATCH",
    "header": [
      {
        "key": "Content-Type",
        "value": "multipart/form-data"
      }
    ],
    "body": {
      "mode": "formdata",
      "formdata": [
        {
          "key": "stream_url",
          "value": "aute ",
          "description": "(Required) Streaming URL.",
          "type": "text"
        },
        {
          "key": "stream_key",
          "value": "officia",
          "description": "(Required) Stream name and key.",
          "type": "text"
        },
        {
          "key": "page_url",
          "value": "https://IBrRnEbZoeJwPd.ixq+PqOQQZC-z42EWi",
          "description": "(Required) The live stream page URL.",
          "type": "text"
        }
      ]
    },
    "url": {
      "raw": "{{baseUrl}}/meetings/:meetingId/livestream",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "meetings",
        ":meetingId",
        "livestream"
      ],
      "variable": [
        {
          "key": "meetingId",
          "value": "68423085",
          "description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
        }
      ]
    },
    "description": "Use this API to update a meeting's live stream information. Zoom allows users to [live stream a meeting](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform.\n\n**Scopes:** `meeting:write:admin`, `meeting:write`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\n\n**Prerequisites:** \n* Meeting host must have a Pro license."
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `204`<br>\nMeeting live stream updated.",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "stream_url",
              "value": "aute ",
              "description": "(Required) Streaming URL.",
              "type": "text"
            },
            {
              "key": "stream_key",
              "value": "officia",
              "description": "(Required) Stream name and key.",
              "type": "text"
            },
            {
              "key": "page_url",
              "value": "https://IBrRnEbZoeJwPd.ixq+PqOQQZC-z42EWi",
              "description": "(Required) The live stream page URL.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/meetings/:meetingId/livestream",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "meetings",
            ":meetingId",
            "livestream"
          ],
          "variable": [
            {
              "key": "meetingId",
              "value": "68423085",
              "description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
            }
          ]
        }
      },
      "status": "No Content",
      "code": 204,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**Error Code:** `300` <br>Missing meetingId <br> Invalid meetingId.",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "stream_url",
              "value": "aute ",
              "description": "(Required) Streaming URL.",
              "type": "text"
            },
            {
              "key": "stream_key",
              "value": "officia",
              "description": "(Required) Stream name and key.",
              "type": "text"
            },
            {
              "key": "page_url",
              "value": "https://IBrRnEbZoeJwPd.ixq+PqOQQZC-z42EWi",
              "description": "(Required) The live stream page URL.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/meetings/:meetingId/livestream",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "meetings",
            ":meetingId",
            "livestream"
          ],
          "variable": [
            {
              "key": "meetingId",
              "value": "68423085",
              "description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
            }
          ]
        }
      },
      "status": "Multiple Choices",
      "code": 300,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**HTTP Status Code:** `400`<br>**Error Code:** `1010` <br>\n User does not belong to this account: {accountId}.<br>\n **Error Code:** `3000` Cannot access webinar info.",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "stream_url",
              "value": "aute ",
              "description": "(Required) Streaming URL.",
              "type": "text"
            },
            {
              "key": "stream_key",
              "value": "officia",
              "description": "(Required) Stream name and key.",
              "type": "text"
            },
            {
              "key": "page_url",
              "value": "https://IBrRnEbZoeJwPd.ixq+PqOQQZC-z42EWi",
              "description": "(Required) The live stream page URL.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/meetings/:meetingId/livestream",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "meetings",
            ":meetingId",
            "livestream"
          ],
          "variable": [
            {
              "key": "meetingId",
              "value": "68423085",
              "description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**HTTP Status Code:** `404`<br>**Error Code:** `1001` <br>User {userId} does not exist.\n",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "stream_url",
              "value": "aute ",
              "description": "(Required) Streaming URL.",
              "type": "text"
            },
            {
              "key": "stream_key",
              "value": "officia",
              "description": "(Required) Stream name and key.",
              "type": "text"
            },
            {
              "key": "page_url",
              "value": "https://IBrRnEbZoeJwPd.ixq+PqOQQZC-z42EWi",
              "description": "(Required) The live stream page URL.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/meetings/:meetingId/livestream",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "meetings",
            ":meetingId",
            "livestream"
          ],
          "variable": [
            {
              "key": "meetingId",
              "value": "68423085",
              "description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}