api.md

RealtimeKit

Apps

Types:

• AppGetResponse
• AppPostResponse

Methods:

• client.realtimeKit.apps.get({ ...params }) -> AppGetResponse
• client.realtimeKit.apps.post({ ...params }) -> AppPostResponse

Meetings

Types:

• MeetingCreateResponse
• MeetingAddParticipantResponse
• MeetingDeleteMeetingParticipantResponse
• MeetingEditParticipantResponse
• MeetingGetResponse
• MeetingGetMeetingByIDResponse
• MeetingGetMeetingParticipantResponse
• MeetingGetMeetingParticipantsResponse
• MeetingRefreshParticipantTokenResponse
• MeetingReplaceMeetingByIDResponse
• MeetingUpdateMeetingByIDResponse

Methods:

• client.realtimeKit.meetings.create(appId, { ...params }) -> MeetingCreateResponse
• client.realtimeKit.meetings.addParticipant(appId, meetingId, { ...params }) -> MeetingAddParticipantResponse
• client.realtimeKit.meetings.deleteMeetingParticipant(appId, meetingId, participantId, { ...params }) -> MeetingDeleteMeetingParticipantResponse
• client.realtimeKit.meetings.editParticipant(appId, meetingId, participantId, { ...params }) -> MeetingEditParticipantResponse
• client.realtimeKit.meetings.get(appId, { ...params }) -> MeetingGetResponse
• client.realtimeKit.meetings.getMeetingById(appId, meetingId, { ...params }) -> MeetingGetMeetingByIDResponse
• client.realtimeKit.meetings.getMeetingParticipant(appId, meetingId, participantId, { ...params }) -> MeetingGetMeetingParticipantResponse
• client.realtimeKit.meetings.getMeetingParticipants(appId, meetingId, { ...params }) -> MeetingGetMeetingParticipantsResponse
• client.realtimeKit.meetings.refreshParticipantToken(appId, meetingId, participantId, { ...params }) -> MeetingRefreshParticipantTokenResponse
• client.realtimeKit.meetings.replaceMeetingById(appId, meetingId, { ...params }) -> MeetingReplaceMeetingByIDResponse
• client.realtimeKit.meetings.updateMeetingById(appId, meetingId, { ...params }) -> MeetingUpdateMeetingByIDResponse

Presets

Types:

• PresetCreateResponse
• PresetUpdateResponse
• PresetDeleteResponse
• PresetGetResponse
• PresetGetPresetByIDResponse

Methods:

• client.realtimeKit.presets.create(appId, { ...params }) -> PresetCreateResponse
• client.realtimeKit.presets.update(appId, presetId, { ...params }) -> PresetUpdateResponse
• client.realtimeKit.presets.delete(appId, presetId, { ...params }) -> PresetDeleteResponse
• client.realtimeKit.presets.get(appId, { ...params }) -> PresetGetResponse
• client.realtimeKit.presets.getPresetById(appId, presetId, { ...params }) -> PresetGetPresetByIDResponse

Sessions

Types:

• SessionGenerateSummaryOfTranscriptsResponse
• SessionGetParticipantDataFromPeerIDResponse
• SessionGetSessionChatResponse
• SessionGetSessionDetailsResponse
• SessionGetSessionParticipantDetailsResponse
• SessionGetSessionParticipantsResponse
• SessionGetSessionSummaryResponse
• SessionGetSessionTranscriptsResponse
• SessionGetSessionsResponse

Methods:

• client.realtimeKit.sessions.generateSummaryOfTranscripts(appId, sessionId, { ...params }) -> SessionGenerateSummaryOfTranscriptsResponse
• client.realtimeKit.sessions.getParticipantDataFromPeerId(appId, peerId, { ...params }) -> SessionGetParticipantDataFromPeerIDResponse
• client.realtimeKit.sessions.getSessionChat(appId, sessionId, { ...params }) -> SessionGetSessionChatResponse
• client.realtimeKit.sessions.getSessionDetails(appId, sessionId, { ...params }) -> SessionGetSessionDetailsResponse
• client.realtimeKit.sessions.getSessionParticipantDetails(appId, sessionId, participantId, { ...params }) -> SessionGetSessionParticipantDetailsResponse
• client.realtimeKit.sessions.getSessionParticipants(appId, sessionId, { ...params }) -> SessionGetSessionParticipantsResponse
• client.realtimeKit.sessions.getSessionSummary(appId, sessionId, { ...params }) -> SessionGetSessionSummaryResponse
• client.realtimeKit.sessions.getSessionTranscripts(appId, sessionId, { ...params }) -> SessionGetSessionTranscriptsResponse
• client.realtimeKit.sessions.getSessions(appId, { ...params }) -> SessionGetSessionsResponse

Recordings

Types:

• RecordingGetActiveRecordingsResponse
• RecordingGetOneRecordingResponse
• RecordingGetRecordingsResponse
• RecordingPauseResumeStopRecordingResponse
• RecordingStartRecordingsResponse
• RecordingStartTrackRecordingResponse

Methods:

• client.realtimeKit.recordings.getActiveRecordings(appId, meetingId, { ...params }) -> RecordingGetActiveRecordingsResponse
• client.realtimeKit.recordings.getOneRecording(appId, recordingId, { ...params }) -> RecordingGetOneRecordingResponse
• client.realtimeKit.recordings.getRecordings(appId, { ...params }) -> RecordingGetRecordingsResponse
• client.realtimeKit.recordings.pauseResumeStopRecording(appId, recordingId, { ...params }) -> RecordingPauseResumeStopRecordingResponse
• client.realtimeKit.recordings.startRecordings(appId, { ...params }) -> RecordingStartRecordingsResponse
• client.realtimeKit.recordings.startTrackRecording(appId, { ...params }) -> RecordingStartTrackRecordingResponse

Webhooks

Types:

• WebhookCreateWebhookResponse
• WebhookDeleteWebhookResponse
• WebhookEditWebhookResponse
• WebhookGetWebhookByIDResponse
• WebhookGetWebhooksResponse
• WebhookReplaceWebhookResponse

Methods:

• client.realtimeKit.webhooks.createWebhook(appId, { ...params }) -> WebhookCreateWebhookResponse
• client.realtimeKit.webhooks.deleteWebhook(appId, webhookId, { ...params }) -> WebhookDeleteWebhookResponse
• client.realtimeKit.webhooks.editWebhook(appId, webhookId, { ...params }) -> WebhookEditWebhookResponse
• client.realtimeKit.webhooks.getWebhookById(appId, webhookId, { ...params }) -> WebhookGetWebhookByIDResponse
• client.realtimeKit.webhooks.getWebhooks(appId, { ...params }) -> WebhookGetWebhooksResponse
• client.realtimeKit.webhooks.replaceWebhook(appId, webhookId, { ...params }) -> WebhookReplaceWebhookResponse

ActiveSession

Types:

• ActiveSessionCreatePollResponse
• ActiveSessionGetActiveSessionResponse
• ActiveSessionKickAllParticipantsResponse
• ActiveSessionKickParticipantsResponse

Methods:

• client.realtimeKit.activeSession.createPoll(appId, meetingId, { ...params }) -> ActiveSessionCreatePollResponse
• client.realtimeKit.activeSession.getActiveSession(appId, meetingId, { ...params }) -> ActiveSessionGetActiveSessionResponse
• client.realtimeKit.activeSession.kickAllParticipants(appId, meetingId, { ...params }) -> ActiveSessionKickAllParticipantsResponse
• client.realtimeKit.activeSession.kickParticipants(appId, meetingId, { ...params }) -> ActiveSessionKickParticipantsResponse

Livestreams

Types:

• LivestreamCreateIndependentLivestreamResponse
• LivestreamGetActiveLivestreamsForLivestreamIDResponse
• LivestreamGetAllLivestreamsResponse
• LivestreamGetLivestreamAnalyticsCompleteResponse
• LivestreamGetLivestreamAnalyticsDaywiseResponse
• LivestreamGetLivestreamSessionDetailsForSessionIDResponse
• LivestreamGetLivestreamSessionForLivestreamIDResponse
• LivestreamGetMeetingActiveLivestreamsResponse
• LivestreamGetOrgAnalyticsResponse
• LivestreamStartLivestreamingAMeetingResponse
• LivestreamStopLivestreamingAMeetingResponse

Methods:

• client.realtimeKit.livestreams.createIndependentLivestream(appId, { ...params }) -> LivestreamCreateIndependentLivestreamResponse
• client.realtimeKit.livestreams.getActiveLivestreamsForLivestreamId(appId, livestreamId, { ...params }) -> LivestreamGetActiveLivestreamsForLivestreamIDResponse
• client.realtimeKit.livestreams.getAllLivestreams(appId, { ...params }) -> LivestreamGetAllLivestreamsResponse
• client.realtimeKit.livestreams.getLivestreamAnalyticsComplete(appId, { ...params }) -> LivestreamGetLivestreamAnalyticsCompleteResponse
• client.realtimeKit.livestreams.getLivestreamAnalyticsDaywise(appId, { ...params }) -> LivestreamGetLivestreamAnalyticsDaywiseResponse
• client.realtimeKit.livestreams.getLivestreamSessionDetailsForSessionId(appId, livestreamSessionId, { ...params }) -> LivestreamGetLivestreamSessionDetailsForSessionIDResponse
• client.realtimeKit.livestreams.getLivestreamSessionForLivestreamId(appId, livestreamId, { ...params }) -> LivestreamGetLivestreamSessionForLivestreamIDResponse
• client.realtimeKit.livestreams.getMeetingActiveLivestreams(appId, meetingId, { ...params }) -> LivestreamGetMeetingActiveLivestreamsResponse
• client.realtimeKit.livestreams.getOrgAnalytics(appId, { ...params }) -> LivestreamGetOrgAnalyticsResponse
• client.realtimeKit.livestreams.startLivestreamingAMeeting(appId, meetingId, { ...params }) -> LivestreamStartLivestreamingAMeetingResponse
• client.realtimeKit.livestreams.stopLivestreamingAMeeting(appId, meetingId, { ...params }) -> LivestreamStopLivestreamingAMeetingResponse

Analytics

Types:

• AnalyticsGetOrgAnalyticsResponse

Methods:

• client.realtimeKit.analytics.getOrgAnalytics(appId, { ...params }) -> AnalyticsGetOrgAnalyticsResponse