Skip to content

ZAK readme #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gerrysaporito merged 1 commit into from
Apr 28, 2026
Merged

ZAK readme #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion bot_mixed_audio_stream_realtime_write_to_audio_files/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
26 changes: 13 additions & 13 deletions bot_signed_in_zoom_bots/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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 │ │
Expand All @@ -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 │
│ │───────────────▶│ │
Expand All @@ -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 │
Expand All @@ -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

Expand Down Expand Up @@ -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

Expand Down
Loading