From af148090a3e5ff7ec052cd8bd65e61cddc19fbab Mon Sep 17 00:00:00 2001 From: Gerry Saporito Date: Tue, 28 Apr 2026 15:27:35 -0700 Subject: [PATCH] ZAK readme --- .../src/index.ts | 2 +- bot_signed_in_zoom_bots/README.md | 26 +++++++++---------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/bot_mixed_audio_stream_realtime_write_to_audio_files/src/index.ts b/bot_mixed_audio_stream_realtime_write_to_audio_files/src/index.ts index f508020..b554606 100644 --- a/bot_mixed_audio_stream_realtime_write_to_audio_files/src/index.ts +++ b/bot_mixed_audio_stream_realtime_write_to_audio_files/src/index.ts @@ -21,7 +21,7 @@ wss.on("connection", (socket: WebSocket & { recording_id: string }) => { // Set the recording id for the socket. // This is needed to close the audio pipeline when the socket is closed. - if (!msg.data.recording?.id) { + if (!msg?.data?.recording?.id) { console.log("No recording id found in message"); return; } else if (!socket.recording_id) { diff --git a/bot_signed_in_zoom_bots/README.md b/bot_signed_in_zoom_bots/README.md index 458995f..6a13e00 100644 --- a/bot_signed_in_zoom_bots/README.md +++ b/bot_signed_in_zoom_bots/README.md @@ -6,9 +6,9 @@ This example demonstrates how to implement the Zoom ZAK (Zoom Access Key) token The ZAK (Zoom Access Key) token enables bots to join Zoom meetings with authenticated access which enables: -- Joining meetings that require signed-in participants -- Starting instant meetings or scheduled meetings before the host joins -- Appearing as a named Zoom user rather than a guest +- Joining meetings that require signed-in participants +- Starting instant meetings or scheduled meetings before the host joins +- Appearing as a named Zoom user rather than a guest > **πŸ“˜ For complete documentation, see:** [Zoom Signed-in Bots](https://docs.recall.ai/docs/zoom-signed-in-bots) @@ -19,7 +19,7 @@ The ZAK (Zoom Access Key) token enables bots to join Zoom meetings with authenti β”‚ Client β”‚ β”‚ Server β”‚ β”‚ Zoom β”‚ β”‚ Recall β”‚ β””β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”˜ β”‚ β”‚ β”‚ β”‚ - β”‚ 1. GET /zoom/oauth β”‚ β”‚ + β”‚ 1. GET Zoom OAuth Authorization URL β”‚ │───────────────▢│ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ Redirect to Zoom OAuth β”‚ β”‚ @@ -31,7 +31,7 @@ The ZAK (Zoom Access Key) token enables bots to join Zoom meetings with authenti β”‚ Callback with code β”‚ β”‚ │◀────────────────────────────────│ β”‚ β”‚ β”‚ β”‚ β”‚ - β”‚ 2. GET /zoom/oauth/callback β”‚ β”‚ + β”‚ 2. GET Zoom OAuth callback β”‚ β”‚ │───────────────▢│ β”‚ β”‚ β”‚ β”‚ Exchange for tokens β”‚ β”‚ │───────────────▢│ β”‚ @@ -51,7 +51,7 @@ The ZAK (Zoom Access Key) token enables bots to join Zoom meetings with authenti β”‚ When bot joins call: β”‚ β”‚ ═════════════════════════════════════════════════ β”‚ β”‚ β”‚ β”‚ β”‚ - β”‚ β”‚ 4. GET /zoom/zak β”‚ + β”‚ β”‚ 4. GET zak_url β”‚ β”‚ β”‚ │◀─────────────────────────────────│ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ Refresh access token β”‚ @@ -72,9 +72,9 @@ The ZAK (Zoom Access Key) token enables bots to join Zoom meetings with authenti ## Prerequisites -- [Zoom OAuth App](https://developers.zoom.us/docs/integrations/create/) with scope: `user:read:zak` -- [ngrok](https://ngrok.com/) for exposing your local server -- [Node.js](https://nodejs.org/) 18+ +- [Zoom OAuth App](https://developers.zoom.us/docs/integrations/create/) with scope: `user:read:zak` +- [ngrok](https://ngrok.com/) for exposing your local server +- [Node.js](https://nodejs.org/) 18+ ## Setup @@ -154,10 +154,10 @@ curl -X POST "https://RECALL_REGION.recall.ai/api/v1/bot/" \ **Note**: -- Replace `RECALL_REGION`, `RECALL_API_KEY`, and `YOUR_MEETING_URL` with your own - values. -- Replace `YOUR_NGROK_DOMAIN` with your ngrok domain (e.g. `somehash.ngrok-free.app`). -- The bot will join the meeting as a signed-in Zoom user. +- Replace `RECALL_REGION`, `RECALL_API_KEY`, and `YOUR_MEETING_URL` with your own + values. +- Replace `YOUR_NGROK_DOMAIN` with your ngrok domain (e.g. `somehash.ngrok-free.app`). +- The bot will join the meeting as a signed-in Zoom user. ## API Endpoints