/api/v2/slack-teams/

post https://us-east-1.recall.ai/api/v2/slack-teams/

📘
Relevant Links
Slack Huddles Overview
Slack Bot Setup

Body Params

email_address

string

required

The email address of the bot user. This is the email address that the customer will invite to their Slack workspace.

slack_team_domain

string

required

The domain of the Slack workspace that the bot user will be invited to. For instance "mycompany.slack.com".

bot_name

string

required

The name of the bot user. This is the name that will be displayed in Slack.

profile_photo_base64_jpg

string | null

The profile photo of the bot user, encoded as a base64 string. This is the profile photo that will be displayed in Slack. This must be a 512x512px JPEG image.

auto_join_public_huddles

boolean

required

Whether the bot user should automatically join huddles occuring in public channels.

ask_to_join_private_huddles

boolean

required

Whether the bot user should ask to join huddles occuring in private channels.

ask_to_join_message

string

required

The message that the bot user will send when asking to join a private huddle.

filter_huddles_by_user_emails

array of strings | null

A list of email addresses. If this is set, the bot user will only join huddles where one of the users is a participant of the huddle.

filter_huddles_by_user_emails

huddle_bot_config

object

required

The configuration of the bot to join a huddle.

Response

Response body

object

uuid

required

email_address

string

required

The email address of the bot user. This is the email address that the customer will invite to their Slack workspace.

slack_team_domain

string

required

The domain of the Slack workspace that the bot user will be invited to. For instance "mycompany.slack.com".

bot_name

string

required

The name of the bot user. This is the name that will be displayed in Slack.

profile_photo_base64_jpg

string | null

The profile photo of the bot user, encoded as a base64 string. This is the profile photo that will be displayed in Slack. This must be a 512x512px JPEG image.

auto_join_public_huddles

boolean

required

Whether the bot user should automatically join huddles occuring in public channels.

ask_to_join_private_huddles

boolean

required

Whether the bot user should ask to join huddles occuring in private channels.

ask_to_join_message

string

required

The message that the bot user will send when asking to join a private huddle.

filter_huddles_by_user_emails

array of strings | null

A list of email addresses. If this is set, the bot user will only join huddles where one of the users is a participant of the huddle.

filter_huddles_by_user_emails

huddle_bot_config

object

required

The configuration of the bot to join a huddle.

uuid

required

meeting_url

string

required

The url of the meeting. For example, https://zoom.us/j/123?pwd=456. This field will be cleared a few days after the bot has joined a call.

bot_name

string

length ≤ 100

Defaults to Meeting Notetaker

The name of the bot that will be displayed in the call.
(Note: Authenticated Google Meet bots will use the Google account name and this field will be ignored.)

join_at

date-time | null

The time at which the bot will join the call, formatted in ISO 8601. This field can only be read from scheduled bots that have not yet joined a call. Once a bot has joined a call, it's join_at will be cleared.

video_url

uri

required

A URL where the video recorded by the bot can be downloaded. This is null while the recording is in progress, and will be populated when the recording is completed. The returned URL is valid for 6 hours from the API call. A fresh URL can be obtained at any point by calling the API again.

media_retention_end

date-time

required

After this date the video and transcript will be deleted. This date is 7 days from when the recording ended.

status_changes

array of objects

required

status_changes*

object

code

string

required

message

string

required

created_at

date-time

required

sub_code

string

required

meeting_metadata

object | null

required

meeting_participants

array of objects

required

meeting_participants*

object

integer

required

name

string

required

events

array of objects

required

events*

object

code

string

required

created_at

date-time

required

is_host

boolean

required

platform

string

required

extra_data

object

required

real_time_transcription

object | null

The settings for real-time transcription.

real_time_media

object | null

The settings for real-time media output.

transcription_options

object | null

recording_mode

string

Defaults to speaker_view

speaker_view - speaker_view
gallery_view - gallery_view
gallery_view_v2 - gallery_view_v2
audio_only - audio_only

speaker_view gallery_view gallery_view_v2 audio_only

recording_mode_options

object | null

Additional options for recording mode.

include_bot_in_recording

object

recordings

array of objects

required

recordings*

object

uuid

required

created_at

date-time

required

started_at

date-time | null

completed_at

date-time | null

output_media

object | null

Settings for the bot output media.

automatic_video_output

object | null

Settings for the bot to output video. Image should be 16:9. Recommended resolution is 640x360.

automatic_audio_output

object | null

(BETA) Settings for the bot to output audio.

chat

object | null

(BETA) Settings for the bot to send chat messages.
(Note: Chat functionality is only supported for Zoom, Google Meet and Microsoft Teams currently.)

automatic_leave

object | null

variant

object | null

Configure bot variants per meeting platforms, e.g. {"zoom": "web_4_core"}.

calendar_meetings

array of objects

required

The calendar meetings associated with this bot. This field is populated only for bots that are dispatched via Calendar V1 API integration.

calendar_meetings*

object

uuid

required

start_time

date-time

required

end_time

date-time

required

calendar_user

object

required

zoom

object | null

Zoom specific parameters

google_meet

object | null

Google Meet specific parameters

slack_team

object | null

required

metadata

object

Has additional fields

recording

string

required

status

string

required

updated_at

date-time

required

created_at

date-time

required

Language

Credentials

Header

URL


xxxxxxxxxx
54
1
curl --request POST \
2
     --url https://us-east-1.recall.ai/api/v2/slack-teams/ \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "auto_join_public_huddles": true,
8
  "ask_to_join_private_huddles": true,
9
  "huddle_bot_config": {
10
    "transcription_options": {
11
      "provider": "deepgram"
12
    },
13
    "output_media": {
14
      "camera": {
15
        "kind": "webpage"
16
      },
17
      "screenshare": {
18
        "kind": "webpage"
19
      }
20
    },
21
    "automatic_video_output": {
22
      "in_call_recording": {
23
        "kind": "jpeg"
24
      },
25
      "in_call_not_recording": {
26
        "kind": "jpeg"
27
      }
28
    },
29
    "automatic_audio_output": {

Click Try It! to start a request and see the response here! Or choose an example:

application/json

📘Relevant Links

201

📘
Relevant Links