zoom-video-sdk-api-wrapper
Version:
A convenient wrapper for the Zoom Video SDK API
612 lines (609 loc) • 24.8 kB
TypeScript
import * as dayjs from 'dayjs';
declare const createZoomVideoSdkApiClient: ({ apiKey, apiSecret, }: {
apiKey: string;
apiSecret: string;
}) => {
deleteSessiion_sRecordingFile: (options: {
sessionId: string;
recordingId: string;
action: "trash" | "delete";
}) => Promise<number>;
deleteSessiion_sRecordings: (options: {
sessionId: string;
action: "trash" | "delete";
}) => Promise<void>;
listRecordingsOfAnAccount: (options: {
from: string;
to: string;
page_size?: number | undefined;
next_page_token?: string | undefined;
trash?: boolean | undefined;
trash_type?: "session_recordings" | "recording_file" | undefined;
}) => Promise<{
sessions?: {
session_id?: string | undefined;
session_name?: string | undefined;
start_time?: string | undefined;
duration?: number | undefined;
total_size?: number | undefined;
recording_count?: number | undefined;
recording_files?: {
id?: string | undefined;
recording_start?: string | undefined;
recording_end?: string | undefined;
file_type?: string | undefined;
file_size?: number | undefined;
download_url?: string | undefined;
status?: string | undefined;
deleted_time?: string | undefined;
recording_type?: string | undefined;
}[] | undefined;
participant_video_files?: {
id?: string | undefined;
recording_start?: string | undefined;
recording_end?: string | undefined;
file_type?: string | undefined;
file_size?: number | undefined;
download_url?: string | undefined;
status?: string | undefined;
recording_type?: string | undefined;
file_name?: string | undefined;
file_extension?: string | undefined;
user_id?: string | undefined;
user_key?: string | undefined;
}[] | undefined;
}[] | undefined;
from?: string | undefined;
to?: string | undefined;
page_size?: number | undefined;
total_records?: number | undefined;
next_page_token?: string | undefined;
}>;
listSession_sRecordings: (options: {
sessionId: string;
include_fields?: string | undefined;
ttl?: number | undefined;
}) => Promise<{
session_id?: string | undefined;
session_name?: string | undefined;
start_time?: string | undefined;
duration?: number | undefined;
total_size?: number | undefined;
recording_count?: number | undefined;
recording_files?: {
id?: string | undefined;
recording_start?: string | undefined;
recording_end?: string | undefined;
file_type?: string | undefined;
file_size?: number | undefined;
download_url?: string | undefined;
status?: string | undefined;
deleted_time?: string | undefined;
recording_type?: string | undefined;
}[] | undefined;
participant_video_files?: {
id?: string | undefined;
recording_start?: string | undefined;
recording_end?: string | undefined;
file_type?: string | undefined;
file_size?: number | undefined;
download_url?: string | undefined;
status?: string | undefined;
recording_type?: string | undefined;
file_name?: string | undefined;
file_extension?: string | undefined;
user_id?: string | undefined;
user_key?: string | undefined;
}[] | undefined;
download_access_token?: string | undefined;
participant_audio_files?: {
id?: string | undefined;
recording_start?: string | undefined;
recording_end?: string | undefined;
file_type?: string | undefined;
file_size?: number | undefined;
download_url?: string | undefined;
status?: string | undefined;
file_name?: string | undefined;
file_extension?: string | undefined;
user_id?: string | undefined;
user_key?: string | undefined;
}[] | undefined;
}>;
recoverASingleRecording: (options: {
sessionId: string;
recordingId: string;
}) => Promise<number>;
recoverSession_sRecordings: (options: {
sessionId: string;
}) => Promise<number>;
getSessionDetails: (options: {
sessionId: string;
type?: "past" | "live" | undefined;
}) => Promise<{
id?: string | undefined;
session_name?: string | undefined;
start_time?: string | undefined;
duration?: string | undefined;
end_time?: string | undefined;
user_count?: number | undefined;
has_voip?: boolean | undefined;
has_video?: boolean | undefined;
has_screen_share?: boolean | undefined;
has_recording?: boolean | undefined;
has_pstn?: boolean | undefined;
session_key?: string | null | undefined;
}>;
getSessionLiveStreamDetails: (options: {
sessionId: string;
}) => Promise<{
stream_url?: string | undefined;
stream_key?: string | undefined;
page_url?: string | undefined;
resolution?: string | undefined;
}>;
getSessionUserQos: (options: {
sessionId: string;
userId: string;
type?: "past" | "live" | undefined;
}) => Promise<{
id?: string | undefined;
name?: string | undefined;
device?: string | undefined;
ip_address?: string | undefined;
location?: string | undefined;
network_type?: string | undefined;
microphone?: string | undefined;
speaker?: string | undefined;
camera?: string | undefined;
data_center?: string | undefined;
connection_type?: string | undefined;
join_time?: string | undefined;
leave_time?: string | undefined;
user_qos?: {
date_time?: string | undefined;
audio_input?: {
bitrate?: string | undefined;
latency?: string | undefined;
jitter?: string | undefined;
avg_loss?: string | undefined;
max_loss?: string | undefined;
} | undefined;
audio_output?: {
bitrate?: string | undefined;
latency?: string | undefined;
jitter?: string | undefined;
avg_loss?: string | undefined;
max_loss?: string | undefined;
} | undefined;
video_input?: {
resolution?: string | undefined;
bitrate?: string | undefined;
latency?: string | undefined;
jitter?: string | undefined;
avg_loss?: string | undefined;
max_loss?: string | undefined;
frame_rate?: string | undefined;
} | undefined;
video_output?: {
resolution?: string | undefined;
bitrate?: string | undefined;
latency?: string | undefined;
jitter?: string | undefined;
avg_loss?: string | undefined;
max_loss?: string | undefined;
frame_rate?: string | undefined;
} | undefined;
as_input?: {
resolution?: string | undefined;
bitrate?: string | undefined;
latency?: string | undefined;
jitter?: string | undefined;
avg_loss?: string | undefined;
max_loss?: string | undefined;
frame_rate?: string | undefined;
} | undefined;
as_output?: {
resolution?: string | undefined;
bitrate?: string | undefined;
latency?: string | undefined;
jitter?: string | undefined;
avg_loss?: string | undefined;
max_loss?: string | undefined;
frame_rate?: string | undefined;
} | undefined;
audio_device_from_rwg?: {
bitrate?: string | undefined;
latency?: string | undefined;
jitter?: string | undefined;
avg_loss?: string | undefined;
max_loss?: string | undefined;
} | undefined;
audio_device_to_rwg?: {
bitrate?: string | undefined;
latency?: string | undefined;
jitter?: string | undefined;
avg_loss?: string | undefined;
max_loss?: string | undefined;
} | undefined;
video_device_from_rwg?: {
resolution?: string | undefined;
bitrate?: string | undefined;
latency?: string | undefined;
jitter?: string | undefined;
avg_loss?: string | undefined;
max_loss?: string | undefined;
frame_rate?: string | undefined;
} | undefined;
video_device_to_rwg?: {
resolution?: string | undefined;
bitrate?: string | undefined;
latency?: string | undefined;
jitter?: string | undefined;
avg_loss?: string | undefined;
max_loss?: string | undefined;
frame_rate?: string | undefined;
} | undefined;
as_device_from_rwg?: {
resolution?: string | undefined;
bitrate?: string | undefined;
latency?: string | undefined;
jitter?: string | undefined;
avg_loss?: string | undefined;
max_loss?: string | undefined;
frame_rate?: string | undefined;
} | undefined;
as_device_to_rwg?: {
resolution?: string | undefined;
bitrate?: string | undefined;
latency?: string | undefined;
jitter?: string | undefined;
avg_loss?: string | undefined;
max_loss?: string | undefined;
frame_rate?: string | undefined;
} | undefined;
cpu_usage?: {
zoom_min_cpu_usage?: string | undefined;
zoom_avg_cpu_usage?: string | undefined;
zoom_max_cpu_usage?: string | undefined;
system_max_cpu_usage?: string | undefined;
} | undefined;
}[] | undefined;
}>;
getSharingRecordingDetails: (options: {
sessionId: string;
type?: "past" | "live" | undefined;
page_size?: number | undefined;
next_page_token?: string | undefined;
}) => Promise<{
page_size?: number | undefined;
next_page_token?: string | undefined;
users?: {
id?: string | undefined;
name?: string | undefined;
details?: {
start_time?: string | undefined;
end_time?: string | undefined;
content?: string | undefined;
}[] | undefined;
}[] | undefined;
}>;
listSessionUsers: (options: {
sessionId: string;
type?: "past" | "live" | undefined;
page_size?: number | undefined;
next_page_token?: string | undefined;
}) => Promise<{
page_size?: number | undefined;
next_page_token?: string | undefined;
users?: {
id?: string | undefined;
user_key?: string | undefined;
name?: string | undefined;
device?: string | undefined;
ip_address?: string | undefined;
location?: string | undefined;
network_type?: string | undefined;
microphone?: string | null | undefined;
speaker?: string | null | undefined;
camera?: string | null | undefined;
data_center?: string | undefined;
connection_type?: string | null | undefined;
join_time?: string | undefined;
leave_time?: string | undefined;
audio_call?: {
call_number?: string | undefined;
call_type?: string | undefined;
zoom_number?: string | undefined;
}[] | undefined;
}[] | undefined;
}>;
listSessionUsersQoS: (options: {
sessionId: string;
type?: "past" | "live" | undefined;
page_size?: number | undefined;
next_page_token?: string | undefined;
}) => Promise<{
page_size?: number | undefined;
next_page_token?: string | undefined;
users?: {
id?: string | undefined;
name?: string | undefined;
device?: string | undefined;
ip_address?: string | undefined;
location?: string | undefined;
network_type?: string | undefined;
microphone?: string | undefined;
speaker?: string | undefined;
camera?: string | undefined;
data_center?: string | undefined;
connection_type?: string | undefined;
join_time?: string | undefined;
leave_time?: string | undefined;
user_qos?: {
date_time?: string | undefined;
audio_input?: {
resolution?: string | undefined;
bitrate?: string | undefined;
latency?: string | undefined;
jitter?: string | undefined;
avg_loss?: string | undefined;
max_loss?: string | undefined;
frame_rate?: string | undefined;
} | undefined;
audio_output?: {
resolution?: string | undefined;
bitrate?: string | undefined;
latency?: string | undefined;
jitter?: string | undefined;
avg_loss?: string | undefined;
max_loss?: string | undefined;
frame_rate?: string | undefined;
} | undefined;
video_input?: {
resolution?: string | undefined;
bitrate?: string | undefined;
latency?: string | undefined;
jitter?: string | undefined;
avg_loss?: string | undefined;
max_loss?: string | undefined;
frame_rate?: string | undefined;
} | undefined;
video_output?: {
resolution?: string | undefined;
bitrate?: string | undefined;
latency?: string | undefined;
jitter?: string | undefined;
avg_loss?: string | undefined;
max_loss?: string | undefined;
frame_rate?: string | undefined;
} | undefined;
as_input?: {
resolution?: string | undefined;
bitrate?: string | undefined;
latency?: string | undefined;
jitter?: string | undefined;
avg_loss?: string | undefined;
max_loss?: string | undefined;
frame_rate?: string | undefined;
} | undefined;
as_output?: {
resolution?: string | undefined;
bitrate?: string | undefined;
latency?: string | undefined;
jitter?: string | undefined;
avg_loss?: string | undefined;
max_loss?: string | undefined;
frame_rate?: string | undefined;
} | undefined;
audio_device_from_rwg?: {
resolution?: string | undefined;
bitrate?: string | undefined;
latency?: string | undefined;
jitter?: string | undefined;
avg_loss?: string | undefined;
max_loss?: string | undefined;
frame_rate?: string | undefined;
} | undefined;
audio_device_to_rwg?: {
resolution?: string | undefined;
bitrate?: string | undefined;
latency?: string | undefined;
jitter?: string | undefined;
avg_loss?: string | undefined;
max_loss?: string | undefined;
frame_rate?: string | undefined;
} | undefined;
video_device_from_rwg?: {
resolution?: string | undefined;
bitrate?: string | undefined;
latency?: string | undefined;
jitter?: string | undefined;
avg_loss?: string | undefined;
max_loss?: string | undefined;
frame_rate?: string | undefined;
} | undefined;
video_device_to_rwg?: {
resolution?: string | undefined;
bitrate?: string | undefined;
latency?: string | undefined;
jitter?: string | undefined;
avg_loss?: string | undefined;
max_loss?: string | undefined;
frame_rate?: string | undefined;
} | undefined;
as_device_from_rwg?: {
resolution?: string | undefined;
bitrate?: string | undefined;
latency?: string | undefined;
jitter?: string | undefined;
avg_loss?: string | undefined;
max_loss?: string | undefined;
frame_rate?: string | undefined;
} | undefined;
as_device_to_rwg?: {
resolution?: string | undefined;
bitrate?: string | undefined;
latency?: string | undefined;
jitter?: string | undefined;
avg_loss?: string | undefined;
max_loss?: string | undefined;
frame_rate?: string | undefined;
} | undefined;
cpu_usage?: {
zoom_min_cpu_usage?: string | undefined;
zoom_avg_cpu_usage?: string | undefined;
zoom_max_cpu_usage?: string | undefined;
system_max_cpu_usage?: string | undefined;
} | undefined;
}[] | undefined;
}[] | undefined;
}>;
listSessions: (options: {
type?: "past" | "live" | undefined;
from: string | number | Date | dayjs.Dayjs;
to: string | number | Date | dayjs.Dayjs;
page_size?: number | undefined;
next_page_token?: string | undefined;
session_key?: string | undefined;
session_name?: string | undefined;
}) => Promise<{
sessions?: {
id?: string | undefined;
session_name?: string | undefined;
start_time?: string | undefined;
duration?: string | undefined;
end_time?: string | undefined;
user_count?: number | undefined;
has_voip?: boolean | undefined;
has_video?: boolean | undefined;
has_screen_share?: boolean | undefined;
has_recording?: boolean | undefined;
has_pstn?: boolean | undefined;
has_session_summary?: boolean | undefined;
}[] | undefined;
from?: string | undefined;
to?: string | undefined;
page_size?: number | undefined;
next_page_token?: string | undefined;
}>;
updateASessionLiveStream: (options: {
sessionId: string;
stream_url: string;
stream_key: string;
page_url: string;
resolution?: "720p" | "1080p" | undefined;
}) => Promise<number>;
updateSessionLivestreamStatus: (options: {
sessionId: string;
action: "start" | "stop" | "mode";
settings?: {
active_speaker_name?: boolean | undefined;
display_name?: string | undefined;
layout?: "gallery_view" | "speaker_view" | undefined;
close_caption?: "burnt-in" | "embedded" | "off" | undefined;
} | undefined;
}) => Promise<number>;
updateSessionStatus: (options: {
sessionId: string;
}) => Promise<number>;
useIn_SessionEventsControls: (options: {
sessionId: string;
method: "recording.start" | "recording.stop" | "recording.pause" | "recording.resume" | "user.invite.callout" | "user.invite.room_system_callout";
params?: {
invitee_name?: string | undefined;
phone_number?: string | undefined;
invite_options?: {
require_greeting?: boolean | undefined;
require_pressing_one?: boolean | undefined;
call_type?: "h323" | "sip" | undefined;
device_ip?: string | undefined;
h323_headers?: {
from_display_name: string;
to_display_name: string;
} | undefined;
sip_headers?: {
from_display_name: string;
to_display_name: string;
from_uri: string;
} | undefined;
additional_headers?: {
key: string;
value: string;
}[] | undefined;
} | undefined;
} | undefined;
}) => Promise<number>;
getCloudRecordingUsageReport: (options: {
from: string;
to: string;
}) => Promise<{
from?: string | undefined;
to?: string | undefined;
cloud_recording_storage?: {
date?: string | undefined;
usage?: string | undefined;
plan_usage?: string | undefined;
free_usage?: string | undefined;
}[] | undefined;
}>;
getDailyUsageReport: (options: {
year: number;
month: number;
}) => Promise<{
year: number;
month: number;
dates: {
sessions: number;
date: string;
users: number;
session_minutes: number;
}[];
}>;
getOperationLogsReport: (options: {
from: string;
to: string;
page_size?: number | undefined;
next_page_token?: string | undefined;
category_type?: "all" | "user" | "user_settings" | "account" | "billing" | "im" | "recording" | "phone_contacts" | "webinar" | "sub_account" | "role" | "zoom_rooms" | undefined;
}) => Promise<{
from?: string | undefined;
to?: string | undefined;
page_size?: number | undefined;
next_page_token?: string | undefined;
operation_logs?: {
time?: string | undefined;
operator?: string | undefined;
category_type?: string | undefined;
action?: string | undefined;
operation_detail?: string | undefined;
}[] | undefined;
}>;
getTelephoneReport: (options: {
from: string;
to: string;
page_size?: number | undefined;
next_page_token?: string | undefined;
type?: 2 | 1 | 3 | undefined;
query_date_type?: "start_time" | "end_time" | "session_start_time" | "session_end_time" | undefined;
}) => Promise<{
from?: string | undefined;
to?: string | undefined;
page_size?: number | undefined;
next_page_token?: string | undefined;
telephony_usage?: {
type?: string | undefined;
session_id?: string | undefined;
start_time?: string | undefined;
duration?: number | undefined;
end_time?: string | undefined;
phone_number?: string | undefined;
signaled_number?: string | undefined;
total?: number | undefined;
country_name?: string | undefined;
call_in_number?: string | undefined;
rate?: number | undefined;
}[] | undefined;
}>;
};
export { createZoomVideoSdkApiClient };