This repository demonstrates how to integrate with Zoom's WebSocket API, including OAuth token fetching and WebSocket connection management. It includes a heartbeat mechanism to keep WebSocket connections alive and provides a reference implementation for interacting with Zoom's WebSocket-based services.
- Fetches Zoom OAuth access tokens using the client credentials grant type.
- Establishes a WebSocket connection with Zoom servers.
- Implements a heartbeat mechanism to maintain the WebSocket connection.
- Handles WebSocket events, including
open,message,close, anderror.
Before running the project, ensure you have the following:
- Node.js: Version 18.0.0 or higher (or use
node-fetchfor lower versions). - Zoom Account: Create an server-to-server OAuth or general app on the Zoom Marketplace to get your client ID and client secret.
- Environment Variables: Set up a
.envfile for your credentials.
-
Clone the repository:
git clone https://github.com/eziosudo/websocket_demo.git cd websocket_demo -
Install dependencies:
npm install
-
Create a
.envfile with the following keys:CLIENT_USERNAME=your_client_id CLIENT_PASSWORD=your_client_secret SUBSCRIPTION_ID=your_subscription_id OAUTH_URL=https://zoom.us/oauth/token WS_URL=wss://ws.zoom.us/ws -
Run the application:
node connect_websocket.js
connect_websocket.js: Core implementation file.- Fetches OAuth tokens from Zoom.
- Establishes a WebSocket connection.
- Sends periodic heartbeat messages.
- Handles WebSocket events such as
open,message,close, anderror.
Access tokens are fetched from Zoom's API using the client credentials grant type:
const url = `https://zoom.us/oauth/token?grant_type=client_credentials`;
const headers = {
"Authorization": `Basic ${Buffer.from(`${username}:${password}`).toString('base64')}`,
"Content-Type": "application/x-www-form-urlencoded"
};
const response = await fetch(url, { method: "POST", headers });A heartbeat mechanism ensures the connection remains active. Heartbeat messages are sent every 30 seconds:
function startHeartbeat() {
const heartbeatMessage = JSON.stringify({ module: 'heartbeat' });
const heartbeatIntervalMs = 30000;
heartbeatInterval = setInterval(() => {
if (socket.readyState === WebSocket.OPEN) {
socket.send(heartbeatMessage);
console.log('Heartbeat sent.');
}
}, heartbeatIntervalMs);
}The application listens for key WebSocket events:
open: Starts the heartbeat mechanism.message: Logs incoming messages.close: Stops the heartbeat mechanism and logs closure.error: Logs errors and stops the heartbeat mechanism.
Start the application to connect to Zoom's WebSocket server. Messages and events are logged to the console.
node connect_websocket.js- Ensure your Zoom server-to-server OAuth or general app is properly configured in the Zoom Marketplace.
- For production use, consider implementing a token refresh mechanism and secure credential storage.