MeetingRouter
@meeting-baas/sdk - v2 API Reference v6.0.0

types

@meeting-baas/sdk - v2 API Reference / types

types

Interfaces

BaasClientConfig

Configuration for the BaasClient

Properties

api_key

api_key: string

Meeting BaaS API key. Get your API key from https://meetingbaas.com/

api_version?

optional api_version: "vexa" | "v1" | "v2"

API version to use

  • "v1": Meeting BaaS v1 API (default, for backward compatibility)
  • "v2": Meeting BaaS v2 API
  • "vexa": Vexa API
Default
"v1"
base_url?

optional base_url: string

Base URL for the API This is an internal parameter and should not be accessed directly

Default
"https://api.meetingbaas.com"
timeout?

optional timeout: number

Timeout for the API requests. Default is 30 seconds. Some requests may take longer, so we recommend setting a longer timeout if you notice timeouts.

Default
30000

BaasClientConfigV1

Base configuration for v1 client

Extends

Properties

api_key

api_key: string

Meeting BaaS API key. Get your API key from https://meetingbaas.com/

Inherited from

BaasClientConfig.api_key

api_version?

optional api_version: "v1"

base_url?

optional base_url: string

Base URL for the API This is an internal parameter and should not be accessed directly

Default
"https://api.meetingbaas.com"
Inherited from

BaasClientConfig.base_url

timeout?

optional timeout: number

Timeout for the API requests. Default is 30 seconds. Some requests may take longer, so we recommend setting a longer timeout if you notice timeouts.

Default
30000
Inherited from

BaasClientConfig.timeout

BaasClientConfigV2

Base configuration for v2 client

Extends

Properties

api_key

api_key: string

Meeting BaaS API key. Get your API key from https://meetingbaas.com/

Inherited from

BaasClientConfig.api_key

api_version

api_version: "v2"

base_url?

optional base_url: string

Base URL for the API This is an internal parameter and should not be accessed directly

Default
"https://api.meetingbaas.com"
Inherited from

BaasClientConfig.base_url

timeout?

optional timeout: number

Timeout for the API requests. Default is 30 seconds. Some requests may take longer, so we recommend setting a longer timeout if you notice timeouts.

Default
30000
Inherited from

BaasClientConfig.timeout

BaasClientConfigVexa

Base configuration for Vexa client

Extends

Properties

api_key

api_key: string

Meeting BaaS API key. Get your API key from https://meetingbaas.com/

Inherited from

BaasClientConfig.api_key

api_version

api_version: "vexa"

base_url?

optional base_url: string

Base URL for the API This is an internal parameter and should not be accessed directly

Default
"https://api.meetingbaas.com"
Inherited from

BaasClientConfig.base_url

timeout?

optional timeout: number

Timeout for the API requests. Default is 30 seconds. Some requests may take longer, so we recommend setting a longer timeout if you notice timeouts.

Default
30000
Inherited from

BaasClientConfig.timeout

BaasClientV1Methods

v1 Client methods interface These methods use wrapped responses (ApiResponse<T>)

Methods

createCalendar()

createCalendar(params): Promise<ApiResponse<CreateCalendarResponse>>

Parameters
ParameterType
paramsCreateCalendarParams
Returns

Promise<ApiResponse<CreateCalendarResponse>>

deleteBotData()

deleteBotData(params): Promise<ApiResponse<DeleteResponse>>

Parameters
ParameterType
params{ uuid: string; }
params.uuidstring
Returns

Promise<ApiResponse<DeleteResponse>>

deleteCalendar()

deleteCalendar(params): Promise<ApiResponse<void>>

Parameters
ParameterType
params{ uuid: string; }
params.uuidstring
Returns

Promise<ApiResponse<void>>

getApiKey()

getApiKey(): string

Returns

string

getBaseUrl()

getBaseUrl(): string

Returns

string

getBotWebhookDocumentation()

getBotWebhookDocumentation(): Promise<ApiResponse<unknown>>

Returns

Promise<ApiResponse<unknown>>

getCalendar()

getCalendar(params): Promise<ApiResponse<Calendar>>

Parameters
ParameterType
params{ uuid: string; }
params.uuidstring
Returns

Promise<ApiResponse<Calendar>>

getCalendarEvent()

getCalendarEvent(params): Promise<ApiResponse<Event>>

Parameters
ParameterType
params{ uuid: string; }
params.uuidstring
Returns

Promise<ApiResponse<Event>>

getCalendarWebhookDocumentation()

getCalendarWebhookDocumentation(): Promise<ApiResponse<unknown>>

Returns

Promise<ApiResponse<unknown>>

getMeetingData()

getMeetingData(params): Promise<ApiResponse<Metadata>>

Parameters
ParameterType
paramsGetMeetingDataParams
Returns

Promise<ApiResponse<Metadata>>

getScreenshots()

getScreenshots(params): Promise<ApiResponse<ScreenshotsList>>

Parameters
ParameterType
params{ uuid: string; }
params.uuidstring
Returns

Promise<ApiResponse<ScreenshotsList>>

getWebhookDocumentation()

getWebhookDocumentation(): Promise<ApiResponse<unknown>>

Returns

Promise<ApiResponse<unknown>>

joinMeeting()

joinMeeting(params): Promise<ApiResponse<JoinResponse>>

Parameters
ParameterType
paramsJoinRequest
Returns

Promise<ApiResponse<JoinResponse>>

leaveMeeting()

leaveMeeting(params): Promise<ApiResponse<LeaveResponse>>

Parameters
ParameterType
params{ uuid: string; }
params.uuidstring
Returns

Promise<ApiResponse<LeaveResponse>>

listBots()

listBots(params?): Promise<ApiResponse<ListRecentBotsResponse>>

Parameters
ParameterType
params?BotsWithMetadataParams
Returns

Promise<ApiResponse<ListRecentBotsResponse>>

listCalendarEvents()

listCalendarEvents(query): Promise<ApiResponse<ListEventResponse>>

Parameters
ParameterType
queryListEventsParams
Returns

Promise<ApiResponse<ListEventResponse>>

listCalendars()

listCalendars(): Promise<ApiResponse<Calendar[]>>

Returns

Promise<ApiResponse<Calendar[]>>

listRawCalendars()

listRawCalendars(params): Promise<ApiResponse<ListRawCalendarsResponse>>

Parameters
ParameterType
paramsListRawCalendarsParams
Returns

Promise<ApiResponse<ListRawCalendarsResponse>>

patchBot()

patchBot(params): Promise<ApiResponse<Event[]>>

Parameters
ParameterType
params{ body: BotParam3; uuid: string; query?: PatchBotParams; }
params.bodyBotParam3
params.uuidstring
params.query?PatchBotParams
Returns

Promise<ApiResponse<Event[]>>

resyncAllCalendars()

resyncAllCalendars(query?): Promise<ApiResponse<ResyncAllCalendarsResponse>>

Parameters
ParameterType
query?ResyncAllCalendarsParams
Returns

Promise<ApiResponse<ResyncAllCalendarsResponse>>

retranscribeBot()

retranscribeBot(params): Promise<ApiResponse<void>>

Parameters
ParameterType
paramsRetranscribeBody
Returns

Promise<ApiResponse<void>>

scheduleCalendarRecordEvent()

scheduleCalendarRecordEvent(params): Promise<ApiResponse<Event[]>>

Parameters
ParameterType
params{ body: BotParam2; uuid: string; query?: ScheduleRecordEventParams; }
params.bodyBotParam2
params.uuidstring
params.query?ScheduleRecordEventParams
Returns

Promise<ApiResponse<Event[]>>

unscheduleCalendarRecordEvent()

unscheduleCalendarRecordEvent(params): Promise<ApiResponse<Event[]>>

Parameters
ParameterType
params{ uuid: string; query?: UnscheduleRecordEventParams; }
params.uuidstring
params.query?UnscheduleRecordEventParams
Returns

Promise<ApiResponse<Event[]>>

updateCalendar()

updateCalendar(params): Promise<ApiResponse<CreateCalendarResponse>>

Parameters
ParameterType
params{ body: UpdateCalendarParams; uuid: string; }
params.bodyUpdateCalendarParams
params.uuidstring
Returns

Promise<ApiResponse<CreateCalendarResponse>>

BaasClientV2Methods

v2 Client methods interface These methods use pass-through responses (ApiResponseV2<T>)

Methods

batchCreateBots()

batchCreateBots(params): Promise<BatchApiResponseV2<BatchCreateBotResponseDataItem, BatchCreateBotResponseErrorsItem>>

Parameters
ParameterType
paramsBatchCreateBotsRequestBodyInput
Returns

Promise<BatchApiResponseV2<BatchCreateBotResponseDataItem, BatchCreateBotResponseErrorsItem>>

batchCreateScheduledBots()

batchCreateScheduledBots(params): Promise<BatchApiResponseV2<BatchCreateScheduledBotResponseDataItem, BatchCreateScheduledBotResponseErrorsItem>>

Parameters
ParameterType
paramsBatchCreateScheduledBotsRequestBodyInput
Returns

Promise<BatchApiResponseV2<BatchCreateScheduledBotResponseDataItem, BatchCreateScheduledBotResponseErrorsItem>>

createBot()

createBot(params): Promise<ApiResponseV2<CreateBotResponseData>>

Parameters
ParameterType
paramsCreateBotRequestBodyInput
Returns

Promise<ApiResponseV2<CreateBotResponseData>>

createCalendarBot()

createCalendarBot(params): Promise<BatchApiResponseV2<CreateCalendarBotResponseDataItem, CreateCalendarBotResponseErrorsItem>>

Parameters
ParameterType
params{ body: CreateCalendarBotRequestBodyInput; calendar_id: string; }
params.bodyCreateCalendarBotRequestBodyInput
params.calendar_idstring
Returns

Promise<BatchApiResponseV2<CreateCalendarBotResponseDataItem, CreateCalendarBotResponseErrorsItem>>

createCalendarConnection()

createCalendarConnection(params): Promise<ApiResponseV2<CreateCalendarConnectionResponseData>>

Parameters
ParameterType
paramsCreateCalendarConnectionRequestBodyInput
Returns

Promise<ApiResponseV2<CreateCalendarConnectionResponseData>>

createScheduledBot()

createScheduledBot(params): Promise<ApiResponseV2<CreateScheduledBotResponseData>>

Parameters
ParameterType
paramsCreateScheduledBotRequestBodyInput
Returns

Promise<ApiResponseV2<CreateScheduledBotResponseData>>

deleteBotData()

deleteBotData(params): Promise<ApiResponseV2<DeleteBotDataResponseData>>

Parameters
ParameterType
params{ bot_id: string; delete_from_provider?: boolean; }
params.bot_idstring
params.delete_from_provider?boolean
Returns

Promise<ApiResponseV2<DeleteBotDataResponseData>>

deleteCalendarBot()

deleteCalendarBot(params): Promise<BatchApiResponseV2<DeleteCalendarBotResponseDataItem, DeleteCalendarBotResponseErrorsItem>>

Parameters
ParameterType
params{ calendar_id: string; event_id: string; }
params.calendar_idstring
params.event_idstring
Returns

Promise<BatchApiResponseV2<DeleteCalendarBotResponseDataItem, DeleteCalendarBotResponseErrorsItem>>

deleteCalendarConnection()

deleteCalendarConnection(params): Promise<ApiResponseV2<DeleteCalendarConnectionResponseData>>

Parameters
ParameterType
params{ calendar_id: string; }
params.calendar_idstring
Returns

Promise<ApiResponseV2<DeleteCalendarConnectionResponseData>>

deleteScheduledBot()

deleteScheduledBot(params): Promise<ApiResponseV2<DeleteScheduledBotResponseData>>

Parameters
ParameterType
params{ bot_id: string; }
params.bot_idstring
Returns

Promise<ApiResponseV2<DeleteScheduledBotResponseData>>

getApiKey()

getApiKey(): string

Returns

string

getBaseUrl()

getBaseUrl(): string

Returns

string

getBotDetails()

getBotDetails(params): Promise<ApiResponseV2<GetBotDetailsResponseData>>

Parameters
ParameterType
params{ bot_id: string; }
params.bot_idstring
Returns

Promise<ApiResponseV2<GetBotDetailsResponseData>>

getBotScreenshots()

getBotScreenshots(params): Promise<ListApiResponseV2<GetBotScreenshotsResponseDataItem>>

Parameters
ParameterType
params{ bot_id: string; cursor?: string | null; limit?: number; }
params.bot_idstring
params.cursor?string | null
params.limit?number
Returns

Promise<ListApiResponseV2<GetBotScreenshotsResponseDataItem>>

getBotStatus()

getBotStatus(params): Promise<ApiResponseV2<GetBotStatusResponseData>>

Parameters
ParameterType
params{ bot_id: string; }
params.bot_idstring
Returns

Promise<ApiResponseV2<GetBotStatusResponseData>>

getCalendarDetails()

getCalendarDetails(params): Promise<ApiResponseV2<GetCalendarDetailsResponseData>>

Parameters
ParameterType
params{ calendar_id: string; }
params.calendar_idstring
Returns

Promise<ApiResponseV2<GetCalendarDetailsResponseData>>

getEventDetails()

getEventDetails(params): Promise<ApiResponseV2<GetEventDetailsResponseData>>

Parameters
ParameterType
params{ calendar_id: string; event_id: string; }
params.calendar_idstring
params.event_idstring
Returns

Promise<ApiResponseV2<GetEventDetailsResponseData>>

getScheduledBot()

getScheduledBot(params): Promise<ApiResponseV2<GetScheduledBotResponseData>>

Parameters
ParameterType
params{ bot_id: string; }
params.bot_idstring
Returns

Promise<ApiResponseV2<GetScheduledBotResponseData>>

leaveBot()

leaveBot(params): Promise<ApiResponseV2<LeaveBotResponseData>>

Parameters
ParameterType
params{ bot_id: string; }
params.bot_idstring
Returns

Promise<ApiResponseV2<LeaveBotResponseData>>

listBots()

listBots(params?): Promise<ListApiResponseV2<ListBotsResponseDataItem>>

Parameters
ParameterType
params?ListBotsParams
Returns

Promise<ListApiResponseV2<ListBotsResponseDataItem>>

listCalendars()

listCalendars(params?): Promise<ListApiResponseV2<ListCalendarsResponseDataItem>>

Parameters
ParameterType
params?ListCalendarsParams
Returns

Promise<ListApiResponseV2<ListCalendarsResponseDataItem>>

listEvents()

listEvents(params): Promise<ListApiResponseV2<ListEventsResponseDataItem>>

Parameters
ParameterType
params{ calendar_id: string; query?: ListEventsParams; }
params.calendar_idstring
params.query?ListEventsParams
Returns

Promise<ListApiResponseV2<ListEventsResponseDataItem>>

listEventSeries()

listEventSeries(params): Promise<ListApiResponseV2<ListEventSeriesResponseDataItem>>

Parameters
ParameterType
params{ calendar_id: string; query?: ListEventSeriesParams; }
params.calendar_idstring
params.query?ListEventSeriesParams
Returns

Promise<ListApiResponseV2<ListEventSeriesResponseDataItem>>

listRawCalendars()

listRawCalendars(params): Promise<ApiResponseV2<ListRawCalendarsResponseDataItem[]>>

Parameters
ParameterType
paramsListRawCalendarsRequestBodyInput
Returns

Promise<ApiResponseV2<ListRawCalendarsResponseDataItem[]>>

listScheduledBots()

listScheduledBots(params?): Promise<ListApiResponseV2<ListScheduledBotsResponseDataItem>>

Parameters
ParameterType
params?ListScheduledBotsParams
Returns

Promise<ListApiResponseV2<ListScheduledBotsResponseDataItem>>

resendFinalWebhook()

resendFinalWebhook(params): Promise<ApiResponseV2<ResendFinalWebhookResponseData>>

Parameters
ParameterType
params{ bot_id: string; }
params.bot_idstring
Returns

Promise<ApiResponseV2<ResendFinalWebhookResponseData>>

resubscribeCalendar()

resubscribeCalendar(params): Promise<ApiResponseV2<ResubscribeCalendarResponseData>>

Parameters
ParameterType
params{ calendar_id: string; }
params.calendar_idstring
Returns

Promise<ApiResponseV2<ResubscribeCalendarResponseData>>

retryCallback()

retryCallback(params): Promise<ApiResponseV2<RetryCallbackResponseData>>

Parameters
ParameterType
params{ bot_id: string; callbackConfig?: RetryCallbackRequestBodyInput; }
params.bot_idstring
params.callbackConfig?RetryCallbackRequestBodyInput
Returns

Promise<ApiResponseV2<RetryCallbackResponseData>>

syncCalendar()

syncCalendar(params): Promise<ApiResponseV2<SyncCalendarResponseData>>

Parameters
ParameterType
params{ calendar_id: string; }
params.calendar_idstring
Returns

Promise<ApiResponseV2<SyncCalendarResponseData>>

updateCalendarBot()

updateCalendarBot(params): Promise<BatchApiResponseV2<UpdateCalendarBotResponseDataItem, UpdateCalendarBotResponseErrorsItem>>

Parameters
ParameterType
params{ body: UpdateCalendarBotRequestBodyInput; calendar_id: string; event_id: string; }
params.bodyUpdateCalendarBotRequestBodyInput
params.calendar_idstring
params.event_idstring
Returns

Promise<BatchApiResponseV2<UpdateCalendarBotResponseDataItem, UpdateCalendarBotResponseErrorsItem>>

updateCalendarConnection()

updateCalendarConnection(params): Promise<ApiResponseV2<UpdateCalendarConnectionResponseData>>

Parameters
ParameterType
params{ body: UpdateCalendarConnectionRequestBodyInput; calendar_id: string; }
params.bodyUpdateCalendarConnectionRequestBodyInput
params.calendar_idstring
Returns

Promise<ApiResponseV2<UpdateCalendarConnectionResponseData>>

updateScheduledBot()

updateScheduledBot(params): Promise<ApiResponseV2<UpdateScheduledBotResponseData>>

Parameters
ParameterType
params{ body: UpdateScheduledBotRequestBodyInput; bot_id: string; }
params.bodyUpdateScheduledBotRequestBodyInput
params.bot_idstring
Returns

Promise<ApiResponseV2<UpdateScheduledBotResponseData>>

BaasClientVexaMethods

Vexa Client methods interface These methods use Vexa API response format (ApiResponseVexa<T>)

Methods

deleteMeeting()

deleteMeeting(params): Promise<ApiResponseVexa<void>>

Parameters
ParameterType
params{ native_meeting_id: string; platform: Platform; }
params.native_meeting_idstring
params.platformPlatform
Returns

Promise<ApiResponseVexa<void>>

getApiKey()

getApiKey(): string

Returns

string

getBaseUrl()

getBaseUrl(): string

Returns

string

getBotsStatus()

getBotsStatus(): Promise<ApiResponseVexa<BotStatusResponse>>

Returns

Promise<ApiResponseVexa<BotStatusResponse>>

getMeetings()

getMeetings(): Promise<ApiResponseVexa<MeetingListResponse>>

Returns

Promise<ApiResponseVexa<MeetingListResponse>>

getTranscript()

getTranscript(params): Promise<ApiResponseVexa<TranscriptionResponse>>

Parameters
ParameterType
params{ native_meeting_id: string; platform: Platform; }
params.native_meeting_idstring
params.platformPlatform
Returns

Promise<ApiResponseVexa<TranscriptionResponse>>

requestBot()

requestBot(params): Promise<ApiResponseVexa<MeetingResponse>>

Parameters
ParameterType
paramsRequestBotProxyBotsPostBody
Returns

Promise<ApiResponseVexa<MeetingResponse>>

setWebhook()

setWebhook(params): Promise<ApiResponseVexa<void>>

Parameters
ParameterType
params{ webhook_url: string; }
params.webhook_urlstring
Returns

Promise<ApiResponseVexa<void>>

stopBot()

stopBot(params): Promise<ApiResponseVexa<MeetingResponse>>

Parameters
ParameterType
params{ native_meeting_id: string; platform: Platform; }
params.native_meeting_idstring
params.platformPlatform
Returns

Promise<ApiResponseVexa<MeetingResponse>>

updateBotConfig()

updateBotConfig(params): Promise<ApiResponseVexa<void>>

Parameters
ParameterType
params{ config: { language?: string; task?: string; }; native_meeting_id: string; platform: Platform; }
params.config{ language?: string; task?: string; }
params.config.language?string
params.config.task?string
params.native_meeting_idstring
params.platformPlatform
Returns

Promise<ApiResponseVexa<void>>

updateMeetingData()

updateMeetingData(params): Promise<ApiResponseVexa<MeetingResponse>>

Parameters
ParameterType
params{ data: UpdateMeetingDataProxyMeetingsPlatformNativeMeetingIdPatchBodyData; native_meeting_id: string; platform: Platform; }
params.dataUpdateMeetingDataProxyMeetingsPlatformNativeMeetingIdPatchBodyData
params.native_meeting_idstring
params.platformPlatform
Returns

Promise<ApiResponseVexa<MeetingResponse>>

Webhook Handling in v2 API

Previous Page

v2-methods

Next Page

On this page

typesInterfacesBaasClientConfigPropertiesapi_keyapi_version?Defaultbase_url?Defaulttimeout?DefaultBaasClientConfigV1ExtendsPropertiesapi_keyInherited fromapi_version?base_url?DefaultInherited fromtimeout?DefaultInherited fromBaasClientConfigV2ExtendsPropertiesapi_keyInherited fromapi_versionbase_url?DefaultInherited fromtimeout?DefaultInherited fromBaasClientConfigVexaExtendsPropertiesapi_keyInherited fromapi_versionbase_url?DefaultInherited fromtimeout?DefaultInherited fromBaasClientV1MethodsMethodscreateCalendar()ParametersReturnsdeleteBotData()ParametersReturnsdeleteCalendar()ParametersReturnsgetApiKey()ReturnsgetBaseUrl()ReturnsgetBotWebhookDocumentation()ReturnsgetCalendar()ParametersReturnsgetCalendarEvent()ParametersReturnsgetCalendarWebhookDocumentation()ReturnsgetMeetingData()ParametersReturnsgetScreenshots()ParametersReturnsgetWebhookDocumentation()ReturnsjoinMeeting()ParametersReturnsleaveMeeting()ParametersReturnslistBots()ParametersReturnslistCalendarEvents()ParametersReturnslistCalendars()ReturnslistRawCalendars()ParametersReturnspatchBot()ParametersReturnsresyncAllCalendars()ParametersReturnsretranscribeBot()ParametersReturnsscheduleCalendarRecordEvent()ParametersReturnsunscheduleCalendarRecordEvent()ParametersReturnsupdateCalendar()ParametersReturnsBaasClientV2MethodsMethodsbatchCreateBots()ParametersReturnsbatchCreateScheduledBots()ParametersReturnscreateBot()ParametersReturnscreateCalendarBot()ParametersReturnscreateCalendarConnection()ParametersReturnscreateScheduledBot()ParametersReturnsdeleteBotData()ParametersReturnsdeleteCalendarBot()ParametersReturnsdeleteCalendarConnection()ParametersReturnsdeleteScheduledBot()ParametersReturnsgetApiKey()ReturnsgetBaseUrl()ReturnsgetBotDetails()ParametersReturnsgetBotScreenshots()ParametersReturnsgetBotStatus()ParametersReturnsgetCalendarDetails()ParametersReturnsgetEventDetails()ParametersReturnsgetScheduledBot()ParametersReturnsleaveBot()ParametersReturnslistBots()ParametersReturnslistCalendars()ParametersReturnslistEvents()ParametersReturnslistEventSeries()ParametersReturnslistRawCalendars()ParametersReturnslistScheduledBots()ParametersReturnsresendFinalWebhook()ParametersReturnsresubscribeCalendar()ParametersReturnsretryCallback()ParametersReturnssyncCalendar()ParametersReturnsupdateCalendarBot()ParametersReturnsupdateCalendarConnection()ParametersReturnsupdateScheduledBot()ParametersReturnsBaasClientVexaMethodsMethodsdeleteMeeting()ParametersReturnsgetApiKey()ReturnsgetBaseUrl()ReturnsgetBotsStatus()ReturnsgetMeetings()ReturnsgetTranscript()ParametersReturnsrequestBot()ParametersReturnssetWebhook()ParametersReturnsstopBot()ParametersReturnsupdateBotConfig()ParametersReturnsupdateMeetingData()ParametersReturns