Recall-Managed Bot Scheduling

The calendar integration allows every unique user in your app to connect their Google or Microsoft calendars and have Recall bots join their meetings automatically.

You can integrate Recall APIs directly into your Web/Mobile applications.

• Calendar V1 Integration Sample App

Step 1: Generate a calendar auth token

This token authenticates all subsequent requests to the Calendar Integration API. You can generate a token using the Create Calendar Authentication Token endpoint as shown below.

curl --request POST \
     --url https://us-east-1.recall.ai/api/v1/calendar/authenticate/ \
     --header 'Authorization: RECALL_API_KEY' \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

The token is stateless, expires after 24 hours, and can be generated multiple times for the same user. Keep the following in mind:

• The user_id field should remain consistent for a specific user across multiple calls, failure to do so can result in duplicate calendar users and multiple bots joining calls.

Calendar auth token best practices example

We recommend generating calendar auth tokens through a server-side endpoint rather than calling this endpoint directly from your client application. This prevents your Recall API key from being exposed in browser or mobile app code.

For example:

1. Your client requests a token from your backend:

POST /api/calendar/auth-token

2. Your backend calls Recall using your private API key:

POST https://us-east-1.recall.ai/api/v1/calendar/authenticate/
Authorization: YOUR_RECALL_API_KEY
Content-Type: application/json

{
  "user_id": "user_123"
}

3. Your backend returns the generated calendar auth token to the client.

See the example proxy implementation.

Step 2: Initiate a user's calendar connection

Set up OAuth clients for each supported calendar platform, then redirect users to the appropriate calendar connection URL. See the code example.

Google Calendar Setup

1. Go to the Google API console
   1. Once inside, create a Google Project if you have not already
   2. Inside the Google Project, enable the Google Calendar API
2. Once complete, follow this Google Calendar Setup guide

Microsoft Outlook Calendar Setup

1. Follow this Microsoft Outlook Calendar Setup guide

Step 3: Fetch upcoming meetings

Once a user's calendar is successfully connected. You can retrieve their upcoming meetings via the List Calendar Meetings API endpoint by passing the calendar auth token as x-recallcalendarauthtoken header in the request.

The calendar integration automatically syncs updates to calendar events in near real-time, so every subsequent request to the list endpoint should give you the latest data.

For meetings that will be recorded by Recall, the meeting object will have the bot_id attribute populated. That bot will be scheduled to join the meeting.

Step 4: Update recording preferences

Allow a user to update their Recording Preferences using the API. For more detailed documentation on that endpoint, see Calendar V1 Auto Recording Logic & Preferences for more details.

Step 5: Configuring calendar bots

• This step is optional since you can accept the default bot configuration initially.
• Bots will join 2 minutes before the scheduled start time of the meeting.

Bot config examples:

Example 1: Setting an image for calendar bots

{
  "automatic_video_output": {
    "in_call_recording": {
      "kind": "jpeg",
      "b64_data": "base64_jpeg_data"
    },
    "in_call_not_recording": {
      "kind": "jpeg",
      "b64_data": "base64_jpeg_data"
    }
  }
}

Example 2: Enabling real time transcription for calendar bots

{
  "recording_config": {
    "transcript": {
      "provider": {
        "recallai_streaming": {}
      }
    },
    realtime_endpoints: [
      {
        "type": "webhook",
        "events": ["transcript.data"],
        "url": "..."
      }
    ]
  },
}