Schedule Record Event

Configures a bot to automatically join and record a specific calendar event at its scheduled time

Authorization

x-meeting-baas-api-key<token>

API key for authentication

In: header

x-spoke-api-key<token>

Legacy API key for authentication (deprecated)

In: header

Request Body

application/jsonRequired

bot_imagestring | null

The image to use for the bot, can be a URL or a Base64 encoded string. Recommended size is 1280x720px.

bot_name

Required

string

deduplication_keystring | null

enter_messagestring | null

extra

Required

object

Custom data object

noone_joined_timeoutinteger | null

Format: "int32"

recording_modeAny properties in string | string | string

speech_to_textAny properties in Any properties in object, string

streaming_audio_frequencyAny properties in string

streaming_inputstring | null

streaming_outputstring | null

waiting_room_timeoutinteger | null

Format: "int32"

webhook_urlstring | null

Query Parameters

all_occurrencesboolean | null

schedule a bot to all occurences of a recurring event

curl -X POST "https://api.meetingbaas.com/calendar_events/{uuid}/bot?all_occurrences=true" \
  -H "x-meeting-baas-api-key: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "bot_image": "string",
    "bot_name": "string",
    "deduplication_key": "string",
    "enter_message": "string",
    "extra": {},
    "noone_joined_timeout": 0,
    "recording_mode": "speaker_view",
    "speech_to_text": {
      "api_key": "string",
      "provider": "Gladia"
    },
    "streaming_audio_frequency": "16khz",
    "streaming_input": "string",
    "streaming_output": "string",
    "waiting_room_timeout": 0,
    "webhook_url": "string"
  }'

[
  {
    "attendees": [
      {
        "email": "string"
      }
    ],
    "bot_param": {
      "bot_image": "string",
      "bot_name": "string",
      "deduplication_key": "string",
      "enter_message": "string",
      "extra": {},
      "noone_joined_timeout": 0,
      "recording_mode": "speaker_view",
      "speech_to_text": {
        "api_key": "string",
        "provider": "Gladia"
      },
      "streaming_audio_frequency": "16khz",
      "streaming_input": "string",
      "streaming_output": "string",
      "waiting_room_timeout": 0,
      "webhook_url": "string"
    },
    "calendar_uuid": "fd186a18-ef28-468e-9173-223796807e2e",
    "deleted": true,
    "end_time": "2019-08-24T14:15:22Z",
    "google_id": "string",
    "is_organizer": true,
    "is_recurring": true,
    "last_updated_at": "2019-08-24T14:15:22Z",
    "meeting_url": "string",
    "name": "string",
    "raw": {},
    "recurring_event_id": "string",
    "start_time": "2019-08-24T14:15:22Z",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  }
]

Authorization

Request Body

Query Parameters

Response

TypeScript