runtime¶

Interfaces¶

ParseZoomWebhookRequestOptions¶

Properties¶

nowSeconds?¶

optional nowSeconds?: number;

requireSignature?¶

optional requireSignature?: boolean;

timestampToleranceSeconds?¶

optional timestampToleranceSeconds?: number;

webhookSecretToken?¶

optional webhookSecretToken?: string;

ValidateZoomWebhookSignatureInput¶

Properties¶

nowSeconds?¶

optional nowSeconds?: number;

rawBody¶

rawBody: string | Buffer<ArrayBufferLike>;

signature¶

signature: string;

timestamp¶

timestamp: string | number;

timestampToleranceSeconds?¶

optional timestampToleranceSeconds?: number;

version?¶

optional version?: "v0";

webhookSecretToken¶

webhookSecretToken: string;

ZoomCreateMeetingInput¶

Properties¶

additionalFields?¶

optional additionalFields?: ZoomVideoProviderExtensionFields;

agenda?¶

optional agenda?: string;

duration?¶

optional duration?: number;

password?¶

optional password?: string;

recurrence?¶

optional recurrence?: ZoomMeetingRecurrence;

scheduleFor?¶

optional scheduleFor?: string;

settings?¶

optional settings?: ZoomVideoJsonObject;

startTime?¶

optional startTime?: string;

templateId?¶

optional templateId?: string;

timezone?¶

optional timezone?: string;

topic?¶

optional topic?: string;

trackingFields?¶

optional trackingFields?: ZoomTrackingField[];

type?¶

optional type?: ZoomMeetingType;

ZoomCredentialStatusInput¶

Properties¶

accessToken?¶

optional accessToken?: string;

expiresAt?¶

optional expiresAt?: string;

providerClientConfigured?¶

optional providerClientConfigured?: boolean;

scopes?¶

optional scopes?: string[];

webhookSecretToken?¶

optional webhookSecretToken?: string;

ZoomDeleteMeetingInput¶

Properties¶

occurrenceId?¶

optional occurrenceId?: string;

scheduleForReminder?¶

optional scheduleForReminder?: boolean;

ZoomGetMeetingInput¶

Properties¶

occurrenceId?¶

optional occurrenceId?: string;

showPreviousOccurrences?¶

optional showPreviousOccurrences?: boolean;

ZoomListMeetingsInput¶

Properties¶

from?¶

optional from?: string;

nextPageToken?¶

optional nextPageToken?: string;

pageNumber?¶

optional pageNumber?: number;

pageSize?¶

optional pageSize?: number;

timezone?¶

optional timezone?: string;

to?¶

optional to?: string;

type?¶

optional type?: ZoomListMeetingType;

ZoomListMeetingsResponse¶

Indexable¶

[key: string]: ZoomVideoProviderExtensionValue

Properties¶

meetings¶

meetings: ZoomMeetingResource[];

next_page_token?¶

optional next_page_token?: string;

page_count?¶

optional page_count?: number;

page_number?¶

optional page_number?: number;

page_size?¶

optional page_size?: number;

total_records?¶

optional total_records?: number;

ZoomLiveCheckOptions¶

Extends¶

ZoomVideoClientOptions

Properties¶

accessToken?¶

optional accessToken?: string;

Inherited from¶

ZoomVideoClientOptions.accessToken

accountId?¶

optional accountId?: string;

Inherited from¶

ZoomVideoClientOptions.accountId

baseUrl?¶

optional baseUrl?: string;

Inherited from¶

ZoomVideoClientOptions.baseUrl

client?¶

optional client?: Pick<ZoomVideoClient, "getCurrentUser">;

clientId?¶

optional clientId?: string;

Inherited from¶

ZoomVideoClientOptions.clientId

clientSecret?¶

optional clientSecret?: string;

Inherited from¶

ZoomVideoClientOptions.clientSecret

fetch?¶

optional fetch?: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`URL` \| `RequestInfo`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`string` \| `Request` \| `URL`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

Inherited from¶

ZoomVideoClientOptions.fetch

getAccessToken?¶

optional getAccessToken?: () => string | Promise<string>;

Returns¶

string | Promise\<string>

Inherited from¶

ZoomVideoClientOptions.getAccessToken

oauthBaseUrl?¶

optional oauthBaseUrl?: string;

Inherited from¶

ZoomVideoClientOptions.oauthBaseUrl

providerClient?¶

optional providerClient?: ZoomVideoProviderClient;

Inherited from¶

ZoomVideoClientOptions.providerClient

retry?¶

optional retry?:
  | number
  | ZoomProviderJsonRetryOptions;

Inherited from¶

ZoomVideoClientOptions.retry

signal?¶

optional signal?: AbortSignal;

Inherited from¶

ZoomVideoClientOptions.signal

timeoutMs?¶

optional timeoutMs?: number;

Inherited from¶

ZoomVideoClientOptions.timeoutMs

userId?¶

optional userId?: string | number;

Inherited from¶

ZoomVideoClientOptions.userId

ZoomMeetingRecurrence¶

Properties¶

end_date_time?¶

optional end_date_time?: string;

end_times?¶

optional end_times?: number;

monthly_day?¶

optional monthly_day?: number;

monthly_week?¶

optional monthly_week?: ZoomMonthlyWeek;

monthly_week_day?¶

optional monthly_week_day?: ZoomWeekday;

repeat_interval?¶

optional repeat_interval?: number;

type¶

type: ZoomRecurrenceType;

weekly_days?¶

optional weekly_days?: string;

ZoomMeetingResource¶

Indexable¶

[key: string]: ZoomVideoProviderExtensionValue

Properties¶

agenda?¶

optional agenda?: string;

duration?¶

optional duration?: number;

host_email?¶

optional host_email?: string;

host_id?¶

optional host_id?: string;

id?¶

optional id?: string | number;

join_url?¶

optional join_url?: string;

password?¶

optional password?: string;

settings?¶

optional settings?: ZoomVideoJsonObject;

start_time?¶

optional start_time?: string;

start_url?¶

optional start_url?: string;

status?¶

optional status?: ZoomMeetingStatus;

timezone?¶

optional timezone?: string;

topic?¶

optional topic?: string;

type?¶

optional type?: ZoomMeetingType;

uuid?¶

optional uuid?: string;

ZoomMeetingsApiGeneratedClient¶

Extends¶

ZoomMeetingsApiArchivingGeneratedClient.ZoomMeetingsApiCloudRecordingGeneratedClient.ZoomMeetingsApiDevicesGeneratedClient.ZoomMeetingsApiH323DevicesGeneratedClient.ZoomMeetingsApiInMeetingAppsGeneratedClient.ZoomMeetingsApiInMeetingFeaturesGeneratedClient.ZoomMeetingsApiInvitationRegistrationGeneratedClient.ZoomMeetingsApiLiveStreamingGeneratedClient.ZoomMeetingsApiMeetingsGeneratedClient.ZoomMeetingsApiPACGeneratedClient.ZoomMeetingsApiPollsGeneratedClient.ZoomMeetingsApiReportsGeneratedClient.ZoomMeetingsApiSIPPhoneGeneratedClient.ZoomMeetingsApiSummariesGeneratedClient.ZoomMeetingsApiSurveysGeneratedClient.ZoomMeetingsApiTemplatesGeneratedClient.ZoomMeetingsApiTrackingFieldGeneratedClient.ZoomMeetingsApiTSPGeneratedClient.ZoomMeetingsApiWebinarsGeneratedClient

Methods¶

AddBatchRegistrants()¶

AddBatchRegistrants(...args): Promise<{
  registrants?: readonly {
     email?: string;
     join_url?: string;
     participant_pin_code?: number;
     registrant_id?: string;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /meetings/{meetingId}/batch_registrants"`>]

Returns¶

Promise\<{ registrants?: readonly { email?: string; join_url?: string; participant_pin_code?: number; registrant_id?: string; }[]; }>

Inherited from¶

ZoomMeetingsApiInvitationRegistrationGeneratedClient.AddBatchRegistrants

AddBatchWebinarRegistrants()¶

AddBatchWebinarRegistrants(...args): Promise<{
  registrants?: readonly {
     email?: string;
     join_url?: string;
     registrant_id?: string;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /webinars/{webinarId}/batch_registrants"`>]

Returns¶

Promise\<{ registrants?: readonly { email?: string; join_url?: string; registrant_id?: string; }[]; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.AddBatchWebinarRegistrants

AddDevice()¶

AddDevice(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /devices"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiDevicesGeneratedClient.AddDevice

AnalyticsDetails()¶

AnalyticsDetails(...args): Promise<{
  analytics_details?: readonly {
     date_time?: string;
     duration?: number;
     email?: string;
     name?: string;
  }[];
  from?: string;
  next_page_token?: string;
  page_size?: number;
  to?: string;
  total_records?: number;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /meetings/{meetingId}/recordings/analytics_details"`>]

Returns¶

Promise\<{ analytics_details?: readonly { date_time?: string; duration?: number; email?: string; name?: string; }[]; from?: string; next_page_token?: string; page_size?: number; to?: string; total_records?: number; }>

Inherited from¶

ZoomMeetingsApiCloudRecordingGeneratedClient.AnalyticsDetails

AnalyticsSummary()¶

AnalyticsSummary(...args): Promise<{
  analytics_summary?: readonly {
     date?: string;
     downloads_total_count?: number;
     views_total_count?: number;
  }[];
  from?: string;
  to?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /meetings/{meetingId}/recordings/analytics_summary"`>]

Returns¶

Promise\<{ analytics_summary?: readonly { date?: string; downloads_total_count?: number; views_total_count?: number; }[]; from?: string; to?: string; }>

Inherited from¶

ZoomMeetingsApiCloudRecordingGeneratedClient.AnalyticsSummary

AssginGroup()¶

AssginGroup(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PATCH /devices/{deviceId}/assign_group"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiDevicesGeneratedClient.AssginGroup

AssigndevicetoauserCommonarea()¶

AssigndevicetoauserCommonarea(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /devices/zpa/assignment"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiDevicesGeneratedClient.AssigndevicetoauserCommonarea

ChangeDeviceAssociation()¶

ChangeDeviceAssociation(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PATCH /devices/{deviceId}/assignment"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiDevicesGeneratedClient.ChangeDeviceAssociation

CreateBatchPolls()¶

CreateBatchPolls(...args): Promise<{
  polls?: readonly {
     anonymous?: boolean;
     id?: string;
     poll_type?: 1 | 2 | 3;
     questions?: readonly {
        answer_max_character?: number;
        answer_min_character?: number;
        answer_required?: boolean;
        answers?: readonly string[];
        case_sensitive?: boolean;
        name?: string;
        prompts?: readonly {
           prompt_question?: string;
           prompt_right_answers?: readonly string[];
        }[];
        rating_max_label?: string;
        rating_max_value?: number;
        rating_min_label?: string;
        rating_min_value?: number;
        right_answers?: readonly string[];
        show_as_dropdown?: boolean;
        type?:   | "single"
           | "multiple"
           | "matching"
           | "rank_order"
           | "short_answer"
           | "long_answer"
           | "fill_in_the_blank"
           | "rating_scale";
     }[];
     status?: "started" | "ended" | "notstart" | "sharing";
     title?: string;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /meetings/{meetingId}/batch_polls"`>]

Returns¶

Promise\<{ polls?: readonly { anonymous?: boolean; id?: string; poll_type?: 1 | 2 | 3; questions?: readonly { answer_max_character?: number; answer_min_character?: number; answer_required?: boolean; answers?: readonly string[]; case_sensitive?: boolean; name?: string; prompts?: readonly { prompt_question?: string; prompt_right_answers?: readonly string[]; }[]; rating_max_label?: string; rating_max_value?: number; rating_min_label?: string; rating_min_value?: number; right_answers?: readonly string[]; show_as_dropdown?: boolean; type?: | "single" | "multiple" | "matching" | "rank_order" | "short_answer" | "long_answer" | "fill_in_the_blank" | "rating_scale"; }[]; status?: "started" | "ended" | "notstart" | "sharing"; title?: string; }[]; }>

Inherited from¶

ZoomMeetingsApiPollsGeneratedClient.CreateBatchPolls

CreateWebinarBrandingNameTag()¶

CreateWebinarBrandingNameTag(...args): Promise<{
  accent_color?: string;
  background_color?: string;
  id?: string;
  is_default?: boolean;
  name?: string;
  text_color?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /webinars/{webinarId}/branding/name_tags"`>]

Returns¶

Promise\<{ accent_color?: string; background_color?: string; id?: string; is_default?: boolean; name?: string; text_color?: string; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.CreateWebinarBrandingNameTag

DeleteArchivedFiles()¶

DeleteArchivedFiles(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"DELETE /past_meetings/{meetingUUID}/archive_files"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiArchivingGeneratedClient.DeleteArchivedFiles

DeleteDevice()¶

DeleteDevice(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"DELETE /devices/{deviceId}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiDevicesGeneratedClient.DeleteDevice

DeleteMeetingChatMessageById()¶

DeleteMeetingChatMessageById(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"DELETE /live_meetings/{meetingId}/chat/messages/{messageId}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiInMeetingFeaturesGeneratedClient.DeleteMeetingChatMessageById

Deletemeetingorwebinarsummary()¶

Deletemeetingorwebinarsummary(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"DELETE /meetings/{meetingId}/meeting_summary"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiSummariesGeneratedClient.Deletemeetingorwebinarsummary

DeleteMeetingTranscript()¶

DeleteMeetingTranscript(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"DELETE /meetings/{meetingId}/transcript"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiCloudRecordingGeneratedClient.DeleteMeetingTranscript

DeleteSIPPhonePhones()¶

DeleteSIPPhonePhones(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"DELETE /sip_phones/phones/{phoneId}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiSIPPhoneGeneratedClient.DeleteSIPPhonePhones

DeleteWebinarBrandingNameTag()¶

DeleteWebinarBrandingNameTag(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"DELETE /webinars/{webinarId}/branding/name_tags"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.DeleteWebinarBrandingNameTag

DeleteWebinarBrandingVB()¶

DeleteWebinarBrandingVB(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"DELETE /webinars/{webinarId}/branding/virtual_backgrounds"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.DeleteWebinarBrandingVB

DeleteWebinarBrandingWallpaper()¶

DeleteWebinarBrandingWallpaper(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"DELETE /webinars/{webinarId}/branding/wallpaper"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.DeleteWebinarBrandingWallpaper

DeleteWebinarChatMessageById()¶

DeleteWebinarChatMessageById(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"DELETE /live_webinars/{webinarId}/chat/messages/{messageId}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.DeleteWebinarChatMessageById

DeleteWebinarRegistrant()¶

DeleteWebinarRegistrant(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"DELETE /webinars/{webinarId}/registrants/{registrantId}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.DeleteWebinarRegistrant

DeleteZpaDeviceByVendorAndMacAddress()¶

DeleteZpaDeviceByVendorAndMacAddress(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"DELETE /devices/zpa/vendors/{vendor}/mac_addresses/{macAddress}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiDevicesGeneratedClient.DeleteZpaDeviceByVendorAndMacAddress

DeviceCreate()¶

DeviceCreate(...args): Promise<{
  id?: string;
} & {
  encryption: "auto" | "yes" | "no";
  ip: string;
  name: string;
  protocol: "H.323" | "SIP";
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /h323/devices"`>]

Returns¶

Promise\<{ id?: string; } & { encryption: "auto" | "yes" | "no"; ip: string; name: string; protocol: "H.323" | "SIP"; }>

Inherited from¶

ZoomMeetingsApiH323DevicesGeneratedClient.DeviceCreate

DeviceDelete()¶

DeviceDelete(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"DELETE /h323/devices/{deviceId}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiH323DevicesGeneratedClient.DeviceDelete

DeviceList()¶

DeviceList(...args): Promise<{
  next_page_token?: string;
  page_count?: number;
  page_number?: number;
  page_size?: number;
  total_records?: number;
} & {
  devices?: readonly {
     id?: string;
   } & {
     encryption: "auto" | "yes" | "no";
     ip: string;
     name: string;
     protocol: "H.323" | "SIP";
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /h323/devices"`>]

Returns¶

Promise\<{ next_page_token?: string; page_count?: number; page_number?: number; page_size?: number; total_records?: number; } & { devices?: readonly { id?: string; } & { encryption: "auto" | "yes" | "no"; ip: string; name: string; protocol: "H.323" | "SIP"; }[]; }>

Inherited from¶

ZoomMeetingsApiH323DevicesGeneratedClient.DeviceList

DeviceUpdate()¶

DeviceUpdate(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PATCH /h323/devices/{deviceId}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiH323DevicesGeneratedClient.DeviceUpdate

EnableSIPPhonePhones()¶

EnableSIPPhonePhones(...args): Promise<{
  authorization_name?: string;
  display_number?: string;
  domain?: string;
  password?: string;
  phone_id?: string;
  registration_expire_time?: number;
  server?: {
     proxy_server?: string;
     register_server?: string;
     transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
  };
  server_2?: {
     proxy_server?: string;
     register_server?: string;
     transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
  };
  server_3?: {
     proxy_server?: string;
     register_server?: string;
     transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
  };
  user_email?: string;
  user_name?: string;
  voice_mail?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /sip_phones/phones"`>]

Returns¶

Promise\<{ authorization_name?: string; display_number?: string; domain?: string; password?: string; phone_id?: string; registration_expire_time?: number; server?: { proxy_server?: string; register_server?: string; transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO"; }; server_2?: { proxy_server?: string; register_server?: string; transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO"; }; server_3?: { proxy_server?: string; register_server?: string; transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO"; }; user_email?: string; user_name?: string; voice_mail?: string; }>

Inherited from¶

ZoomMeetingsApiSIPPhoneGeneratedClient.EnableSIPPhonePhones

Getameetingsummary()¶

Getameetingsummary(...args): Promise<{
  edited_summary?: {
     next_steps?: readonly string[];
     summary_details?: string;
     summary_overview?: string;
  };
  meeting_end_time?: string;
  meeting_host_email?: string;
  meeting_host_id?: string;
  meeting_id?: number;
  meeting_start_time?: string;
  meeting_topic?: string;
  meeting_uuid?: string;
  next_steps?: readonly string[];
  summary_content?: string;
  summary_created_time?: string;
  summary_details?: readonly {
     label?: string;
     summary?: string;
  }[];
  summary_doc_url?: string;
  summary_end_time?: string;
  summary_last_modified_time?: string;
  summary_last_modified_user_email?: string;
  summary_last_modified_user_id?: string;
  summary_overview?: string;
  summary_start_time?: string;
  summary_title?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /meetings/{meetingId}/meeting_summary"`>]

Returns¶

Promise\<{ edited_summary?: { next_steps?: readonly string[]; summary_details?: string; summary_overview?: string; }; meeting_end_time?: string; meeting_host_email?: string; meeting_host_id?: string; meeting_id?: number; meeting_start_time?: string; meeting_topic?: string; meeting_uuid?: string; next_steps?: readonly string[]; summary_content?: string; summary_created_time?: string; summary_details?: readonly { label?: string; summary?: string; }[]; summary_doc_url?: string; summary_end_time?: string; summary_last_modified_time?: string; summary_last_modified_user_email?: string; summary_last_modified_user_id?: string; summary_overview?: string; summary_start_time?: string; summary_title?: string; }>

Inherited from¶

ZoomMeetingsApiSummariesGeneratedClient.Getameetingsummary

GetArchivedFiles()¶

GetArchivedFiles(...args): Promise<{
  account_name: string;
  archive_files: readonly {
     auto_delete?: boolean;
     download_url: string;
     encryption_fingerprint: string;
     file_extension: string;
     file_path?: string;
     file_size: number;
     file_type:   | "MP4"
        | "M4A"
        | "CHAT"
        | "CC"
        | "CHAT_MESSAGE"
        | "TRANSCRIPT"
        | "SUB_GROUP_MEMBER_LOG"
        | "AIC_COVERSATION";
     id: string;
     individual: boolean;
     number_of_messages?: number;
     participant_email?: string;
     participant_join_time: string;
     participant_leave_time: string;
     recording_type:   | "shared_screen_with_speaker_view"
        | "audio_only"
        | "chat_file"
        | "closed_caption"
        | "chat_message"
        | "audio_transcript"
        | "aic_conversation";
     status: "failed" | "completed" | "processing";
     storage_location?: "US" | "AU" | "BR" | "CA" | "EU" | "IN" | "JP" | "SG" | "CH";
  }[];
  complete_time:   | {
   }
     | "";
  duration: number;
  duration_in_second: number;
  group_id?: string;
  host_id: string;
  id: number;
  is_breakout_room: boolean;
  meeting_type: "internal" | "external";
  parent_meeting_id?: string;
  physical_files?: readonly {
     download_url?: string;
     file_id?: string;
     file_name?: string;
     file_size?: number;
  }[];
  recording_count: number;
  start_time: string;
  status: "completed" | "processing";
  timezone: string;
  topic: string;
  total_size: number;
  type: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 100;
  uuid: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /past_meetings/{meetingUUID}/archive_files"`>]

Returns¶

Promise\<{ account_name: string; archive_files: readonly { auto_delete?: boolean; download_url: string; encryption_fingerprint: string; file_extension: string; file_path?: string; file_size: number; file_type: | "MP4" | "M4A" | "CHAT" | "CC" | "CHAT_MESSAGE" | "TRANSCRIPT" | "SUB_GROUP_MEMBER_LOG" | "AIC_COVERSATION"; id: string; individual: boolean; number_of_messages?: number; participant_email?: string; participant_join_time: string; participant_leave_time: string; recording_type: | "shared_screen_with_speaker_view" | "audio_only" | "chat_file" | "closed_caption" | "chat_message" | "audio_transcript" | "aic_conversation"; status: "failed" | "completed" | "processing"; storage_location?: "US" | "AU" | "BR" | "CA" | "EU" | "IN" | "JP" | "SG" | "CH"; }[]; complete_time: | { } | ""; duration: number; duration_in_second: number; group_id?: string; host_id: string; id: number; is_breakout_room: boolean; meeting_type: "internal" | "external"; parent_meeting_id?: string; physical_files?: readonly { download_url?: string; file_id?: string; file_name?: string; file_size?: number; }[]; recording_count: number; start_time: string; status: "completed" | "processing"; timezone: string; topic: string; total_size: number; type: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 100; uuid: string; }>

Inherited from¶

ZoomMeetingsApiArchivingGeneratedClient.GetArchivedFiles

GetArchivedFileStatistics()¶

GetArchivedFileStatistics(...args): Promise<{
  from?: string;
  statistic_by_file_extension?: {
     json_file_count?: number;
     m4a_file_count?: number;
     mp4_file_count?: number;
     txt_file_count?: number;
     vtt_file_count?: number;
  };
  statistic_by_file_status?: {
     completed_file_count?: number;
     failed_file_count?: number;
     processing_file_count?: number;
  };
  to?: string;
  total_records?: number;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /archive_files/statistics"`>]

Returns¶

Promise\<{ from?: string; statistic_by_file_extension?: { json_file_count?: number; m4a_file_count?: number; mp4_file_count?: number; txt_file_count?: number; vtt_file_count?: number; }; statistic_by_file_status?: { completed_file_count?: number; failed_file_count?: number; processing_file_count?: number; }; to?: string; total_records?: number; }>

Inherited from¶

ZoomMeetingsApiArchivingGeneratedClient.GetArchivedFileStatistics

GetBillingInvoicesReports()¶

GetBillingInvoicesReports(...args): Promise<{
  currency?: string;
  invoices?: readonly {
     end_date?: string;
     invoice_charge_name?: string;
     invoice_number?: string;
     quantity?: number;
     start_date?: string;
     tax_amount?: string;
     total_amount?: string;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /report/billing/invoices"`>]

Returns¶

Promise\<{ currency?: string; invoices?: readonly { end_date?: string; invoice_charge_name?: string; invoice_number?: string; quantity?: number; start_date?: string; tax_amount?: string; total_amount?: string; }[]; }>

Inherited from¶

ZoomMeetingsApiReportsGeneratedClient.GetBillingInvoicesReports

GetBillingReport()¶

GetBillingReport(...args): Promise<{
  billing_reports?: readonly {
     end_date?: string;
     id?: string;
     start_date?: string;
     tax_amount?: string;
     total_amount?: string;
     type?: 0 | 1;
  }[];
  currency?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /report/billing"`>]

Returns¶

Promise\<{ billing_reports?: readonly { end_date?: string; id?: string; start_date?: string; tax_amount?: string; total_amount?: string; type?: 0 | 1; }[]; currency?: string; }>

Inherited from¶

ZoomMeetingsApiReportsGeneratedClient.GetBillingReport

GetDevice()¶

GetDevice(...args): Promise<{
  app_version?: string;
  connected_to_zdm?: boolean;
  device_id?: string;
  device_name?: string;
  device_status?: -1 | 0 | 1;
  device_type?: 0 | 1 | 2 | 3 | 4 | 5 | 6;
  enrolled_in_zdm?: boolean;
  last_online?: string;
  mac_address?: string;
  model?: string;
  platform_os?: string;
  room_id?: string;
  room_name?: string;
  sdk_version?: string;
  serial_number?: string;
  tag?: string;
  user_email?: string;
  vendor?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /devices/{deviceId}"`>]

Returns¶

Promise\<{ app_version?: string; connected_to_zdm?: boolean; device_id?: string; device_name?: string; device_status?: -1 | 0 | 1; device_type?: 0 | 1 | 2 | 3 | 4 | 5 | 6; enrolled_in_zdm?: boolean; last_online?: string; mac_address?: string; model?: string; platform_os?: string; room_id?: string; room_name?: string; sdk_version?: string; serial_number?: string; tag?: string; user_email?: string; vendor?: string; }>

Inherited from¶

ZoomMeetingsApiDevicesGeneratedClient.GetDevice

Getdisclaimerreport()¶

Getdisclaimerreport(...args): Promise<{
  disclaimer_records?: readonly {
     client_type?: string;
     disclaimer_status?: "Agree" | "Cancel" | "Passive Agree" | "Decline Attend";
     disclaimer_type?: string;
     display_name?: string;
     group_ids?: readonly string[];
     is_guest?: boolean;
     is_zoom_event?: boolean;
     meeting_id?: string;
     meeting_number?: number;
     time?: string;
     user_email?: string;
  }[];
  next_page_token?: string;
  page_size?: number;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /report/disclaimer"`>]

Returns¶

Promise\<{ disclaimer_records?: readonly { client_type?: string; disclaimer_status?: "Agree" | "Cancel" | "Passive Agree" | "Decline Attend"; disclaimer_type?: string; display_name?: string; group_ids?: readonly string[]; is_guest?: boolean; is_zoom_event?: boolean; meeting_id?: string; meeting_number?: number; time?: string; user_email?: string; }[]; next_page_token?: string; page_size?: number; }>

Inherited from¶

ZoomMeetingsApiReportsGeneratedClient.Getdisclaimerreport

Gethistorymeetingandwebinarlist()¶

Gethistorymeetingandwebinarlist(...args): Promise<{
  history_meetings?: readonly {
     create_time?: string;
     custom_fields?: readonly {
        key?: string;
        value?: string;
     }[];
     department?: string;
     duration?: number;
     end_time?: string;
     feature_used?: {
        annotation?: boolean;
        avatar?: boolean;
        breakout_room?: boolean;
        closed_caption?: boolean;
        color_themes?: boolean;
        document_collaboration?: boolean;
        file_sharing?: boolean;
        gen_ai_virtual_background?: boolean;
        immersive_scene?: boolean;
        in_meeting_chat?: boolean;
        join_by_room?: boolean;
        language_interpretation?: boolean;
        live_transcription?: boolean;
        live_translation?: boolean;
        meeting_questions?: boolean;
        meeting_summary?: boolean;
        meeting_wallpaper?: boolean;
        multi_share?: boolean;
        multi_speaker?: boolean;
        personalized_audio_isolation?: boolean;
        poll?: boolean;
        portrait_lighting?: boolean;
        raise_hand?: boolean;
        reaction?: boolean;
        record_to_cloud?: boolean;
        record_to_computer?: boolean;
        registration?: boolean;
        remote_control?: boolean;
        screen_sharing?: boolean;
        smart_recording?: boolean;
        switch_to_mobile?: boolean;
        telephone_usage?: boolean;
        video_on?: boolean;
        virtual_background?: boolean;
        waiting_room?: boolean;
        whiteboard?: boolean;
        zoom_apps?: boolean;
     };
     group?: readonly string[];
     host_display_name?: string;
     host_email?: string;
     max_concurrent_views?: number;
     meeting_id?: number;
     meeting_uuid?: string;
     participants?: number;
     source?: string;
     start_time?: string;
     topic?: string;
     total_participant_minutes?: number;
     tracking_fields?: readonly {
        field?: string;
        value?: string;
     }[];
     type?: "Meeting" | "Webinar";
     unique_viewers?: number;
  }[];
  next_page_token?: string;
  page_size?: number;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /report/history_meetings"`>]

Returns¶

Promise\<{ history_meetings?: readonly { create_time?: string; custom_fields?: readonly { key?: string; value?: string; }[]; department?: string; duration?: number; end_time?: string; feature_used?: { annotation?: boolean; avatar?: boolean; breakout_room?: boolean; closed_caption?: boolean; color_themes?: boolean; document_collaboration?: boolean; file_sharing?: boolean; gen_ai_virtual_background?: boolean; immersive_scene?: boolean; in_meeting_chat?: boolean; join_by_room?: boolean; language_interpretation?: boolean; live_transcription?: boolean; live_translation?: boolean; meeting_questions?: boolean; meeting_summary?: boolean; meeting_wallpaper?: boolean; multi_share?: boolean; multi_speaker?: boolean; personalized_audio_isolation?: boolean; poll?: boolean; portrait_lighting?: boolean; raise_hand?: boolean; reaction?: boolean; record_to_cloud?: boolean; record_to_computer?: boolean; registration?: boolean; remote_control?: boolean; screen_sharing?: boolean; smart_recording?: boolean; switch_to_mobile?: boolean; telephone_usage?: boolean; video_on?: boolean; virtual_background?: boolean; waiting_room?: boolean; whiteboard?: boolean; zoom_apps?: boolean; }; group?: readonly string[]; host_display_name?: string; host_email?: string; max_concurrent_views?: number; meeting_id?: number; meeting_uuid?: string; participants?: number; source?: string; start_time?: string; topic?: string; total_participant_minutes?: number; tracking_fields?: readonly { field?: string; value?: string; }[]; type?: "Meeting" | "Webinar"; unique_viewers?: number; }[]; next_page_token?: string; page_size?: number; }>

Inherited from¶

ZoomMeetingsApiReportsGeneratedClient.Gethistorymeetingandwebinarlist

GetMeetingLiveStreamDetails()¶

GetMeetingLiveStreamDetails(...args): Promise<{
  page_url?: string;
  resolution?: string;
  stream_key?: string;
  stream_url?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /meetings/{meetingId}/livestream"`>]

Returns¶

Promise\<{ page_url?: string; resolution?: string; stream_key?: string; stream_url?: string; }>

Inherited from¶

ZoomMeetingsApiLiveStreamingGeneratedClient.GetMeetingLiveStreamDetails

GetMeetingTranscript()¶

GetMeetingTranscript(...args): Promise<{
  account_id?: string;
  auto_delete?: boolean;
  auto_delete_date?: string;
  can_download?: boolean;
  download_restriction_reason?:   | "DELETED_OR_TRASHED"
     | "UNSUPPORTED"
     | "NO_TRANSCRIPT_DATA"
     | "NOT_READY";
  download_url?: string;
  host_id?: string;
  meeting_id?: string;
  meeting_topic?: string;
  transcript_created_time?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /meetings/{meetingId}/transcript"`>]

Returns¶

Promise\<{ account_id?: string; auto_delete?: boolean; auto_delete_date?: string; can_download?: boolean; download_restriction_reason?: | "DELETED_OR_TRASHED" | "UNSUPPORTED" | "NO_TRANSCRIPT_DATA" | "NOT_READY"; download_url?: string; host_id?: string; meeting_id?: string; meeting_topic?: string; transcript_created_time?: string; }>

Inherited from¶

ZoomMeetingsApiCloudRecordingGeneratedClient.GetMeetingTranscript

Getremotesupportreport()¶

Getremotesupportreport(...args): Promise<{
  next_page_token?: string;
  page_size?: number;
  remote_support_logs?: readonly {
     duration?: string;
     end_time?: string;
     meeting_host_id?: string;
     meeting_number?: number;
     meeting_start_time?: string;
     meeting_uuid?: string;
     request_time?: string;
     start_time?: string;
     supportee_email?: string;
     supportee_name?: string;
     supporter_email?: string;
     supporter_name?: string;
     topic?: string;
     wait_time?: string;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /report/remote_support"`>]

Returns¶

Promise\<{ next_page_token?: string; page_size?: number; remote_support_logs?: readonly { duration?: string; end_time?: string; meeting_host_id?: string; meeting_number?: number; meeting_start_time?: string; meeting_uuid?: string; request_time?: string; start_time?: string; supportee_email?: string; supportee_name?: string; supporter_email?: string; supporter_name?: string; topic?: string; wait_time?: string; }[]; }>

Inherited from¶

ZoomMeetingsApiReportsGeneratedClient.Getremotesupportreport

GetSipDialingWithPasscode()¶

GetSipDialingWithPasscode(...args): Promise<{
  expire_in?: number;
  paid_crc_plan_participant?: boolean;
  participant_identifier_code?: string;
  sip_dialing?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /meetings/{meetingId}/sip_dialing"`>]

Returns¶

Promise\<{ expire_in?: number; paid_crc_plan_participant?: boolean; participant_identifier_code?: string; sip_dialing?: string; }>

Inherited from¶

ZoomMeetingsApiMeetingsGeneratedClient.GetSipDialingWithPasscode

GetTrackingSources()¶

GetTrackingSources(...args): Promise<{
  total_records?: number;
  tracking_sources?: readonly {
     id?: string;
     registration_count?: number;
     source_name?: string;
     tracking_url?: string;
     visitor_count?: number;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /webinars/{webinarId}/tracking_sources"`>]

Returns¶

Promise\<{ total_records?: number; tracking_sources?: readonly { id?: string; registration_count?: number; source_name?: string; tracking_url?: string; visitor_count?: number; }[]; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.GetTrackingSources

GetWebinarBranding()¶

GetWebinarBranding(...args): Promise<{
  name_tags?: readonly {
     accent_color?: string;
     background_color?: string;
     id?: string;
     is_default?: boolean;
     name?: string;
     text_color?: string;
  }[];
  virtual_backgrounds?: readonly {
     id?: string;
     is_default?: boolean;
     name?: string;
  }[];
  wallpaper?: {
     id?: string;
  };
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /webinars/{webinarId}/branding"`>]

Returns¶

Promise\<{ name_tags?: readonly { accent_color?: string; background_color?: string; id?: string; is_default?: boolean; name?: string; text_color?: string; }[]; virtual_backgrounds?: readonly { id?: string; is_default?: boolean; name?: string; }[]; wallpaper?: { id?: string; }; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.GetWebinarBranding

GetWebinarLiveStreamDetails()¶

GetWebinarLiveStreamDetails(...args): Promise<{
  page_url?: string;
  resolution?: string;
  stream_key?: string;
  stream_url?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /webinars/{webinarId}/livestream"`>]

Returns¶

Promise\<{ page_url?: string; resolution?: string; stream_key?: string; stream_url?: string; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.GetWebinarLiveStreamDetails

GetWebinarSipDialingWithPasscode()¶

GetWebinarSipDialingWithPasscode(...args): Promise<{
  expire_in?: number;
  paid_crc_plan_participant?: boolean;
  participant_identifier_code?: string;
  sip_dialing?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /webinars/{webinarId}/sip_dialing"`>]

Returns¶

Promise\<{ expire_in?: number; paid_crc_plan_participant?: boolean; participant_identifier_code?: string; sip_dialing?: string; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.GetWebinarSipDialingWithPasscode

Getzdmgroupinfo()¶

Getzdmgroupinfo(...args): Promise<{
  groups?: readonly {
     description?: string;
     name?: string;
     zdm_group_id?: string;
  }[];
  next_page_token?: string;
  page_size?: number;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /devices/groups"`>]

Returns¶

Promise\<{ groups?: readonly { description?: string; name?: string; zdm_group_id?: string; }[]; next_page_token?: string; page_size?: number; }>

Inherited from¶

ZoomMeetingsApiDevicesGeneratedClient.Getzdmgroupinfo

GetZpaDeviceListProfileSettingOfaUser()¶

GetZpaDeviceListProfileSettingOfaUser(...args): Promise<{
  device_infos?: readonly {
     device_id?: string;
     device_type?: string;
     model?: string;
     policy?: {
        call_control?: {
           status?: "unsupported" | "on" | "off";
        };
        hot_desking?: {
           status?: "online" | "offline";
        };
     };
     status?: "online" | "offline";
     vendor?: string;
  }[];
  language?: string;
  timezone?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /devices/zpa/settings"`>]

Returns¶

Promise\<{ device_infos?: readonly { device_id?: string; device_type?: string; model?: string; policy?: { call_control?: { status?: "unsupported" | "on" | "off"; }; hot_desking?: { status?: "online" | "offline"; }; }; status?: "online" | "offline"; vendor?: string; }[]; language?: string; timezone?: string; }>

Inherited from¶

ZoomMeetingsApiDevicesGeneratedClient.GetZpaDeviceListProfileSettingOfaUser

GetZpaVersioninfo()¶

GetZpaVersioninfo(...args): Promise<{
  app_versions?: readonly string[];
  firmware_versions?: readonly {
     model?: string;
     vendor?: string;
     version?: string;
     warn_info?: string;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /devices/zpa/zdm_groups/{zdmGroupId}/versions"`>]

Returns¶

Promise\<{ app_versions?: readonly string[]; firmware_versions?: readonly { model?: string; vendor?: string; version?: string; warn_info?: string; }[]; }>

Inherited from¶

ZoomMeetingsApiDevicesGeneratedClient.GetZpaVersioninfo

InMeetingControl()¶

InMeetingControl(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PATCH /live_meetings/{meetingId}/events"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiInMeetingFeaturesGeneratedClient.InMeetingControl

ListArchivedFiles()¶

ListArchivedFiles(...args): Promise<{
  from?: string;
  meetings?: readonly {
     account_name: string;
     archive_files: readonly {
        auto_delete?: boolean;
        download_url: string;
        encryption_fingerprint: string;
        file_extension: string;
        file_path?: string;
        file_size: number;
        file_type:   | "MP4"
           | "M4A"
           | "CHAT"
           | "CC"
           | "CHAT_MESSAGE"
           | "TRANSCRIPT"
           | "SUB_GROUP_MEMBER_LOG"
           | "AIC_COVERSATION";
        id: string;
        individual: boolean;
        number_of_messages?: number;
        participant_email?: string;
        participant_join_time: string;
        participant_leave_time: string;
        recording_type:   | "shared_screen_with_speaker_view"
           | "audio_only"
           | "chat_file"
           | "closed_caption"
           | "chat_message"
           | "audio_transcript"
           | "aic_conversation";
        status: "failed" | "completed" | "processing";
        storage_location?: "US" | "AU" | "BR" | "CA" | "EU" | "IN" | "JP" | "SG" | "CH";
     }[];
     complete_time:   | {
      }
        | "";
     duration: number;
     duration_in_second: number;
     group_id?: string;
     host_id: string;
     id: number;
     is_breakout_room: boolean;
     meeting_type: "internal" | "external";
     parent_meeting_id?: string;
     physical_files?: readonly {
        download_url?: string;
        file_id?: string;
        file_name?: string;
        file_size?: number;
     }[];
     recording_count: number;
     start_time: string;
     status: "completed" | "processing";
     timezone: string;
     topic: string;
     total_size: number;
     type: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 100;
     uuid: string;
  }[];
  next_page_token?: string;
  page_size?: number;
  to?: string;
  total_records?: number;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /archive_files"`>]

Returns¶

Promise\<{ from?: string; meetings?: readonly { account_name: string; archive_files: readonly { auto_delete?: boolean; download_url: string; encryption_fingerprint: string; file_extension: string; file_path?: string; file_size: number; file_type: | "MP4" | "M4A" | "CHAT" | "CC" | "CHAT_MESSAGE" | "TRANSCRIPT" | "SUB_GROUP_MEMBER_LOG" | "AIC_COVERSATION"; id: string; individual: boolean; number_of_messages?: number; participant_email?: string; participant_join_time: string; participant_leave_time: string; recording_type: | "shared_screen_with_speaker_view" | "audio_only" | "chat_file" | "closed_caption" | "chat_message" | "audio_transcript" | "aic_conversation"; status: "failed" | "completed" | "processing"; storage_location?: "US" | "AU" | "BR" | "CA" | "EU" | "IN" | "JP" | "SG" | "CH"; }[]; complete_time: | { } | ""; duration: number; duration_in_second: number; group_id?: string; host_id: string; id: number; is_breakout_room: boolean; meeting_type: "internal" | "external"; parent_meeting_id?: string; physical_files?: readonly { download_url?: string; file_id?: string; file_name?: string; file_size?: number; }[]; recording_count: number; start_time: string; status: "completed" | "processing"; timezone: string; topic: string; total_size: number; type: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 100; uuid: string; }[]; next_page_token?: string; page_size?: number; to?: string; total_records?: number; }>

Inherited from¶

ZoomMeetingsApiArchivingGeneratedClient.ListArchivedFiles

ListDevices()¶

ListDevices(...args): Promise<{
  devices?: readonly {
     app_version?: string;
     connected_to_zdm?: boolean;
     device_id?: string;
     device_name?: string;
     device_status?: -1 | 0 | 1;
     device_type?: 0 | 1 | 2 | 3 | 4 | 5 | 6;
     enrolled_in_zdm?: boolean;
     last_online?: string;
     mac_address?: string;
     model?: string;
     platform_os?: string;
     room_id?: string;
     room_name?: string;
     serial_number?: string;
     skd_version?: string;
     tag?: string;
     user_email?: string;
     vendor?: string;
  }[];
  next_page_token?: string;
  page_size?: number;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /devices"`>]

Returns¶

Promise\<{ devices?: readonly { app_version?: string; connected_to_zdm?: boolean; device_id?: string; device_name?: string; device_status?: -1 | 0 | 1; device_type?: 0 | 1 | 2 | 3 | 4 | 5 | 6; enrolled_in_zdm?: boolean; last_online?: string; mac_address?: string; model?: string; platform_os?: string; room_id?: string; room_name?: string; serial_number?: string; skd_version?: string; tag?: string; user_email?: string; vendor?: string; }[]; next_page_token?: string; page_size?: number; }>

Inherited from¶

ZoomMeetingsApiDevicesGeneratedClient.ListDevices

Listmeetingsummaries()¶

Listmeetingsummaries(...args): Promise<{
  from?: string;
  next_page_token?: string;
  page_size?: number;
  summaries?: readonly {
     meeting_end_time?: string;
     meeting_host_email?: string;
     meeting_host_id?: string;
     meeting_id?: number;
     meeting_start_time?: string;
     meeting_topic?: string;
     meeting_uuid?: string;
     summary_created_time?: string;
     summary_end_time?: string;
     summary_last_modified_time?: string;
     summary_start_time?: string;
  }[];
  to?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /meetings/meeting_summaries"`>]

Returns¶

Promise\<{ from?: string; next_page_token?: string; page_size?: number; summaries?: readonly { meeting_end_time?: string; meeting_host_email?: string; meeting_host_id?: string; meeting_id?: number; meeting_start_time?: string; meeting_topic?: string; meeting_uuid?: string; summary_created_time?: string; summary_end_time?: string; summary_last_modified_time?: string; summary_start_time?: string; }[]; to?: string; }>

Inherited from¶

ZoomMeetingsApiSummariesGeneratedClient.Listmeetingsummaries

ListMeetingTemplates()¶

ListMeetingTemplates(...args): Promise<{
  templates?: readonly {
     id?: string;
     name?: string;
     type?: number;
  }[];
  total_records?: number;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /users/{userId}/meeting_templates"`>]

Returns¶

Promise\<{ templates?: readonly { id?: string; name?: string; type?: number; }[]; total_records?: number; }>

Inherited from¶

ZoomMeetingsApiTemplatesGeneratedClient.ListMeetingTemplates

ListPastMeetingPolls()¶

ListPastMeetingPolls(...args): Promise<{
  id?: number;
  questions?: readonly {
     email?: string;
     name?: string;
     question_details?: readonly {
        answer?: string;
        date_time?: string;
        polling_id?: string;
        question?: string;
     }[];
  }[];
  start_time?: string;
  uuid?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /past_meetings/{meetingId}/polls"`>]

Returns¶

Promise\<{ id?: number; questions?: readonly { email?: string; name?: string; question_details?: readonly { answer?: string; date_time?: string; polling_id?: string; question?: string; }[]; }[]; start_time?: string; uuid?: string; }>

Inherited from¶

ZoomMeetingsApiPollsGeneratedClient.ListPastMeetingPolls

ListPastMeetingQA()¶

ListPastMeetingQA(...args): Promise<{
  id?: number;
  questions?: readonly {
     email?: string;
     name?: string;
     question_details?: readonly {
        answer?: string;
        question?: string;
     }[];
  }[];
  start_time?: string;
  uuid?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /past_meetings/{meetingId}/qa"`>]

Returns¶

Promise\<{ id?: number; questions?: readonly { email?: string; name?: string; question_details?: readonly { answer?: string; question?: string; }[]; }[]; start_time?: string; uuid?: string; }>

Inherited from¶

ZoomMeetingsApiMeetingsGeneratedClient.ListPastMeetingQA

ListPastWebinarPollResults()¶

ListPastWebinarPollResults(...args): Promise<{
  id?: number;
  questions?: readonly {
     email?: string;
     name?: string;
     question_details?: readonly {
        answer?: string;
        date_time?: string;
        polling_id?: string;
        question?: string;
     }[];
  }[];
  start_time?: string;
  uuid?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /past_webinars/{webinarId}/polls"`>]

Returns¶

Promise\<{ id?: number; questions?: readonly { email?: string; name?: string; question_details?: readonly { answer?: string; date_time?: string; polling_id?: string; question?: string; }[]; }[]; start_time?: string; uuid?: string; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.ListPastWebinarPollResults

ListPastWebinarQA()¶

ListPastWebinarQA(...args): Promise<{
  id?: number;
  questions?: readonly {
     email?: string;
     name?: string;
     question_details?: readonly {
        answer?: string;
        question?: string;
     }[];
  }[];
  start_time?: string;
  uuid?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /past_webinars/{webinarId}/qa"`>]

Returns¶

Promise\<{ id?: number; questions?: readonly { email?: string; name?: string; question_details?: readonly { answer?: string; question?: string; }[]; }[]; start_time?: string; uuid?: string; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.ListPastWebinarQA

ListSIPPhonePhones()¶

ListSIPPhonePhones(...args): Promise<{
  next_page_token?: string;
  page_size?: number;
  phones?: readonly {
     authorization_name?: string;
     display_number?: string;
     domain?: string;
     password?: string;
     phone_id?: string;
     registration_expire_time?: number;
     server?: {
        proxy_server?: string;
        register_server?: string;
        transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
     };
     server_2?: {
        proxy_server?: string;
        register_server?: string;
        transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
     };
     server_3?: {
        proxy_server?: string;
        register_server?: string;
        transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
     };
     user_email?: string;
     user_name?: string;
     voice_mail?: string;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /sip_phones/phones"`>]

Returns¶

Promise\<{ next_page_token?: string; page_size?: number; phones?: readonly { authorization_name?: string; display_number?: string; domain?: string; password?: string; phone_id?: string; registration_expire_time?: number; server?: { proxy_server?: string; register_server?: string; transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO"; }; server_2?: { proxy_server?: string; register_server?: string; transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO"; }; server_3?: { proxy_server?: string; register_server?: string; transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO"; }; user_email?: string; user_name?: string; voice_mail?: string; }[]; }>

Inherited from¶

ZoomMeetingsApiSIPPhoneGeneratedClient.ListSIPPhonePhones

ListUpcomingMeeting()¶

ListUpcomingMeeting(...args): Promise<{
  meetings?: readonly {
     created_at?: string;
     duration?: number;
     id?: number;
     is_all_day?: boolean;
     is_host?: boolean;
     join_url?: string;
     passcode?: string;
     start_time?: string;
     timezone?: string;
     topic?: string;
     type?: 1 | 2 | 3 | 8;
     use_pmi?: boolean;
  }[];
  total_records?: number;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /users/{userId}/upcoming_meetings"`>]

Returns¶

Promise\<{ meetings?: readonly { created_at?: string; duration?: number; id?: number; is_all_day?: boolean; is_host?: boolean; join_url?: string; passcode?: string; start_time?: string; timezone?: string; topic?: string; type?: 1 | 2 | 3 | 8; use_pmi?: boolean; }[]; total_records?: number; }>

Inherited from¶

ZoomMeetingsApiMeetingsGeneratedClient.ListUpcomingMeeting

ListWebinarParticipants()¶

ListWebinarParticipants(...args): Promise<{
  next_page_token?: string;
  page_count?: number;
  page_size?: number;
  participants?: readonly {
     duration?: number;
     failover?: boolean;
     id?: string;
     internal_user?: boolean;
     join_time?: string;
     leave_time?: string;
     name?: string;
     registrant_id?: string;
     status?: "in_meeting" | "in_waiting_room";
     user_email?: string;
     user_id?: string;
  }[];
  total_records?: number;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /past_webinars/{webinarId}/participants"`>]

Returns¶

Promise\<{ next_page_token?: string; page_count?: number; page_size?: number; participants?: readonly { duration?: number; failover?: boolean; id?: string; internal_user?: boolean; join_time?: string; leave_time?: string; name?: string; registrant_id?: string; status?: "in_meeting" | "in_waiting_room"; user_email?: string; user_id?: string; }[]; total_records?: number; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.ListWebinarParticipants

ListWebinarTemplates()¶

ListWebinarTemplates(...args): Promise<{
  templates?: readonly {
     id?: string;
     name?: string;
     type?: number;
  }[];
  total_records?: number;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /users/{userId}/webinar_templates"`>]

Returns¶

Promise\<{ templates?: readonly { id?: string; name?: string; type?: number; }[]; total_records?: number; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.ListWebinarTemplates

Meeting()¶

Meeting(...args): Promise<{
  agenda?: string;
  assistant_id?: string;
  chat_join_url?: string;
  created_at?: string;
  creation_source?: "other" | "open_api" | "web_portal";
  duration?: number;
  dynamic_host_key?: string;
  encrypted_password?: string;
  h323_password?: string;
  host_email?: string;
  host_id?: string;
  id?: number;
  join_url?: string;
  occurrences?: readonly {
     duration?: number;
     occurrence_id?: string;
     start_time?: string;
     status?: "available" | "deleted";
  }[];
  password?: string;
  pmi?: string;
  pre_schedule?: boolean;
  pstn_password?: string;
  recurrence?: {
     end_date_time?: string;
     end_times?: number;
     monthly_day?: number;
     monthly_week?: -1 | 1 | 2 | 3 | 4;
     monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
     repeat_interval?: number;
     type: 1 | 2 | 3;
     weekly_days?: "2" | "1" | "3" | "4" | "5" | "6" | "7";
  };
  registration_url?: string;
  settings?: {
     additional_data_center_regions?: readonly string[];
     allow_host_control_participant_mute_state?: boolean;
     allow_multiple_devices?: boolean;
     alternative_host_manage_cloud_recording?: boolean;
     alternative_host_manage_meeting_summary?: boolean;
     alternative_host_update_polls?: boolean;
     alternative_hosts?: string;
     alternative_hosts_email_notification?: boolean;
     approval_type?: 0 | 1 | 2;
     approved_or_denied_countries_or_regions?: {
        approved_list?: readonly string[];
        denied_list?: readonly string[];
        enable?: boolean;
        method?: "approve" | "deny";
     };
     audio?: "both" | "telephony" | "voip" | "thirdParty";
     audio_conference_info?: string;
     authentication_domains?: string;
     authentication_exception?: readonly {
        email?: string;
        join_url?: string;
        name?: string;
     }[];
     authentication_name?: string;
     authentication_option?: string;
     auto_add_recording_to_video_management?: {
        channels?: readonly {
           channel_id: string;
           name?: string;
        }[];
        enable: boolean;
     };
     auto_recording?: "none" | "local" | "cloud";
     auto_start_ai_companion_questions?: boolean;
     auto_start_meeting_summary?: boolean;
     breakout_room?: {
        enable?: boolean;
        rooms?: readonly {
           name?: string;
           participants?: readonly string[];
        }[];
     };
     calendar_type?: 1 | 2;
     close_registration?: boolean;
     cn_meeting?: boolean;
     contact_email?: string;
     contact_name?: string;
     continuous_meeting_chat?: {
        auto_add_invited_external_users?: boolean;
        auto_add_meeting_participants?: boolean;
        channel_id?: string;
        enable?: boolean;
     };
     custom_keys?: readonly {
        key?: string;
        value?: string;
     }[];
     device_testing?: boolean;
     disable_participant_video?: boolean;
     email_in_attendee_report?: boolean;
     email_notification?: boolean;
     encryption_type?: "enhanced_encryption" | "e2ee";
     enforce_login?: boolean;
     enforce_login_domains?: string;
     focus_mode?: boolean;
     global_dial_in_countries?: readonly string[];
     global_dial_in_numbers?: readonly {
        city?: string;
        country?: string;
        country_name?: string;
        number?: string;
        type?: "toll" | "tollfree";
     }[];
     host_save_video_order?: boolean;
     host_video?: boolean;
     in_meeting?: boolean;
     internal_meeting?: boolean;
     jbh_time?: 0 | 5 | 10 | 15;
     join_before_host?: boolean;
     language_interpretation?: {
        enable?: boolean;
        interpreters?: readonly {
           email?: string;
           interpreter_languages?: string;
           languages?: string;
        }[];
     };
     meeting_authentication?: boolean;
     meeting_invitees?: readonly {
        email?: string;
        internal_user?: boolean;
     }[];
     mute_upon_entry?: boolean;
     participant_focused_meeting?: boolean;
     participant_video?: boolean;
     private_meeting?: boolean;
     push_change_to_calendar?: boolean;
     question_and_answer?: {
        allow_anonymous_questions?: boolean;
        allow_submit_questions?: boolean;
        attendees_can_comment?: boolean;
        attendees_can_upvote?: boolean;
        enable?: boolean;
        question_visibility?: "all" | "answered";
     };
     registrants_confirmation_email?: boolean;
     registrants_email_notification?: boolean;
     registration_type?: 1 | 2 | 3;
     request_permission_to_unmute_participants?: boolean;
     resources?: readonly {
        permission_level?: "editor" | "commenter" | "viewer";
        resource_id?: string;
        resource_type?: "whiteboard";
     }[];
     show_join_info?: boolean;
     show_share_button?: boolean;
     sign_language_interpretation?: {
        enable?: boolean;
        interpreters?: readonly {
           email?: string;
           sign_language?: string;
        }[];
     };
     summary_template_id?: string;
     use_pmi?: boolean;
     waiting_room?: boolean;
     waiting_room_options?: {
        mode: "custom" | "follow_setting";
        who_goes_to_waiting_room?:   | "everyone"
           | "users_not_in_account"
           | "users_not_in_account_or_whitelisted_domains"
           | "users_not_on_invite"
           | "users_not_in_org";
     };
     watermark?: boolean;
     who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;
     who_will_receive_summary?: 1 | 2 | 3 | 4;
  };
  start_time?: string;
  start_url?: string;
  status?: "started" | "waiting";
  template_id?: string;
  timezone?: string;
  topic?: string;
  tracking_fields?: readonly {
     field?: string;
     value?: string;
     visible?: boolean;
  }[];
  type?: 1 | 2 | 3 | 4 | 8 | 10;
  uuid?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /meetings/{meetingId}"`>]

Returns¶

Promise\<{ agenda?: string; assistant_id?: string; chat_join_url?: string; created_at?: string; creation_source?: "other" | "open_api" | "web_portal"; duration?: number; dynamic_host_key?: string; encrypted_password?: string; h323_password?: string; host_email?: string; host_id?: string; id?: number; join_url?: string; occurrences?: readonly { duration?: number; occurrence_id?: string; start_time?: string; status?: "available" | "deleted"; }[]; password?: string; pmi?: string; pre_schedule?: boolean; pstn_password?: string; recurrence?: { end_date_time?: string; end_times?: number; monthly_day?: number; monthly_week?: -1 | 1 | 2 | 3 | 4; monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7; repeat_interval?: number; type: 1 | 2 | 3; weekly_days?: "2" | "1" | "3" | "4" | "5" | "6" | "7"; }; registration_url?: string; settings?: { additional_data_center_regions?: readonly string[]; allow_host_control_participant_mute_state?: boolean; allow_multiple_devices?: boolean; alternative_host_manage_cloud_recording?: boolean; alternative_host_manage_meeting_summary?: boolean; alternative_host_update_polls?: boolean; alternative_hosts?: string; alternative_hosts_email_notification?: boolean; approval_type?: 0 | 1 | 2; approved_or_denied_countries_or_regions?: { approved_list?: readonly string[]; denied_list?: readonly string[]; enable?: boolean; method?: "approve" | "deny"; }; audio?: "both" | "telephony" | "voip" | "thirdParty"; audio_conference_info?: string; authentication_domains?: string; authentication_exception?: readonly { email?: string; join_url?: string; name?: string; }[]; authentication_name?: string; authentication_option?: string; auto_add_recording_to_video_management?: { channels?: readonly { channel_id: string; name?: string; }[]; enable: boolean; }; auto_recording?: "none" | "local" | "cloud"; auto_start_ai_companion_questions?: boolean; auto_start_meeting_summary?: boolean; breakout_room?: { enable?: boolean; rooms?: readonly { name?: string; participants?: readonly string[]; }[]; }; calendar_type?: 1 | 2; close_registration?: boolean; cn_meeting?: boolean; contact_email?: string; contact_name?: string; continuous_meeting_chat?: { auto_add_invited_external_users?: boolean; auto_add_meeting_participants?: boolean; channel_id?: string; enable?: boolean; }; custom_keys?: readonly { key?: string; value?: string; }[]; device_testing?: boolean; disable_participant_video?: boolean; email_in_attendee_report?: boolean; email_notification?: boolean; encryption_type?: "enhanced_encryption" | "e2ee"; enforce_login?: boolean; enforce_login_domains?: string; focus_mode?: boolean; global_dial_in_countries?: readonly string[]; global_dial_in_numbers?: readonly { city?: string; country?: string; country_name?: string; number?: string; type?: "toll" | "tollfree"; }[]; host_save_video_order?: boolean; host_video?: boolean; in_meeting?: boolean; internal_meeting?: boolean; jbh_time?: 0 | 5 | 10 | 15; join_before_host?: boolean; language_interpretation?: { enable?: boolean; interpreters?: readonly { email?: string; interpreter_languages?: string; languages?: string; }[]; }; meeting_authentication?: boolean; meeting_invitees?: readonly { email?: string; internal_user?: boolean; }[]; mute_upon_entry?: boolean; participant_focused_meeting?: boolean; participant_video?: boolean; private_meeting?: boolean; push_change_to_calendar?: boolean; question_and_answer?: { allow_anonymous_questions?: boolean; allow_submit_questions?: boolean; attendees_can_comment?: boolean; attendees_can_upvote?: boolean; enable?: boolean; question_visibility?: "all" | "answered"; }; registrants_confirmation_email?: boolean; registrants_email_notification?: boolean; registration_type?: 1 | 2 | 3; request_permission_to_unmute_participants?: boolean; resources?: readonly { permission_level?: "editor" | "commenter" | "viewer"; resource_id?: string; resource_type?: "whiteboard"; }[]; show_join_info?: boolean; show_share_button?: boolean; sign_language_interpretation?: { enable?: boolean; interpreters?: readonly { email?: string; sign_language?: string; }[]; }; summary_template_id?: string; use_pmi?: boolean; waiting_room?: boolean; waiting_room_options?: { mode: "custom" | "follow_setting"; who_goes_to_waiting_room?: | "everyone" | "users_not_in_account" | "users_not_in_account_or_whitelisted_domains" | "users_not_on_invite" | "users_not_in_org"; }; watermark?: boolean; who_can_ask_questions?: 1 | 2 | 3 | 4 | 5; who_will_receive_summary?: 1 | 2 | 3 | 4; }; start_time?: string; start_url?: string; status?: "started" | "waiting"; template_id?: string; timezone?: string; topic?: string; tracking_fields?: readonly { field?: string; value?: string; visible?: boolean; }[]; type?: 1 | 2 | 3 | 4 | 8 | 10; uuid?: string; }>

Inherited from¶

ZoomMeetingsApiMeetingsGeneratedClient.Meeting

MeetingAppAdd()¶

MeetingAppAdd(...args): Promise<{
  app_id?: string;
  id?: number;
  start_time?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /meetings/{meetingId}/open_apps"`>]

Returns¶

Promise\<{ app_id?: string; id?: number; start_time?: string; }>

Inherited from¶

ZoomMeetingsApiInMeetingAppsGeneratedClient.MeetingAppAdd

MeetingAppDelete()¶

MeetingAppDelete(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"DELETE /meetings/{meetingId}/open_apps"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiInMeetingAppsGeneratedClient.MeetingAppDelete

MeetingCreate()¶

MeetingCreate(...args): Promise<{
  agenda?: string;
  assistant_id?: string;
  chat_join_url?: string;
  created_at?: string;
  creation_source?: "other" | "open_api" | "web_portal";
  duration?: number;
  dynamic_host_key?: string;
  encrypted_password?: string;
  h323_password?: string;
  host_email?: string;
  host_id?: string;
  id?: number;
  join_url?: string;
  occurrences?: readonly {
     duration?: number;
     occurrence_id?: string;
     start_time?: string;
     status?: "available" | "deleted";
  }[];
  password?: string;
  pmi?: string;
  pre_schedule?: boolean;
  pstn_password?: string;
  recurrence?: {
     end_date_time?: string;
     end_times?: number;
     monthly_day?: number;
     monthly_week?: -1 | 1 | 2 | 3 | 4;
     monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
     repeat_interval?: number;
     type: 1 | 2 | 3;
     weekly_days?: "2" | "1" | "3" | "4" | "5" | "6" | "7";
  };
  registration_url?: string;
  settings?: {
     additional_data_center_regions?: readonly string[];
     allow_host_control_participant_mute_state?: boolean;
     allow_multiple_devices?: boolean;
     alternative_host_manage_cloud_recording?: boolean;
     alternative_host_manage_meeting_summary?: boolean;
     alternative_host_update_polls?: boolean;
     alternative_hosts?: string;
     alternative_hosts_email_notification?: boolean;
     approval_type?: 0 | 1 | 2;
     approved_or_denied_countries_or_regions?: {
        approved_list?: readonly string[];
        denied_list?: readonly string[];
        enable?: boolean;
        method?: "approve" | "deny";
     };
     audio?: "both" | "telephony" | "voip" | "thirdParty";
     audio_conference_info?: string;
     authentication_domains?: string;
     authentication_exception?: readonly {
        email?: string;
        join_url?: string;
        name?: string;
     }[];
     authentication_name?: string;
     authentication_option?: string;
     auto_add_recording_to_video_management?: {
        channels?: readonly {
           channel_id: string;
           name?: string;
        }[];
        enable: boolean;
     };
     auto_recording?: "none" | "local" | "cloud";
     auto_start_ai_companion_questions?: boolean;
     auto_start_meeting_summary?: boolean;
     breakout_room?: {
        enable?: boolean;
        rooms?: readonly {
           name?: string;
           participants?: readonly string[];
        }[];
     };
     calendar_type?: 1 | 2;
     close_registration?: boolean;
     cn_meeting?: boolean;
     contact_email?: string;
     contact_name?: string;
     continuous_meeting_chat?: {
        auto_add_invited_external_users?: boolean;
        auto_add_meeting_participants?: boolean;
        channel_id?: string;
        enable?: boolean;
     };
     custom_keys?: readonly {
        key?: string;
        value?: string;
     }[];
     device_testing?: boolean;
     disable_participant_video?: boolean;
     email_in_attendee_report?: boolean;
     email_notification?: boolean;
     encryption_type?: "enhanced_encryption" | "e2ee";
     enforce_login?: boolean;
     enforce_login_domains?: string;
     focus_mode?: boolean;
     global_dial_in_countries?: readonly string[];
     global_dial_in_numbers?: readonly {
        city?: string;
        country?: string;
        country_name?: string;
        number?: string;
        type?: "toll" | "tollfree";
     }[];
     host_save_video_order?: boolean;
     host_video?: boolean;
     in_meeting?: boolean;
     internal_meeting?: boolean;
     jbh_time?: 0 | 5 | 10 | 15;
     join_before_host?: boolean;
     language_interpretation?: {
        enable?: boolean;
        interpreters?: readonly {
           email?: string;
           interpreter_languages?: string;
           languages?: string;
        }[];
     };
     meeting_authentication?: boolean;
     meeting_invitees?: readonly {
        email?: string;
     }[];
     mute_upon_entry?: boolean;
     participant_focused_meeting?: boolean;
     participant_video?: boolean;
     private_meeting?: boolean;
     push_change_to_calendar?: boolean;
     question_and_answer?: {
        allow_anonymous_questions?: boolean;
        allow_submit_questions?: boolean;
        attendees_can_comment?: boolean;
        attendees_can_upvote?: boolean;
        enable?: boolean;
        question_visibility?: "all" | "answered";
     };
     registrants_confirmation_email?: boolean;
     registrants_email_notification?: boolean;
     registration_type?: 1 | 2 | 3;
     request_permission_to_unmute_participants?: boolean;
     resources?: readonly {
        permission_level?: "editor" | "commenter" | "viewer";
        resource_id?: string;
        resource_type?: "whiteboard";
     }[];
     show_join_info?: boolean;
     show_share_button?: boolean;
     sign_language_interpretation?: {
        enable?: boolean;
        interpreters?: readonly {
           email?: string;
           sign_language?: string;
        }[];
     };
     summary_template_id?: string;
     use_pmi?: boolean;
     waiting_room?: boolean;
     waiting_room_options?: {
        mode: "custom" | "follow_setting";
        who_goes_to_waiting_room?:   | "everyone"
           | "users_not_in_account"
           | "users_not_in_account_or_whitelisted_domains"
           | "users_not_on_invite"
           | "users_not_in_org";
     };
     watermark?: boolean;
     who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;
     who_will_receive_summary?: 1 | 2 | 3 | 4;
  };
  start_time?: string;
  start_url?: string;
  status?: "started" | "waiting";
  template_id?: string;
  timezone?: string;
  topic?: string;
  tracking_fields?: readonly {
     field?: string;
     value?: string;
     visible?: boolean;
  }[];
  type?: 1 | 2 | 3 | 8 | 10;
  uuid?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /users/{userId}/meetings"`>]

Returns¶

Promise\<{ agenda?: string; assistant_id?: string; chat_join_url?: string; created_at?: string; creation_source?: "other" | "open_api" | "web_portal"; duration?: number; dynamic_host_key?: string; encrypted_password?: string; h323_password?: string; host_email?: string; host_id?: string; id?: number; join_url?: string; occurrences?: readonly { duration?: number; occurrence_id?: string; start_time?: string; status?: "available" | "deleted"; }[]; password?: string; pmi?: string; pre_schedule?: boolean; pstn_password?: string; recurrence?: { end_date_time?: string; end_times?: number; monthly_day?: number; monthly_week?: -1 | 1 | 2 | 3 | 4; monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7; repeat_interval?: number; type: 1 | 2 | 3; weekly_days?: "2" | "1" | "3" | "4" | "5" | "6" | "7"; }; registration_url?: string; settings?: { additional_data_center_regions?: readonly string[]; allow_host_control_participant_mute_state?: boolean; allow_multiple_devices?: boolean; alternative_host_manage_cloud_recording?: boolean; alternative_host_manage_meeting_summary?: boolean; alternative_host_update_polls?: boolean; alternative_hosts?: string; alternative_hosts_email_notification?: boolean; approval_type?: 0 | 1 | 2; approved_or_denied_countries_or_regions?: { approved_list?: readonly string[]; denied_list?: readonly string[]; enable?: boolean; method?: "approve" | "deny"; }; audio?: "both" | "telephony" | "voip" | "thirdParty"; audio_conference_info?: string; authentication_domains?: string; authentication_exception?: readonly { email?: string; join_url?: string; name?: string; }[]; authentication_name?: string; authentication_option?: string; auto_add_recording_to_video_management?: { channels?: readonly { channel_id: string; name?: string; }[]; enable: boolean; }; auto_recording?: "none" | "local" | "cloud"; auto_start_ai_companion_questions?: boolean; auto_start_meeting_summary?: boolean; breakout_room?: { enable?: boolean; rooms?: readonly { name?: string; participants?: readonly string[]; }[]; }; calendar_type?: 1 | 2; close_registration?: boolean; cn_meeting?: boolean; contact_email?: string; contact_name?: string; continuous_meeting_chat?: { auto_add_invited_external_users?: boolean; auto_add_meeting_participants?: boolean; channel_id?: string; enable?: boolean; }; custom_keys?: readonly { key?: string; value?: string; }[]; device_testing?: boolean; disable_participant_video?: boolean; email_in_attendee_report?: boolean; email_notification?: boolean; encryption_type?: "enhanced_encryption" | "e2ee"; enforce_login?: boolean; enforce_login_domains?: string; focus_mode?: boolean; global_dial_in_countries?: readonly string[]; global_dial_in_numbers?: readonly { city?: string; country?: string; country_name?: string; number?: string; type?: "toll" | "tollfree"; }[]; host_save_video_order?: boolean; host_video?: boolean; in_meeting?: boolean; internal_meeting?: boolean; jbh_time?: 0 | 5 | 10 | 15; join_before_host?: boolean; language_interpretation?: { enable?: boolean; interpreters?: readonly { email?: string; interpreter_languages?: string; languages?: string; }[]; }; meeting_authentication?: boolean; meeting_invitees?: readonly { email?: string; }[]; mute_upon_entry?: boolean; participant_focused_meeting?: boolean; participant_video?: boolean; private_meeting?: boolean; push_change_to_calendar?: boolean; question_and_answer?: { allow_anonymous_questions?: boolean; allow_submit_questions?: boolean; attendees_can_comment?: boolean; attendees_can_upvote?: boolean; enable?: boolean; question_visibility?: "all" | "answered"; }; registrants_confirmation_email?: boolean; registrants_email_notification?: boolean; registration_type?: 1 | 2 | 3; request_permission_to_unmute_participants?: boolean; resources?: readonly { permission_level?: "editor" | "commenter" | "viewer"; resource_id?: string; resource_type?: "whiteboard"; }[]; show_join_info?: boolean; show_share_button?: boolean; sign_language_interpretation?: { enable?: boolean; interpreters?: readonly { email?: string; sign_language?: string; }[]; }; summary_template_id?: string; use_pmi?: boolean; waiting_room?: boolean; waiting_room_options?: { mode: "custom" | "follow_setting"; who_goes_to_waiting_room?: | "everyone" | "users_not_in_account" | "users_not_in_account_or_whitelisted_domains" | "users_not_on_invite" | "users_not_in_org"; }; watermark?: boolean; who_can_ask_questions?: 1 | 2 | 3 | 4 | 5; who_will_receive_summary?: 1 | 2 | 3 | 4; }; start_time?: string; start_url?: string; status?: "started" | "waiting"; template_id?: string; timezone?: string; topic?: string; tracking_fields?: readonly { field?: string; value?: string; visible?: boolean; }[]; type?: 1 | 2 | 3 | 8 | 10; uuid?: string; }>

Inherited from¶

ZoomMeetingsApiMeetingsGeneratedClient.MeetingCreate

MeetingDelete()¶

MeetingDelete(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"DELETE /meetings/{meetingId}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiMeetingsGeneratedClient.MeetingDelete

MeetingInvitation()¶

MeetingInvitation(...args): Promise<{
  invitation?: string;
  sip_links?: readonly string[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /meetings/{meetingId}/invitation"`>]

Returns¶

Promise\<{ invitation?: string; sip_links?: readonly string[]; }>

Inherited from¶

ZoomMeetingsApiInvitationRegistrationGeneratedClient.MeetingInvitation

MeetingInviteLinksCreate()¶

MeetingInviteLinksCreate(...args): Promise<{
  attendees?: readonly {
     join_url?: string;
     name?: string;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /meetings/{meetingId}/invite_links"`>]

Returns¶

Promise\<{ attendees?: readonly { join_url?: string; name?: string; }[]; }>

Inherited from¶

ZoomMeetingsApiInvitationRegistrationGeneratedClient.MeetingInviteLinksCreate

MeetingLiveStreamingJoinToken()¶

MeetingLiveStreamingJoinToken(...args): Promise<{
  expire_in?: 120;
  token?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /meetings/{meetingId}/jointoken/live_streaming"`>]

Returns¶

Promise\<{ expire_in?: 120; token?: string; }>

Inherited from¶

ZoomMeetingsApiLiveStreamingGeneratedClient.MeetingLiveStreamingJoinToken

MeetingLiveStreamStatusUpdate()¶

MeetingLiveStreamStatusUpdate(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PATCH /meetings/{meetingId}/livestream/status"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiLiveStreamingGeneratedClient.MeetingLiveStreamStatusUpdate

MeetingLiveStreamUpdate()¶

MeetingLiveStreamUpdate(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PATCH /meetings/{meetingId}/livestream"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiLiveStreamingGeneratedClient.MeetingLiveStreamUpdate

MeetingLocalArchivingArchiveToken()¶

MeetingLocalArchivingArchiveToken(...args): Promise<{
  expire_in?: 120;
  token?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /meetings/{meetingId}/jointoken/local_archiving"`>]

Returns¶

Promise\<{ expire_in?: 120; token?: string; }>

Inherited from¶

ZoomMeetingsApiArchivingGeneratedClient.MeetingLocalArchivingArchiveToken

MeetingLocalRecordingJoinToken()¶

MeetingLocalRecordingJoinToken(...args): Promise<{
  expire_in?: 120;
  token?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /meetings/{meetingId}/jointoken/local_recording"`>]

Returns¶

Promise\<{ expire_in?: 120; token?: string; }>

Inherited from¶

ZoomMeetingsApiInMeetingFeaturesGeneratedClient.MeetingLocalRecordingJoinToken

MeetingPollCreate()¶

MeetingPollCreate(...args): Promise<{
  id?: string;
  status?: "started" | "ended" | "notstart" | "sharing";
} & {
  anonymous?: boolean;
  poll_type?: 1 | 2 | 3;
  questions?: readonly {
     answer_max_character?: number;
     answer_min_character?: number;
     answer_required?: boolean;
     answers?: readonly string[];
     case_sensitive?: boolean;
     name?: string;
     prompts?: readonly {
        prompt_question?: string;
        prompt_right_answers?: readonly string[];
     }[];
     rating_max_label?: string;
     rating_max_value?: number;
     rating_min_label?: string;
     rating_min_value?: number;
     right_answers?: readonly string[];
     show_as_dropdown?: boolean;
     type?:   | "single"
        | "multiple"
        | "matching"
        | "rank_order"
        | "short_answer"
        | "long_answer"
        | "fill_in_the_blank"
        | "rating_scale";
  }[];
  title?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /meetings/{meetingId}/polls"`>]

Returns¶

Promise\<{ id?: string; status?: "started" | "ended" | "notstart" | "sharing"; } & { anonymous?: boolean; poll_type?: 1 | 2 | 3; questions?: readonly { answer_max_character?: number; answer_min_character?: number; answer_required?: boolean; answers?: readonly string[]; case_sensitive?: boolean; name?: string; prompts?: readonly { prompt_question?: string; prompt_right_answers?: readonly string[]; }[]; rating_max_label?: string; rating_max_value?: number; rating_min_label?: string; rating_min_value?: number; right_answers?: readonly string[]; show_as_dropdown?: boolean; type?: | "single" | "multiple" | "matching" | "rank_order" | "short_answer" | "long_answer" | "fill_in_the_blank" | "rating_scale"; }[]; title?: string; }>

Inherited from¶

ZoomMeetingsApiPollsGeneratedClient.MeetingPollCreate

MeetingPollDelete()¶

MeetingPollDelete(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"DELETE /meetings/{meetingId}/polls/{pollId}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiPollsGeneratedClient.MeetingPollDelete

MeetingPollGet()¶

MeetingPollGet(...args): Promise<{
  id?: string;
  status?: "started" | "ended" | "notstart" | "sharing" | "deactivated";
} & {
  anonymous?: boolean;
  poll_type?: 1 | 2 | 3;
  questions?: readonly {
     answer_max_character?: number;
     answer_min_character?: number;
     answer_required?: boolean;
     answers?: readonly string[];
     case_sensitive?: boolean;
     name?: string;
     prompts?: readonly {
        prompt_question?: string;
        prompt_right_answers?: readonly string[];
     }[];
     rating_max_label?: string;
     rating_max_value?: number;
     rating_min_label?: string;
     rating_min_value?: number;
     right_answers?: readonly string[];
     show_as_dropdown?: boolean;
     type?:   | "single"
        | "multiple"
        | "matching"
        | "rank_order"
        | "short_answer"
        | "long_answer"
        | "fill_in_the_blank"
        | "rating_scale";
  }[];
  title?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /meetings/{meetingId}/polls/{pollId}"`>]

Returns¶

Promise\<{ id?: string; status?: "started" | "ended" | "notstart" | "sharing" | "deactivated"; } & { anonymous?: boolean; poll_type?: 1 | 2 | 3; questions?: readonly { answer_max_character?: number; answer_min_character?: number; answer_required?: boolean; answers?: readonly string[]; case_sensitive?: boolean; name?: string; prompts?: readonly { prompt_question?: string; prompt_right_answers?: readonly string[]; }[]; rating_max_label?: string; rating_max_value?: number; rating_min_label?: string; rating_min_value?: number; right_answers?: readonly string[]; show_as_dropdown?: boolean; type?: | "single" | "multiple" | "matching" | "rank_order" | "short_answer" | "long_answer" | "fill_in_the_blank" | "rating_scale"; }[]; title?: string; }>

Inherited from¶

ZoomMeetingsApiPollsGeneratedClient.MeetingPollGet

MeetingPolls()¶

MeetingPolls(...args): Promise<{
  polls?: readonly {
     id?: string;
     status?: "started" | "ended" | "notstart" | "sharing" | "deactivated";
   } & {
     anonymous?: boolean;
     poll_type?: 1 | 2 | 3;
     questions?: readonly {
        answer_max_character?: number;
        answer_min_character?: number;
        answer_required?: boolean;
        answers?: readonly string[];
        case_sensitive?: boolean;
        name?: string;
        prompts?: readonly {
           prompt_question?: string;
           prompt_right_answers?: readonly string[];
        }[];
        rating_max_label?: string;
        rating_max_value?: number;
        rating_min_label?: string;
        rating_min_value?: number;
        right_answers?: readonly string[];
        show_as_dropdown?: boolean;
        type?:   | "single"
           | "multiple"
           | "matching"
           | "rank_order"
           | "short_answer"
           | "long_answer"
           | "fill_in_the_blank"
           | "rating_scale";
     }[];
     title?: string;
  }[];
  total_records?: number;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /meetings/{meetingId}/polls"`>]

Returns¶

Promise\<{ polls?: readonly { id?: string; status?: "started" | "ended" | "notstart" | "sharing" | "deactivated"; } & { anonymous?: boolean; poll_type?: 1 | 2 | 3; questions?: readonly { answer_max_character?: number; answer_min_character?: number; answer_required?: boolean; answers?: readonly string[]; case_sensitive?: boolean; name?: string; prompts?: readonly { prompt_question?: string; prompt_right_answers?: readonly string[]; }[]; rating_max_label?: string; rating_max_value?: number; rating_min_label?: string; rating_min_value?: number; right_answers?: readonly string[]; show_as_dropdown?: boolean; type?: | "single" | "multiple" | "matching" | "rank_order" | "short_answer" | "long_answer" | "fill_in_the_blank" | "rating_scale"; }[]; title?: string; }[]; total_records?: number; }>

Inherited from¶

ZoomMeetingsApiPollsGeneratedClient.MeetingPolls

MeetingPollUpdate()¶

MeetingPollUpdate(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PUT /meetings/{meetingId}/polls/{pollId}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiPollsGeneratedClient.MeetingPollUpdate

MeetingRecordingRegistrantCreate()¶

MeetingRecordingRegistrantCreate(...args): Promise<{
  id?: number;
  registrant_id?: string;
  share_url?: string;
  topic?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /meetings/{meetingId}/recordings/registrants"`>]

Returns¶

Promise\<{ id?: number; registrant_id?: string; share_url?: string; topic?: string; }>

Inherited from¶

ZoomMeetingsApiCloudRecordingGeneratedClient.MeetingRecordingRegistrantCreate

MeetingRecordingRegistrants()¶

MeetingRecordingRegistrants(...args): Promise<{
  next_page_token?: string;
  page_count?: number;
  page_number?: number;
  page_size?: number;
  total_records?: number;
} & {
  registrants?: readonly {
     id?: string;
   } & {
     address?: string;
     city?: string;
     comments?: string;
     country?: string;
     custom_questions?: readonly {
        title?: string;
        value?: string;
     }[];
     email: string;
     first_name: string;
     industry?: string;
     job_title?: string;
     last_name?: string;
     no_of_employees?:   | ""
        | "1-20"
        | "21-50"
        | "51-100"
        | "101-250"
        | "251-500"
        | "501-1,000"
        | "1,001-5,000"
        | "5,001-10,000"
        | "More than 10,000";
     org?: string;
     phone?: string;
     purchasing_time_frame?:   | ""
        | "Within a month"
        | "1-3 months"
        | "4-6 months"
        | "More than 6 months"
        | "No timeframe";
     role_in_purchase_process?:   | ""
        | "Decision Maker"
        | "Evaluator/Recommender"
        | "Influencer"
        | "Not involved";
     state?: string;
     status?: "pending" | "approved" | "denied";
     zip?: string;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /meetings/{meetingId}/recordings/registrants"`>]

Returns¶

Promise\<{ next_page_token?: string; page_count?: number; page_number?: number; page_size?: number; total_records?: number; } & { registrants?: readonly { id?: string; } & { address?: string; city?: string; comments?: string; country?: string; custom_questions?: readonly { title?: string; value?: string; }[]; email: string; first_name: string; industry?: string; job_title?: string; last_name?: string; no_of_employees?: | "" | "1-20" | "21-50" | "51-100" | "101-250" | "251-500" | "501-1,000" | "1,001-5,000" | "5,001-10,000" | "More than 10,000"; org?: string; phone?: string; purchasing_time_frame?: | "" | "Within a month" | "1-3 months" | "4-6 months" | "More than 6 months" | "No timeframe"; role_in_purchase_process?: | "" | "Decision Maker" | "Evaluator/Recommender" | "Influencer" | "Not involved"; state?: string; status?: "pending" | "approved" | "denied"; zip?: string; }[]; }>

Inherited from¶

ZoomMeetingsApiCloudRecordingGeneratedClient.MeetingRecordingRegistrants

MeetingRecordingRegistrantStatus()¶

MeetingRecordingRegistrantStatus(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PUT /meetings/{meetingId}/recordings/registrants/status"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiCloudRecordingGeneratedClient.MeetingRecordingRegistrantStatus

MeetingRegistrantCreate()¶

MeetingRegistrantCreate(...args): Promise<{
  id?: number;
  join_url?: string;
  occurrences?: readonly {
     duration?: number;
     occurrence_id?: string;
     start_time?: string;
     status?: string;
  }[];
  participant_pin_code?: number;
  registrant_id?: string;
  start_time?: string;
  topic?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /meetings/{meetingId}/registrants"`>]

Returns¶

Promise\<{ id?: number; join_url?: string; occurrences?: readonly { duration?: number; occurrence_id?: string; start_time?: string; status?: string; }[]; participant_pin_code?: number; registrant_id?: string; start_time?: string; topic?: string; }>

Inherited from¶

ZoomMeetingsApiInvitationRegistrationGeneratedClient.MeetingRegistrantCreate

Meetingregistrantdelete()¶

Meetingregistrantdelete(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"DELETE /meetings/{meetingId}/registrants/{registrantId}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiInvitationRegistrationGeneratedClient.Meetingregistrantdelete

MeetingRegistrantGet()¶

MeetingRegistrantGet(...args): Promise<{
  id?: string;
} & {
  address?: string;
  city?: string;
  comments?: string;
  country?: string;
  custom_questions?: readonly {
     title?: string;
     value?: string;
  }[];
  email: string;
  first_name: string;
  industry?: string;
  job_title?: string;
  last_name?: string;
  no_of_employees?:   | ""
     | "1-20"
     | "21-50"
     | "51-100"
     | "101-250"
     | "251-500"
     | "501-1,000"
     | "1,001-5,000"
     | "5,001-10,000"
     | "More than 10,000";
  org?: string;
  phone?: string;
  purchasing_time_frame?:   | ""
     | "Within a month"
     | "1-3 months"
     | "4-6 months"
     | "More than 6 months"
     | "No timeframe";
  role_in_purchase_process?:   | ""
     | "Decision Maker"
     | "Evaluator/Recommender"
     | "Influencer"
     | "Not involved";
  state?: string;
  status?: "pending" | "approved" | "denied";
  zip?: string;
} & {
  create_time?: string;
  join_url?: string;
  participant_pin_code?: number;
  status?: "pending" | "approved" | "denied";
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /meetings/{meetingId}/registrants/{registrantId}"`>]

Returns¶

Promise\<{ id?: string; } & { address?: string; city?: string; comments?: string; country?: string; custom_questions?: readonly { title?: string; value?: string; }[]; email: string; first_name: string; industry?: string; job_title?: string; last_name?: string; no_of_employees?: | "" | "1-20" | "21-50" | "51-100" | "101-250" | "251-500" | "501-1,000" | "1,001-5,000" | "5,001-10,000" | "More than 10,000"; org?: string; phone?: string; purchasing_time_frame?: | "" | "Within a month" | "1-3 months" | "4-6 months" | "More than 6 months" | "No timeframe"; role_in_purchase_process?: | "" | "Decision Maker" | "Evaluator/Recommender" | "Influencer" | "Not involved"; state?: string; status?: "pending" | "approved" | "denied"; zip?: string; } & { create_time?: string; join_url?: string; participant_pin_code?: number; status?: "pending" | "approved" | "denied"; }>

Inherited from¶

ZoomMeetingsApiInvitationRegistrationGeneratedClient.MeetingRegistrantGet

MeetingRegistrantQuestionUpdate()¶

MeetingRegistrantQuestionUpdate(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PATCH /meetings/{meetingId}/registrants/questions"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiInvitationRegistrationGeneratedClient.MeetingRegistrantQuestionUpdate

MeetingRegistrants()¶

MeetingRegistrants(...args): Promise<{
  next_page_token?: string;
  page_count?: number;
  page_number?: number;
  page_size?: number;
  total_records?: number;
} & {
  registrants?: readonly {
     id?: string;
   } & {
     address?: string;
     city?: string;
     comments?: string;
     country?: string;
     custom_questions?: readonly {
        title?: string;
        value?: string;
     }[];
     email: string;
     first_name: string;
     industry?: string;
     job_title?: string;
     last_name?: string;
     no_of_employees?:   | ""
        | "1-20"
        | "21-50"
        | "51-100"
        | "101-250"
        | "251-500"
        | "501-1,000"
        | "1,001-5,000"
        | "5,001-10,000"
        | "More than 10,000";
     org?: string;
     phone?: string;
     purchasing_time_frame?:   | ""
        | "Within a month"
        | "1-3 months"
        | "4-6 months"
        | "More than 6 months"
        | "No timeframe";
     role_in_purchase_process?:   | ""
        | "Decision Maker"
        | "Evaluator/Recommender"
        | "Influencer"
        | "Not involved";
     state?: string;
     status?: "pending" | "approved" | "denied";
     zip?: string;
   } & {
     create_time?: string;
     join_url?: string;
     participant_pin_code?: number;
     status?: string;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /meetings/{meetingId}/registrants"`>]

Returns¶

Promise\<{ next_page_token?: string; page_count?: number; page_number?: number; page_size?: number; total_records?: number; } & { registrants?: readonly { id?: string; } & { address?: string; city?: string; comments?: string; country?: string; custom_questions?: readonly { title?: string; value?: string; }[]; email: string; first_name: string; industry?: string; job_title?: string; last_name?: string; no_of_employees?: | "" | "1-20" | "21-50" | "51-100" | "101-250" | "251-500" | "501-1,000" | "1,001-5,000" | "5,001-10,000" | "More than 10,000"; org?: string; phone?: string; purchasing_time_frame?: | "" | "Within a month" | "1-3 months" | "4-6 months" | "More than 6 months" | "No timeframe"; role_in_purchase_process?: | "" | "Decision Maker" | "Evaluator/Recommender" | "Influencer" | "Not involved"; state?: string; status?: "pending" | "approved" | "denied"; zip?: string; } & { create_time?: string; join_url?: string; participant_pin_code?: number; status?: string; }[]; }>

Inherited from¶

ZoomMeetingsApiInvitationRegistrationGeneratedClient.MeetingRegistrants

MeetingRegistrantsQuestionsGet()¶

MeetingRegistrantsQuestionsGet(...args): Promise<{
  custom_questions?: readonly {
     answers?: readonly string[];
     required?: boolean;
     title?: string;
     type?: "short" | "single";
  }[];
  questions?: readonly {
     field_name?:   | "state"
        | "phone"
        | "last_name"
        | "address"
        | "city"
        | "country"
        | "zip"
        | "industry"
        | "org"
        | "job_title"
        | "purchasing_time_frame"
        | "role_in_purchase_process"
        | "no_of_employees"
        | "comments";
     required?: boolean;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /meetings/{meetingId}/registrants/questions"`>]

Returns¶

Promise\<{ custom_questions?: readonly { answers?: readonly string[]; required?: boolean; title?: string; type?: "short" | "single"; }[]; questions?: readonly { field_name?: | "state" | "phone" | "last_name" | "address" | "city" | "country" | "zip" | "industry" | "org" | "job_title" | "purchasing_time_frame" | "role_in_purchase_process" | "no_of_employees" | "comments"; required?: boolean; }[]; }>

Inherited from¶

ZoomMeetingsApiInvitationRegistrationGeneratedClient.MeetingRegistrantsQuestionsGet

MeetingRegistrantStatus()¶

MeetingRegistrantStatus(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PUT /meetings/{meetingId}/registrants/status"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiInvitationRegistrationGeneratedClient.MeetingRegistrantStatus

MeetingRTMSStatusUpdate()¶

MeetingRTMSStatusUpdate(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PATCH /live_meetings/{meetingId}/rtms_app/status"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiMeetingsGeneratedClient.MeetingRTMSStatusUpdate

Meetings()¶

Meetings(...args): Promise<{
  next_page_token?: string;
  page_count?: number;
  page_number?: number;
  page_size?: number;
  total_records?: number;
} & {
  meetings?: readonly {
     agenda?: string;
     created_at?: string;
     duration?: number;
     host_id?: string;
     id?: number;
     join_url?: string;
     pmi?: string;
     start_time?: string;
     timezone?: string;
     topic?: string;
     type?: 1 | 2 | 3 | 8;
     uuid?: string;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /users/{userId}/meetings"`>]

Returns¶

Promise\<{ next_page_token?: string; page_count?: number; page_number?: number; page_size?: number; total_records?: number; } & { meetings?: readonly { agenda?: string; created_at?: string; duration?: number; host_id?: string; id?: number; join_url?: string; pmi?: string; start_time?: string; timezone?: string; topic?: string; type?: 1 | 2 | 3 | 8; uuid?: string; }[]; }>

Inherited from¶

ZoomMeetingsApiMeetingsGeneratedClient.Meetings

MeetingStatus()¶

MeetingStatus(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PUT /meetings/{meetingId}/status"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiMeetingsGeneratedClient.MeetingStatus

MeetingSurveyDelete()¶

MeetingSurveyDelete(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"DELETE /meetings/{meetingId}/survey"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiSurveysGeneratedClient.MeetingSurveyDelete

MeetingSurveyGet()¶

MeetingSurveyGet(...args): Promise<{
  custom_survey?: {
     anonymous?: boolean;
     feedback?: string;
     numbered_questions?: boolean;
     questions?: readonly {
        answer_max_character?: number;
        answer_min_character?: number;
        answer_required?: boolean;
        answers?: readonly string[];
        name?: string;
        prompts?: readonly {
           prompt_question?: string;
        }[];
        rating_max_label?: string;
        rating_max_value?: number;
        rating_min_label?: string;
        rating_min_value?: number;
        show_as_dropdown?: boolean;
        type?:   | "single"
           | "multiple"
           | "matching"
           | "rank_order"
           | "short_answer"
           | "long_answer"
           | "fill_in_the_blank"
           | "rating_scale";
     }[];
     show_question_type?: boolean;
     title?: string;
  };
  show_in_the_browser?: boolean;
  third_party_survey?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /meetings/{meetingId}/survey"`>]

Returns¶

Promise\<{ custom_survey?: { anonymous?: boolean; feedback?: string; numbered_questions?: boolean; questions?: readonly { answer_max_character?: number; answer_min_character?: number; answer_required?: boolean; answers?: readonly string[]; name?: string; prompts?: readonly { prompt_question?: string; }[]; rating_max_label?: string; rating_max_value?: number; rating_min_label?: string; rating_min_value?: number; show_as_dropdown?: boolean; type?: | "single" | "multiple" | "matching" | "rank_order" | "short_answer" | "long_answer" | "fill_in_the_blank" | "rating_scale"; }[]; show_question_type?: boolean; title?: string; }; show_in_the_browser?: boolean; third_party_survey?: string; }>

Inherited from¶

ZoomMeetingsApiSurveysGeneratedClient.MeetingSurveyGet

MeetingSurveyUpdate()¶

MeetingSurveyUpdate(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PATCH /meetings/{meetingId}/survey"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiSurveysGeneratedClient.MeetingSurveyUpdate

MeetingTemplateCreate()¶

MeetingTemplateCreate(...args): Promise<{
  id?: string;
  name?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /users/{userId}/meeting_templates"`>]

Returns¶

Promise\<{ id?: string; name?: string; }>

Inherited from¶

ZoomMeetingsApiTemplatesGeneratedClient.MeetingTemplateCreate

MeetingToken()¶

MeetingToken(...args): Promise<{
  token?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /meetings/{meetingId}/token"`>]

Returns¶

Promise\<{ token?: string; }>

Inherited from¶

ZoomMeetingsApiInMeetingFeaturesGeneratedClient.MeetingToken

MeetingUpdate()¶

MeetingUpdate(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PATCH /meetings/{meetingId}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiMeetingsGeneratedClient.MeetingUpdate

PastMeetingDetails()¶

PastMeetingDetails(...args): Promise<{
  dept?: string;
  duration?: number;
  end_time?: string;
  has_meeting_summary?: boolean;
  host_id?: string;
  id?: number;
  participants_count?: number;
  source?: string;
  start_time?: string;
  topic?: string;
  total_minutes?: number;
  type?: 0 | 1 | 2 | 3 | 4 | 7 | 8;
  user_email?: string;
  user_name?: string;
  uuid?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /past_meetings/{meetingId}"`>]

Returns¶

Promise\<{ dept?: string; duration?: number; end_time?: string; has_meeting_summary?: boolean; host_id?: string; id?: number; participants_count?: number; source?: string; start_time?: string; topic?: string; total_minutes?: number; type?: 0 | 1 | 2 | 3 | 4 | 7 | 8; user_email?: string; user_name?: string; uuid?: string; }>

Inherited from¶

ZoomMeetingsApiMeetingsGeneratedClient.PastMeetingDetails

PastMeetingParticipants()¶

PastMeetingParticipants(...args): Promise<{
  next_page_token?: string;
  page_count?: number;
  page_size?: number;
  participants?: readonly {
     duration?: number;
     failover?: boolean;
     id?: string;
     internal_user?: boolean;
     join_time?: string;
     leave_time?: string;
     name?: string;
     registrant_id?: string;
     status?: "in_meeting" | "in_waiting_room";
     user_email?: string;
     user_id?: string;
  }[];
  total_records?: number;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /past_meetings/{meetingId}/participants"`>]

Returns¶

Promise\<{ next_page_token?: string; page_count?: number; page_size?: number; participants?: readonly { duration?: number; failover?: boolean; id?: string; internal_user?: boolean; join_time?: string; leave_time?: string; name?: string; registrant_id?: string; status?: "in_meeting" | "in_waiting_room"; user_email?: string; user_id?: string; }[]; total_records?: number; }>

Inherited from¶

ZoomMeetingsApiMeetingsGeneratedClient.PastMeetingParticipants

PastMeetings()¶

PastMeetings(...args): Promise<{
  meetings?: readonly {
     start_time?: string;
     uuid?: string;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /past_meetings/{meetingId}/instances"`>]

Returns¶

Promise\<{ meetings?: readonly { start_time?: string; uuid?: string; }[]; }>

Inherited from¶

ZoomMeetingsApiMeetingsGeneratedClient.PastMeetings

PastWebinars()¶

PastWebinars(...args): Promise<{
  webinars?: readonly {
     start_time?: string;
     uuid?: string;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /past_webinars/{webinarId}/instances"`>]

Returns¶

Promise\<{ webinars?: readonly { start_time?: string; uuid?: string; }[]; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.PastWebinars

RecordingDelete()¶

RecordingDelete(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"DELETE /meetings/{meetingId}/recordings"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiCloudRecordingGeneratedClient.RecordingDelete

RecordingDeleteOne()¶

RecordingDeleteOne(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"DELETE /meetings/{meetingId}/recordings/{recordingId}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiCloudRecordingGeneratedClient.RecordingDeleteOne

RecordingGet()¶

RecordingGet(...args): Promise<{
  account_id?: string;
  auto_delete?: boolean;
  auto_delete_date?: string;
  duration?: number;
  external_storage_addr?: string;
  host_id?: string;
  id?: number;
  instance_id?: string;
  rc_meeting_zone_name?: string;
  rc_zone?: string;
  recording_count?: number;
  recording_play_passcode?: string;
  service_name?: string;
  start_time?: string;
  topic?: string;
  total_size?: number;
  type?: "2" | "1" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "99";
  uuid?: string;
  zone_instance_id?: string;
} & {
  recording_files?: readonly {
     deleted_time?: string;
     download_url?: string;
     file_extension?: "JSON" | "MP4" | "M4A" | "CSV" | "TXT" | "VTT" | "JPG";
     file_path?: string;
     file_size?: number;
     file_type?:   | "MP4"
        | "M4A"
        | "CHAT"
        | "CC"
        | "CHAT_MESSAGE"
        | "TRANSCRIPT"
        | "CSV"
        | "TB"
        | "SUMMARY";
     id?: string;
     meeting_id?: string;
     play_url?: string;
     recording_end?: string;
     recording_start?: string;
     recording_type?:   | "summary"
        | "shared_screen_with_speaker_view"
        | "audio_only"
        | "chat_file"
        | "closed_caption"
        | "audio_transcript"
        | "shared_screen_with_speaker_view(CC)"
        | "shared_screen_with_gallery_view"
        | "active_speaker"
        | "gallery_view"
        | "shared_screen"
        | "poll"
        | "host_video"
        | "timeline"
        | "thumbnail"
        | "audio_interpretation"
        | "summary_next_steps"
        | "summary_smart_chapters"
        | "sign_interpretation"
        | "production_studio";
     status?: "completed";
  }[];
} & {
  download_access_token?: string;
  password?: string;
  recording_play_passcode?: string;
} & {
  participant_audio_files?: readonly {
     download_url?: string;
     file_name?: string;
     file_path?: string;
     file_size?: number;
     file_type?: string;
     id?: string;
     play_url?: string;
     recording_end?: string;
     recording_start?: string;
     status?: "completed";
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /meetings/{meetingId}/recordings"`>]

Returns¶

Promise\<{ account_id?: string; auto_delete?: boolean; auto_delete_date?: string; duration?: number; external_storage_addr?: string; host_id?: string; id?: number; instance_id?: string; rc_meeting_zone_name?: string; rc_zone?: string; recording_count?: number; recording_play_passcode?: string; service_name?: string; start_time?: string; topic?: string; total_size?: number; type?: "2" | "1" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "99"; uuid?: string; zone_instance_id?: string; } & { recording_files?: readonly { deleted_time?: string; download_url?: string; file_extension?: "JSON" | "MP4" | "M4A" | "CSV" | "TXT" | "VTT" | "JPG"; file_path?: string; file_size?: number; file_type?: | "MP4" | "M4A" | "CHAT" | "CC" | "CHAT_MESSAGE" | "TRANSCRIPT" | "CSV" | "TB" | "SUMMARY"; id?: string; meeting_id?: string; play_url?: string; recording_end?: string; recording_start?: string; recording_type?: | "summary" | "shared_screen_with_speaker_view" | "audio_only" | "chat_file" | "closed_caption" | "audio_transcript" | "shared_screen_with_speaker_view(CC)" | "shared_screen_with_gallery_view" | "active_speaker" | "gallery_view" | "shared_screen" | "poll" | "host_video" | "timeline" | "thumbnail" | "audio_interpretation" | "summary_next_steps" | "summary_smart_chapters" | "sign_interpretation" | "production_studio"; status?: "completed"; }[]; } & { download_access_token?: string; password?: string; recording_play_passcode?: string; } & { participant_audio_files?: readonly { download_url?: string; file_name?: string; file_path?: string; file_size?: number; file_type?: string; id?: string; play_url?: string; recording_end?: string; recording_start?: string; status?: "completed"; }[]; }>

Inherited from¶

ZoomMeetingsApiCloudRecordingGeneratedClient.RecordingGet

RecordingRegistrantQuestionUpdate()¶

RecordingRegistrantQuestionUpdate(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PATCH /meetings/{meetingId}/recordings/registrants/questions"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiCloudRecordingGeneratedClient.RecordingRegistrantQuestionUpdate

RecordingRegistrantsQuestionsGet()¶

RecordingRegistrantsQuestionsGet(...args): Promise<{
  custom_questions?: readonly {
     answers?: readonly string[];
     required?: boolean;
     title?: string;
     type?: "short" | "single" | "multiple";
  }[];
  questions?: readonly {
     field_name?:   | "state"
        | "phone"
        | "last_name"
        | "address"
        | "city"
        | "country"
        | "zip"
        | "industry"
        | "org"
        | "job_title"
        | "purchasing_time_frame"
        | "role_in_purchase_process"
        | "no_of_employees"
        | "comments";
     required?: boolean;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /meetings/{meetingId}/recordings/registrants/questions"`>]

Returns¶

Promise\<{ custom_questions?: readonly { answers?: readonly string[]; required?: boolean; title?: string; type?: "short" | "single" | "multiple"; }[]; questions?: readonly { field_name?: | "state" | "phone" | "last_name" | "address" | "city" | "country" | "zip" | "industry" | "org" | "job_title" | "purchasing_time_frame" | "role_in_purchase_process" | "no_of_employees" | "comments"; required?: boolean; }[]; }>

Inherited from¶

ZoomMeetingsApiCloudRecordingGeneratedClient.RecordingRegistrantsQuestionsGet

RecordingSettingsUpdate()¶

RecordingSettingsUpdate(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PATCH /meetings/{meetingId}/recordings/settings"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiCloudRecordingGeneratedClient.RecordingSettingsUpdate

RecordingSettingUpdate()¶

RecordingSettingUpdate(...args): Promise<{
  approval_type?: 0 | 1 | 2;
  authentication_domains?: string;
  authentication_name?: string;
  authentication_option?: string;
  auto_delete?: boolean;
  auto_delete_date?: string;
  on_demand?: boolean;
  password?: string;
  recording_authentication?: boolean;
  send_email_to_host?: boolean;
  share_recording?: "none" | "publicly" | "internally";
  show_social_share_buttons?: boolean;
  topic?: string;
  viewer_download?: boolean;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /meetings/{meetingId}/recordings/settings"`>]

Returns¶

Promise\<{ approval_type?: 0 | 1 | 2; authentication_domains?: string; authentication_name?: string; authentication_option?: string; auto_delete?: boolean; auto_delete_date?: string; on_demand?: boolean; password?: string; recording_authentication?: boolean; send_email_to_host?: boolean; share_recording?: "none" | "publicly" | "internally"; show_social_share_buttons?: boolean; topic?: string; viewer_download?: boolean; }>

Inherited from¶

ZoomMeetingsApiCloudRecordingGeneratedClient.RecordingSettingUpdate

RecordingsList()¶

RecordingsList(...args): Promise<{
  from?: string;
  to?: string;
} & {
  next_page_token?: string;
  page_count?: number;
  page_size?: number;
  total_records?: number;
} & {
  meetings?: readonly {
     account_id?: string;
     auto_delete?: boolean;
     auto_delete_date?: string;
     duration?: number;
     host_id?: string;
     id?: number;
     recording_count?: number;
     recording_play_passcode?: string;
     start_time?: string;
     topic?: string;
     total_size?: number;
     type?: "2" | "1" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "99";
     uuid?: string;
   } & {
     recording_files?: readonly {
        deleted_time?: string;
        download_url?: string;
        file_extension?: "JSON" | "MP4" | "M4A" | "CSV" | "TXT" | "VTT" | "JPG";
        file_path?: string;
        file_size?: number;
        file_type?:   | "MP4"
           | "M4A"
           | "CHAT"
           | "CC"
           | "CHAT_MESSAGE"
           | "TRANSCRIPT"
           | "CSV"
           | "TB"
           | "SUMMARY";
        id?: string;
        meeting_id?: string;
        play_url?: string;
        recording_end?: string;
        recording_start?: string;
        recording_type?:   | "summary"
           | "shared_screen_with_speaker_view"
           | "audio_only"
           | "chat_file"
           | "closed_caption"
           | "audio_transcript"
           | "shared_screen_with_speaker_view(CC)"
           | "shared_screen_with_gallery_view"
           | "active_speaker"
           | "gallery_view"
           | "shared_screen"
           | "poll"
           | "host_video"
           | "timeline"
           | "thumbnail"
           | "audio_interpretation"
           | "summary_next_steps"
           | "summary_smart_chapters"
           | "sign_interpretation"
           | "production_studio";
        status?: "completed";
     }[];
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /users/{userId}/recordings"`>]

Returns¶

Promise\<{ from?: string; to?: string; } & { next_page_token?: string; page_count?: number; page_size?: number; total_records?: number; } & { meetings?: readonly { account_id?: string; auto_delete?: boolean; auto_delete_date?: string; duration?: number; host_id?: string; id?: number; recording_count?: number; recording_play_passcode?: string; start_time?: string; topic?: string; total_size?: number; type?: "2" | "1" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "99"; uuid?: string; } & { recording_files?: readonly { deleted_time?: string; download_url?: string; file_extension?: "JSON" | "MP4" | "M4A" | "CSV" | "TXT" | "VTT" | "JPG"; file_path?: string; file_size?: number; file_type?: | "MP4" | "M4A" | "CHAT" | "CC" | "CHAT_MESSAGE" | "TRANSCRIPT" | "CSV" | "TB" | "SUMMARY"; id?: string; meeting_id?: string; play_url?: string; recording_end?: string; recording_start?: string; recording_type?: | "summary" | "shared_screen_with_speaker_view" | "audio_only" | "chat_file" | "closed_caption" | "audio_transcript" | "shared_screen_with_speaker_view(CC)" | "shared_screen_with_gallery_view" | "active_speaker" | "gallery_view" | "shared_screen" | "poll" | "host_video" | "timeline" | "thumbnail" | "audio_interpretation" | "summary_next_steps" | "summary_smart_chapters" | "sign_interpretation" | "production_studio"; status?: "completed"; }[]; }[]; }>

Inherited from¶

ZoomMeetingsApiCloudRecordingGeneratedClient.RecordingsList

RecordingStatusUpdate()¶

RecordingStatusUpdate(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PUT /meetings/{meetingUUID}/recordings/status"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiCloudRecordingGeneratedClient.RecordingStatusUpdate

RecordingStatusUpdateOne()¶

RecordingStatusUpdateOne(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PUT /meetings/{meetingId}/recordings/{recordingId}/status"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiCloudRecordingGeneratedClient.RecordingStatusUpdateOne

ReportCloudRecording()¶

ReportCloudRecording(...args): Promise<{
  from?: string;
  to?: string;
} & {
  cloud_recording_storage?: readonly {
     date?: string;
     free_usage?: string;
     plan_usage?: string;
     usage?: string;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /report/cloud_recording"`>]

Returns¶

Promise\<{ from?: string; to?: string; } & { cloud_recording_storage?: readonly { date?: string; free_usage?: string; plan_usage?: string; usage?: string; }[]; }>

Inherited from¶

ZoomMeetingsApiReportsGeneratedClient.ReportCloudRecording

ReportDaily()¶

ReportDaily(...args): Promise<{
  dates?: readonly {
     date?: string;
     meeting_minutes?: number;
     meetings?: number;
     new_users?: number;
     participants?: number;
  }[];
  month?: number;
  year?: number;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /report/daily"`>]

Returns¶

Promise\<{ dates?: readonly { date?: string; meeting_minutes?: number; meetings?: number; new_users?: number; participants?: number; }[]; month?: number; year?: number; }>

Inherited from¶

ZoomMeetingsApiReportsGeneratedClient.ReportDaily

ReportMeetingactivitylogs()¶

ReportMeetingactivitylogs(...args): Promise<{
  meeting_activity_logs?: readonly {
     activity_category: string;
     activity_detail: string;
     activity_time: string;
     meeting_number: string;
     operator: string;
     operator_email: string;
  }[];
  next_page_token?: string;
  page_size?: number;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /report/meeting_activities"`>]

Returns¶

Promise\<{ meeting_activity_logs?: readonly { activity_category: string; activity_detail: string; activity_time: string; meeting_number: string; operator: string; operator_email: string; }[]; next_page_token?: string; page_size?: number; }>

Inherited from¶

ZoomMeetingsApiReportsGeneratedClient.ReportMeetingactivitylogs

ReportMeetingDetails()¶

ReportMeetingDetails(...args): Promise<{
  custom_keys?: readonly {
     key?: string;
     value?: string;
  }[];
  dept?: string;
  duration?: number;
  end_time?: string;
  id?: number;
  participants_count?: number;
  start_time?: string;
  topic?: string;
  total_minutes?: number;
  tracking_fields?: readonly {
     field?: string;
     value?: string;
  }[];
  type?: number;
  user_email?: string;
  user_name?: string;
  uuid?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /report/meetings/{meetingId}"`>]

Returns¶

Promise\<{ custom_keys?: readonly { key?: string; value?: string; }[]; dept?: string; duration?: number; end_time?: string; id?: number; participants_count?: number; start_time?: string; topic?: string; total_minutes?: number; tracking_fields?: readonly { field?: string; value?: string; }[]; type?: number; user_email?: string; user_name?: string; uuid?: string; }>

Inherited from¶

ZoomMeetingsApiReportsGeneratedClient.ReportMeetingDetails

ReportMeetingParticipants()¶

ReportMeetingParticipants(...args): Promise<{
  next_page_token?: string;
  page_count?: number;
  page_size?: number;
  total_records?: number;
} & {
  participants?: readonly {
     bo_mtg_id?: string;
     customer_key?: string;
     duration?: number;
     failover?: boolean;
     id?: string;
     join_time?: string;
     leave_time?: string;
     name?: string;
     participant_user_id?: string;
     registrant_id?: string;
     status?: "in_meeting" | "in_waiting_room";
     user_email?: string;
     user_id?: string;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /report/meetings/{meetingId}/participants"`>]

Returns¶

Promise\<{ next_page_token?: string; page_count?: number; page_size?: number; total_records?: number; } & { participants?: readonly { bo_mtg_id?: string; customer_key?: string; duration?: number; failover?: boolean; id?: string; join_time?: string; leave_time?: string; name?: string; participant_user_id?: string; registrant_id?: string; status?: "in_meeting" | "in_waiting_room"; user_email?: string; user_id?: string; }[]; }>

Inherited from¶

ZoomMeetingsApiReportsGeneratedClient.ReportMeetingParticipants

ReportMeetingPolls()¶

ReportMeetingPolls(...args): Promise<{
  id?: number;
  questions?: readonly {
     email?: string;
     first_name?: string;
     last_name?: string;
     name?: string;
     question_details?: readonly {
        answer?: string;
        date_time?: string;
        polling_id?: string;
        question?: string;
     }[];
  }[];
  start_time?: string;
  uuid?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /report/meetings/{meetingId}/polls"`>]

Returns¶

Promise\<{ id?: number; questions?: readonly { email?: string; first_name?: string; last_name?: string; name?: string; question_details?: readonly { answer?: string; date_time?: string; polling_id?: string; question?: string; }[]; }[]; start_time?: string; uuid?: string; }>

Inherited from¶

ZoomMeetingsApiReportsGeneratedClient.ReportMeetingPolls

ReportMeetingQA()¶

ReportMeetingQA(...args): Promise<{
  id?: number;
  questions?: readonly {
     email?: string;
     name?: string;
     question_details?: readonly {
        answer?: string;
        answer_details?: readonly {
           content?: string;
           create_time?: string;
           email?: string;
           name?: string;
           type?:   | "default"
              | "host_answered_publicly"
              | "host_answered_privately"
              | "participant_commented"
              | "host_answered";
           user_id?: string;
        }[];
        create_time?: string;
        question?: string;
        question_id?: string;
        question_status?: "open" | "answered" | "default" | "deleted" | "dismissed";
     }[];
     user_id?: string;
  }[];
  start_time?: string;
  uuid?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /report/meetings/{meetingId}/qa"`>]

Returns¶

Promise\<{ id?: number; questions?: readonly { email?: string; name?: string; question_details?: readonly { answer?: string; answer_details?: readonly { content?: string; create_time?: string; email?: string; name?: string; type?: | "default" | "host_answered_publicly" | "host_answered_privately" | "participant_commented" | "host_answered"; user_id?: string; }[]; create_time?: string; question?: string; question_id?: string; question_status?: "open" | "answered" | "default" | "deleted" | "dismissed"; }[]; user_id?: string; }[]; start_time?: string; uuid?: string; }>

Inherited from¶

ZoomMeetingsApiReportsGeneratedClient.ReportMeetingQA

ReportMeetings()¶

ReportMeetings(...args): Promise<{
  next_page_token?: string;
  page_count?: number;
  page_number?: number;
  page_size?: number;
  total_records?: number;
} & {
  from?: string;
  meetings?: readonly {
     custom_keys?: readonly {
        key?: string;
        value?: string;
     }[];
     duration?: number;
     end_time?: string;
     has_chat?: boolean;
     has_recording?: boolean;
     has_screen_share?: boolean;
     host_name?: string;
     host_organization?: string;
     id?: number;
     join_time?: string;
     join_waiting_room_time?: string;
     leave_time?: string;
     meeting_encryption_status?: 1 | 2;
     participants_count?: number;
     participants_count_my_account?: number;
     schedule_time?: string;
     session_key?: string;
     source?: string;
     start_time?: string;
     topic?: string;
     total_minutes?: number;
     type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
     user_email?: string;
     user_name?: string;
     uuid?: string;
  }[];
  next_page_token?: string;
  to?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /report/users/{userId}/meetings"`>]

Returns¶

Promise\<{ next_page_token?: string; page_count?: number; page_number?: number; page_size?: number; total_records?: number; } & { from?: string; meetings?: readonly { custom_keys?: readonly { key?: string; value?: string; }[]; duration?: number; end_time?: string; has_chat?: boolean; has_recording?: boolean; has_screen_share?: boolean; host_name?: string; host_organization?: string; id?: number; join_time?: string; join_waiting_room_time?: string; leave_time?: string; meeting_encryption_status?: 1 | 2; participants_count?: number; participants_count_my_account?: number; schedule_time?: string; session_key?: string; source?: string; start_time?: string; topic?: string; total_minutes?: number; type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9; user_email?: string; user_name?: string; uuid?: string; }[]; next_page_token?: string; to?: string; }>

Inherited from¶

ZoomMeetingsApiReportsGeneratedClient.ReportMeetings

ReportMeetingSurvey()¶

ReportMeetingSurvey(...args): Promise<{
  meeting_id?: number;
  meeting_uuid?: string;
  start_time?: string;
  survey_answers?: readonly {
     answer_details?: readonly {
        answer?: string;
        date_time?: string;
        question?: string;
        question_id?: string;
     }[];
     email?: string;
     first_name?: string;
     last_name?: string;
     name?: string;
  }[];
  survey_id?: string;
  survey_name?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /report/meetings/{meetingId}/survey"`>]

Returns¶

Promise\<{ meeting_id?: number; meeting_uuid?: string; start_time?: string; survey_answers?: readonly { answer_details?: readonly { answer?: string; date_time?: string; question?: string; question_id?: string; }[]; email?: string; first_name?: string; last_name?: string; name?: string; }[]; survey_id?: string; survey_name?: string; }>

Inherited from¶

ZoomMeetingsApiReportsGeneratedClient.ReportMeetingSurvey

ReportOperationLogs()¶

ReportOperationLogs(...args): Promise<{
  next_page_token?: string;
  page_size?: number;
} & {
  operation_logs?: readonly {
     action?: string;
     category_type?: string;
     operation_detail?: string;
     operator?: string;
     time?: string;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /report/operationlogs"`>]

Returns¶

Promise\<{ next_page_token?: string; page_size?: number; } & { operation_logs?: readonly { action?: string; category_type?: string; operation_detail?: string; operator?: string; time?: string; }[]; }>

Inherited from¶

ZoomMeetingsApiReportsGeneratedClient.ReportOperationLogs

ReportSignInSignOutActivities()¶

ReportSignInSignOutActivities(...args): Promise<{
  activity_logs?: readonly {
     client_type?: string;
     email?: string;
     ip_address?: string;
     time?: string;
     type?: "Sign in" | "Sign out";
     version?: string;
  }[];
  from?: string;
  next_page_token?: string;
  page_size?: number;
  to?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /report/activities"`>]

Returns¶

Promise\<{ activity_logs?: readonly { client_type?: string; email?: string; ip_address?: string; time?: string; type?: "Sign in" | "Sign out"; version?: string; }[]; from?: string; next_page_token?: string; page_size?: number; to?: string; }>

Inherited from¶

ZoomMeetingsApiReportsGeneratedClient.ReportSignInSignOutActivities

ReportTelephone()¶

ReportTelephone(...args): Promise<{
  from?: string;
  next_page_token?: string;
  page_count?: number;
  page_size?: number;
  to?: string;
  total_records?: number;
} & {
  telephony_usage?: readonly {
     call_in_number?: string;
     country_name?: string;
     dept?: string;
     duration?: number;
     end_time?: string;
     host_email?: string;
     host_id?: string;
     host_name?: string;
     meeting_id?: number;
     meeting_type?: string;
     phone_number?: string;
     rate?: number;
     signaled_number?: string;
     start_time?: string;
     total?: number;
     type?:   | "toll-free"
        | "call-out"
        | "call-in"
        | "US toll-number"
        | "global toll-number"
        | "premium"
        | "premium call-in"
        | "Toll";
     uuid?: string;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /report/telephone"`>]

Returns¶

Promise\<{ from?: string; next_page_token?: string; page_count?: number; page_size?: number; to?: string; total_records?: number; } & { telephony_usage?: readonly { call_in_number?: string; country_name?: string; dept?: string; duration?: number; end_time?: string; host_email?: string; host_id?: string; host_name?: string; meeting_id?: number; meeting_type?: string; phone_number?: string; rate?: number; signaled_number?: string; start_time?: string; total?: number; type?: | "toll-free" | "call-out" | "call-in" | "US toll-number" | "global toll-number" | "premium" | "premium call-in" | "Toll"; uuid?: string; }[]; }>

Inherited from¶

ZoomMeetingsApiReportsGeneratedClient.ReportTelephone

ReportUpcomingEvents()¶

ReportUpcomingEvents(...args): Promise<{
  from?: string;
  next_page_token?: string;
  page_size?: number;
  to?: string;
  upcoming_events?: readonly {
     dept?: string;
     host_id?: string;
     host_name?: string;
     id?: string;
     start_time?: string;
     topic?: string;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /report/upcoming_events"`>]

Returns¶

Promise\<{ from?: string; next_page_token?: string; page_size?: number; to?: string; upcoming_events?: readonly { dept?: string; host_id?: string; host_name?: string; id?: string; start_time?: string; topic?: string; }[]; }>

Inherited from¶

ZoomMeetingsApiReportsGeneratedClient.ReportUpcomingEvents

ReportUsers()¶

ReportUsers(...args): Promise<{
  from?: string;
  next_page_token?: string;
  page_count?: number;
  page_number?: number;
  page_size?: number;
  to?: string;
  total_records?: number;
} & {
  total_meeting_minutes?: number;
  total_meetings?: number;
  total_participants?: number;
  users?: readonly {
     custom_attributes?: readonly {
        key?: string;
        name?: string;
        value?: string;
     }[];
     dept?: string;
     email?: string;
     id?: string;
     meeting_minutes?: number;
     meetings?: number;
     participants?: number;
     type?: number;
     user_name?: string;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /report/users"`>]

Returns¶

Promise\<{ from?: string; next_page_token?: string; page_count?: number; page_number?: number; page_size?: number; to?: string; total_records?: number; } & { total_meeting_minutes?: number; total_meetings?: number; total_participants?: number; users?: readonly { custom_attributes?: readonly { key?: string; name?: string; value?: string; }[]; dept?: string; email?: string; id?: string; meeting_minutes?: number; meetings?: number; participants?: number; type?: number; user_name?: string; }[]; }>

Inherited from¶

ZoomMeetingsApiReportsGeneratedClient.ReportUsers

ReportWebinarDetails()¶

ReportWebinarDetails(...args): Promise<{
  custom_keys?: readonly {
     key?: string;
     value?: string;
  }[];
  dept?: string;
  duration?: number;
  end_time?: string;
  id?: number;
  participants_count?: number;
  start_time?: string;
  topic?: string;
  total_minutes?: number;
  tracking_fields?: readonly {
     field?: string;
     value?: string;
  }[];
  type?: number;
  user_email?: string;
  user_name?: string;
  uuid?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /report/webinars/{webinarId}"`>]

Returns¶

Promise\<{ custom_keys?: readonly { key?: string; value?: string; }[]; dept?: string; duration?: number; end_time?: string; id?: number; participants_count?: number; start_time?: string; topic?: string; total_minutes?: number; tracking_fields?: readonly { field?: string; value?: string; }[]; type?: number; user_email?: string; user_name?: string; uuid?: string; }>

Inherited from¶

ZoomMeetingsApiReportsGeneratedClient.ReportWebinarDetails

ReportWebinarParticipants()¶

ReportWebinarParticipants(...args): Promise<{
  next_page_token?: string;
  page_count?: number;
  page_size?: number;
  total_records?: number;
} & {
  participants?: readonly {
     bo_mtg_id?: string;
     customer_key?: string;
     duration?: number;
     failover?: boolean;
     id?: string;
     join_time?: string;
     leave_time?: string;
     name?: string;
     participant_user_id?: string;
     registrant_id?: string;
     status?: "in_meeting" | "in_waiting_room";
     user_email?: string;
     user_id?: string;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /report/webinars/{webinarId}/participants"`>]

Returns¶

Promise\<{ next_page_token?: string; page_count?: number; page_size?: number; total_records?: number; } & { participants?: readonly { bo_mtg_id?: string; customer_key?: string; duration?: number; failover?: boolean; id?: string; join_time?: string; leave_time?: string; name?: string; participant_user_id?: string; registrant_id?: string; status?: "in_meeting" | "in_waiting_room"; user_email?: string; user_id?: string; }[]; }>

Inherited from¶

ZoomMeetingsApiReportsGeneratedClient.ReportWebinarParticipants

ReportWebinarPolls()¶

ReportWebinarPolls(...args): Promise<{
  id?: number;
  questions?: readonly {
     email?: string;
     first_name?: string;
     last_name?: string;
     name?: string;
     question_details?: readonly {
        answer?: string;
        date_time?: string;
        polling_id?: string;
        question?: string;
     }[];
  }[];
  start_time?: string;
  uuid?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /report/webinars/{webinarId}/polls"`>]

Returns¶

Promise\<{ id?: number; questions?: readonly { email?: string; first_name?: string; last_name?: string; name?: string; question_details?: readonly { answer?: string; date_time?: string; polling_id?: string; question?: string; }[]; }[]; start_time?: string; uuid?: string; }>

Inherited from¶

ZoomMeetingsApiReportsGeneratedClient.ReportWebinarPolls

ReportWebinarQA()¶

ReportWebinarQA(...args): Promise<{
  id?: number;
  questions?: readonly {
     email?: string;
     name?: string;
     question_details?: readonly {
        answer?: string;
        answer_details?: readonly {
           content?: string;
           create_time?: string;
           email?: string;
           name?: string;
           type?:   | "default"
              | "host_answered_publicly"
              | "host_answered_privately"
              | "participant_commented"
              | "host_answered";
           user_id?: string;
        }[];
        create_time?: string;
        question?: string;
        question_id?: string;
        question_status?: "open" | "answered" | "default" | "deleted" | "dismissed";
     }[];
     user_id?: string;
  }[];
  start_time?: string;
  uuid?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /report/webinars/{webinarId}/qa"`>]

Returns¶

Promise\<{ id?: number; questions?: readonly { email?: string; name?: string; question_details?: readonly { answer?: string; answer_details?: readonly { content?: string; create_time?: string; email?: string; name?: string; type?: | "default" | "host_answered_publicly" | "host_answered_privately" | "participant_commented" | "host_answered"; user_id?: string; }[]; create_time?: string; question?: string; question_id?: string; question_status?: "open" | "answered" | "default" | "deleted" | "dismissed"; }[]; user_id?: string; }[]; start_time?: string; uuid?: string; }>

Inherited from¶

ZoomMeetingsApiReportsGeneratedClient.ReportWebinarQA

ReportWebinarSurvey()¶

ReportWebinarSurvey(...args): Promise<{
  start_time?: string;
  survey_answers?: readonly {
     answer_details?: readonly {
        answer?: string;
        date_time?: string;
        question?: string;
        question_id?: string;
     }[];
     email?: string;
     first_name?: string;
     last_name?: string;
     name?: string;
  }[];
  survey_id?: string;
  survey_name?: string;
  webinar_id?: number;
  webinar_uuid?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /report/webinars/{webinarId}/survey"`>]

Returns¶

Promise\<{ start_time?: string; survey_answers?: readonly { answer_details?: readonly { answer?: string; date_time?: string; question?: string; question_id?: string; }[]; email?: string; first_name?: string; last_name?: string; name?: string; }[]; survey_id?: string; survey_name?: string; webinar_id?: number; webinar_uuid?: string; }>

Inherited from¶

ZoomMeetingsApiReportsGeneratedClient.ReportWebinarSurvey

SetWebinarBrandingVB()¶

SetWebinarBrandingVB(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PATCH /webinars/{webinarId}/branding/virtual_backgrounds"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.SetWebinarBrandingVB

TrackingfieldCreate()¶

TrackingfieldCreate(...args): Promise<{
  id?: string;
} & {
  field?: string;
  recommended_values?: readonly string[];
  required?: boolean;
  visible?: boolean;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /tracking_fields"`>]

Returns¶

Promise\<{ id?: string; } & { field?: string; recommended_values?: readonly string[]; required?: boolean; visible?: boolean; }>

Inherited from¶

ZoomMeetingsApiTrackingFieldGeneratedClient.TrackingfieldCreate

TrackingfieldDelete()¶

TrackingfieldDelete(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"DELETE /tracking_fields/{fieldId}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiTrackingFieldGeneratedClient.TrackingfieldDelete

TrackingfieldGet()¶

TrackingfieldGet(...args): Promise<{
  field?: string;
  id?: string;
  recommended_values?: readonly string[];
  required?: boolean;
  visible?: boolean;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /tracking_fields/{fieldId}"`>]

Returns¶

Promise\<{ field?: string; id?: string; recommended_values?: readonly string[]; required?: boolean; visible?: boolean; }>

Inherited from¶

ZoomMeetingsApiTrackingFieldGeneratedClient.TrackingfieldGet

TrackingfieldList()¶

TrackingfieldList(...args): Promise<{
  total_records?: number;
  tracking_fields?: readonly {
     field?: string;
     id?: string;
     recommended_values?: readonly string[];
     required?: boolean;
     visible?: boolean;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /tracking_fields"`>]

Returns¶

Promise\<{ total_records?: number; tracking_fields?: readonly { field?: string; id?: string; recommended_values?: readonly string[]; required?: boolean; visible?: boolean; }[]; }>

Inherited from¶

ZoomMeetingsApiTrackingFieldGeneratedClient.TrackingfieldList

TrackingfieldUpdate()¶

TrackingfieldUpdate(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PATCH /tracking_fields/{fieldId}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiTrackingFieldGeneratedClient.TrackingfieldUpdate

Tsp()¶

Tsp(...args): Promise<{
  dial_in_number_unrestricted?: boolean;
  dial_in_numbers?: readonly {
     code?: string;
     number?: string;
     type?: string;
  }[];
  enable?: boolean;
  master_account_setting_extended?: boolean;
  modify_credential_forbidden?: boolean;
  tsp_bridge?: "US_TSP_TB" | "EU_TSP_TB";
  tsp_enabled?: boolean;
  tsp_provider?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /tsp"`>]

Returns¶

Promise\<{ dial_in_number_unrestricted?: boolean; dial_in_numbers?: readonly { code?: string; number?: string; type?: string; }[]; enable?: boolean; master_account_setting_extended?: boolean; modify_credential_forbidden?: boolean; tsp_bridge?: "US_TSP_TB" | "EU_TSP_TB"; tsp_enabled?: boolean; tsp_provider?: string; }>

Inherited from¶

ZoomMeetingsApiTSPGeneratedClient.Tsp

TspUpdate()¶

TspUpdate(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PATCH /tsp"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiTSPGeneratedClient.TspUpdate

TspUrlUpdate()¶

TspUrlUpdate(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PATCH /users/{userId}/tsp/settings"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiTSPGeneratedClient.TspUrlUpdate

UpdateArchivedFile()¶

UpdateArchivedFile(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PATCH /archive_files/{fileId}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiArchivingGeneratedClient.UpdateArchivedFile

UpdateDevice()¶

UpdateDevice(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PATCH /devices/{deviceId}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiDevicesGeneratedClient.UpdateDevice

UpdateMeetingChatMessageById()¶

UpdateMeetingChatMessageById(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PATCH /live_meetings/{meetingId}/chat/messages/{messageId}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiInMeetingFeaturesGeneratedClient.UpdateMeetingChatMessageById

UpdateSIPPhonePhones()¶

UpdateSIPPhonePhones(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PATCH /sip_phones/phones/{phoneId}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiSIPPhoneGeneratedClient.UpdateSIPPhonePhones

UpdateWebinarBrandingNameTag()¶

UpdateWebinarBrandingNameTag(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PATCH /webinars/{webinarId}/branding/name_tags/{nameTagId}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.UpdateWebinarBrandingNameTag

UpgradeZpasApp()¶

UpgradeZpasApp(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /devices/zpa/upgrade"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiDevicesGeneratedClient.UpgradeZpasApp

UploadWebinarBrandingVB()¶

UploadWebinarBrandingVB(...args): Promise<{
  id?: string;
  is_default?: boolean;
  name?: string;
  size?: number;
  type?: "image";
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /webinars/{webinarId}/branding/virtual_backgrounds"`>]

Returns¶

Promise\<{ id?: string; is_default?: boolean; name?: string; size?: number; type?: "image"; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.UploadWebinarBrandingVB

UploadWebinarBrandingWallpaper()¶

UploadWebinarBrandingWallpaper(...args): Promise<{
  id?: string;
  name?: string;
  size?: number;
  type?: "image";
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /webinars/{webinarId}/branding/wallpaper"`>]

Returns¶

Promise\<{ id?: string; name?: string; size?: number; type?: "image"; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.UploadWebinarBrandingWallpaper

UserPACs()¶

UserPACs(...args): Promise<{
  pac_accounts?: readonly {
     conference_id?: number;
     dedicated_dial_in_number?: readonly {
        country?: string;
        number?: string;
     }[];
     global_dial_in_numbers?: readonly {
        country?: string;
        number?: string;
     }[];
     listen_only_password?: string;
     participant_password?: string;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /users/{userId}/pac"`>]

Returns¶

Promise\<{ pac_accounts?: readonly { conference_id?: number; dedicated_dial_in_number?: readonly { country?: string; number?: string; }[]; global_dial_in_numbers?: readonly { country?: string; number?: string; }[]; listen_only_password?: string; participant_password?: string; }[]; }>

Inherited from¶

ZoomMeetingsApiPACGeneratedClient.UserPACs

UserTSP()¶

UserTSP(...args): Promise<{
  conference_code: string;
  dial_in_numbers?: readonly {
     code?: string;
     country_label?: string;
     number?: string;
     type?: "toll" | "tollfree" | "media_link";
  }[];
  id?: string;
  leader_pin: string;
  tsp_bridge?: "US_TSP_TB" | "EU_TSP_TB";
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /users/{userId}/tsp/{tspId}"`>]

Returns¶

Promise\<{ conference_code: string; dial_in_numbers?: readonly { code?: string; country_label?: string; number?: string; type?: "toll" | "tollfree" | "media_link"; }[]; id?: string; leader_pin: string; tsp_bridge?: "US_TSP_TB" | "EU_TSP_TB"; }>

Inherited from¶

ZoomMeetingsApiTSPGeneratedClient.UserTSP

UserTSPCreate()¶

UserTSPCreate(...args): Promise<{
  id?: string;
} & {
  conference_code: string;
  dial_in_numbers?: readonly {
     code?: string;
     country_label?: string;
     number?: string;
     type?: "toll" | "tollfree" | "media_link";
  }[];
  leader_pin: string;
  tsp_bridge?: "US_TSP_TB" | "EU_TSP_TB";
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /users/{userId}/tsp"`>]

Returns¶

Promise\<{ id?: string; } & { conference_code: string; dial_in_numbers?: readonly { code?: string; country_label?: string; number?: string; type?: "toll" | "tollfree" | "media_link"; }[]; leader_pin: string; tsp_bridge?: "US_TSP_TB" | "EU_TSP_TB"; }>

Inherited from¶

ZoomMeetingsApiTSPGeneratedClient.UserTSPCreate

UserTSPDelete()¶

UserTSPDelete(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"DELETE /users/{userId}/tsp/{tspId}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiTSPGeneratedClient.UserTSPDelete

UserTSPs()¶

UserTSPs(...args): Promise<{
  tsp_accounts?: readonly {
     conference_code: string;
     dial_in_numbers?: readonly {
        code?: string;
        country_label?: string;
        number?: string;
        type?: "toll" | "tollfree" | "media_link";
     }[];
     id?: "2" | "1";
     leader_pin: string;
     tsp_bridge?: "US_TSP_TB" | "EU_TSP_TB";
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /users/{userId}/tsp"`>]

Returns¶

Promise\<{ tsp_accounts?: readonly { conference_code: string; dial_in_numbers?: readonly { code?: string; country_label?: string; number?: string; type?: "toll" | "tollfree" | "media_link"; }[]; id?: "2" | "1"; leader_pin: string; tsp_bridge?: "US_TSP_TB" | "EU_TSP_TB"; }[]; }>

Inherited from¶

ZoomMeetingsApiTSPGeneratedClient.UserTSPs

UserTSPUpdate()¶

UserTSPUpdate(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PATCH /users/{userId}/tsp/{tspId}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiTSPGeneratedClient.UserTSPUpdate

Webinar()¶

Webinar(...args): Promise<{
  agenda?: string;
  created_at?: string;
  creation_source?: "other" | "open_api" | "web_portal";
  duration?: number;
  encrypted_passcode?: string;
  h323_passcode?: string;
  host_email?: string;
  host_id?: string;
  id?: number;
  is_simulive?: boolean;
  join_url?: string;
  occurrences?: readonly {
     duration?: number;
     occurrence_id?: string;
     start_time?: string;
     status?: "available" | "deleted";
  }[];
  password?: string;
  record_file_id?: string;
  recurrence?: {
     end_date_time?: string;
     end_times?: number;
     monthly_day?: number;
     monthly_week?: -1 | 1 | 2 | 3 | 4;
     monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
     repeat_interval?: number;
     type: 1 | 2 | 3;
     weekly_days?: string;
  };
  registration_url?: string;
  settings?: {
     add_audio_watermark?: boolean;
     add_watermark?: boolean;
     additional_data_center_regions?: readonly string[];
     allow_host_control_participant_mute_state?: boolean;
     allow_multiple_devices?: boolean;
     alternative_host_update_polls?: boolean;
     alternative_hosts?: string;
     approval_type?: 0 | 1 | 2;
     attendees_and_panelists_reminder_email_notification?: {
        enable?: boolean;
        type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
     };
     audio?: "both" | "telephony" | "voip" | "thirdParty";
     audio_conference_info?: string;
     authentication_domains?: string;
     authentication_name?: string;
     authentication_option?: string;
     auto_recording?: "none" | "local" | "cloud";
     close_registration?: boolean;
     contact_email?: string;
     contact_name?: string;
     email_in_attendee_report?: boolean;
     email_language?: string;
     enable_session_branding?: boolean;
     enforce_login?: boolean;
     enforce_login_domains?: string;
     follow_up_absentees_email_notification?: {
        enable?: boolean;
        type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
     };
     follow_up_attendees_email_notification?: {
        enable?: boolean;
        type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
     };
     global_dial_in_countries?: readonly string[];
     global_dial_in_numbers?: readonly {
        city?: string;
        country?: string;
        country_name?: string;
        number?: string;
        type?: "toll" | "tollfree" | "premium";
     }[];
     hd_video?: boolean;
     hd_video_for_attendees?: boolean;
     host_video?: boolean;
     language_interpretation?: {
        enable?: boolean;
        interpreters?: readonly {
           email?: string;
           interpreter_languages?: string;
           languages?: string;
        }[];
     };
     meeting_authentication?: boolean;
     on_demand?: boolean;
     panelist_authentication?: boolean;
     panelists_invitation_email_notification?: boolean;
     panelists_video?: boolean;
     post_webinar_survey?: boolean;
     practice_session?: boolean;
     question_and_answer?: {
        allow_anonymous_questions?: boolean;
        allow_auto_reply?: boolean;
        allow_submit_questions?: boolean;
        answer_questions?: "all" | "only";
        attendees_can_comment?: boolean;
        attendees_can_upvote?: boolean;
        auto_reply_text?: string;
        enable?: boolean;
     };
     registrants_confirmation_email?: boolean;
     registrants_email_notification?: boolean;
     registrants_restrict_number?: number;
     registration_type?: 1 | 2 | 3;
     request_permission_to_unmute_participants?: boolean;
     send_1080p_video_to_attendees?: boolean;
     show_join_info?: boolean;
     show_share_button?: boolean;
     sign_language_interpretation?: {
        enable?: boolean;
        interpreters?: readonly {
           email?: string;
           sign_language?: string;
        }[];
     };
     survey_url?: string;
  };
  simulive_delay_start?: {
     enable?: boolean;
     time?: number;
     timeunit?: "second" | "minute";
  };
  start_time?: string;
  start_url?: string;
  template_id?: string;
  timezone?: string;
  topic?: string;
  tracking_fields?: readonly {
     field?: string;
     value?: string;
     visible?: boolean;
  }[];
  transition_to_live?: boolean;
  type?: 5 | 6 | 9;
  uuid?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /webinars/{webinarId}"`>]

Returns¶

Promise\<{ agenda?: string; created_at?: string; creation_source?: "other" | "open_api" | "web_portal"; duration?: number; encrypted_passcode?: string; h323_passcode?: string; host_email?: string; host_id?: string; id?: number; is_simulive?: boolean; join_url?: string; occurrences?: readonly { duration?: number; occurrence_id?: string; start_time?: string; status?: "available" | "deleted"; }[]; password?: string; record_file_id?: string; recurrence?: { end_date_time?: string; end_times?: number; monthly_day?: number; monthly_week?: -1 | 1 | 2 | 3 | 4; monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7; repeat_interval?: number; type: 1 | 2 | 3; weekly_days?: string; }; registration_url?: string; settings?: { add_audio_watermark?: boolean; add_watermark?: boolean; additional_data_center_regions?: readonly string[]; allow_host_control_participant_mute_state?: boolean; allow_multiple_devices?: boolean; alternative_host_update_polls?: boolean; alternative_hosts?: string; approval_type?: 0 | 1 | 2; attendees_and_panelists_reminder_email_notification?: { enable?: boolean; type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7; }; audio?: "both" | "telephony" | "voip" | "thirdParty"; audio_conference_info?: string; authentication_domains?: string; authentication_name?: string; authentication_option?: string; auto_recording?: "none" | "local" | "cloud"; close_registration?: boolean; contact_email?: string; contact_name?: string; email_in_attendee_report?: boolean; email_language?: string; enable_session_branding?: boolean; enforce_login?: boolean; enforce_login_domains?: string; follow_up_absentees_email_notification?: { enable?: boolean; type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7; }; follow_up_attendees_email_notification?: { enable?: boolean; type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7; }; global_dial_in_countries?: readonly string[]; global_dial_in_numbers?: readonly { city?: string; country?: string; country_name?: string; number?: string; type?: "toll" | "tollfree" | "premium"; }[]; hd_video?: boolean; hd_video_for_attendees?: boolean; host_video?: boolean; language_interpretation?: { enable?: boolean; interpreters?: readonly { email?: string; interpreter_languages?: string; languages?: string; }[]; }; meeting_authentication?: boolean; on_demand?: boolean; panelist_authentication?: boolean; panelists_invitation_email_notification?: boolean; panelists_video?: boolean; post_webinar_survey?: boolean; practice_session?: boolean; question_and_answer?: { allow_anonymous_questions?: boolean; allow_auto_reply?: boolean; allow_submit_questions?: boolean; answer_questions?: "all" | "only"; attendees_can_comment?: boolean; attendees_can_upvote?: boolean; auto_reply_text?: string; enable?: boolean; }; registrants_confirmation_email?: boolean; registrants_email_notification?: boolean; registrants_restrict_number?: number; registration_type?: 1 | 2 | 3; request_permission_to_unmute_participants?: boolean; send_1080p_video_to_attendees?: boolean; show_join_info?: boolean; show_share_button?: boolean; sign_language_interpretation?: { enable?: boolean; interpreters?: readonly { email?: string; sign_language?: string; }[]; }; survey_url?: string; }; simulive_delay_start?: { enable?: boolean; time?: number; timeunit?: "second" | "minute"; }; start_time?: string; start_url?: string; template_id?: string; timezone?: string; topic?: string; tracking_fields?: readonly { field?: string; value?: string; visible?: boolean; }[]; transition_to_live?: boolean; type?: 5 | 6 | 9; uuid?: string; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.Webinar

WebinarAbsentees()¶

WebinarAbsentees(...args): Promise<{
  next_page_token?: string;
  page_count?: number;
  page_number?: number;
  page_size?: number;
  total_records?: number;
} & {
  registrants?: readonly {
     id?: string;
   } & {
     address?: string;
     city?: string;
     comments?: string;
     country?: string;
     custom_questions?: readonly {
        title?: string;
        value?: string;
     }[];
     email: string;
     first_name: string;
     industry?: string;
     job_title?: string;
     last_name?: string;
     no_of_employees?:   | ""
        | "1-20"
        | "21-50"
        | "51-100"
        | "101-250"
        | "251-500"
        | "501-1,000"
        | "1,001-5,000"
        | "5,001-10,000"
        | "More than 10,000";
     org?: string;
     phone?: string;
     purchasing_time_frame?:   | ""
        | "Within a month"
        | "1-3 months"
        | "4-6 months"
        | "More than 6 months"
        | "No timeframe";
     role_in_purchase_process?:   | ""
        | "Decision Maker"
        | "Evaluator/Recommender"
        | "Influencer"
        | "Not involved";
     state?: string;
     status?: "pending" | "approved" | "denied";
     zip?: string;
   } & {
     create_time?: string;
     join_url?: string;
     status?: string;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /past_webinars/{webinarId}/absentees"`>]

Returns¶

Promise\<{ next_page_token?: string; page_count?: number; page_number?: number; page_size?: number; total_records?: number; } & { registrants?: readonly { id?: string; } & { address?: string; city?: string; comments?: string; country?: string; custom_questions?: readonly { title?: string; value?: string; }[]; email: string; first_name: string; industry?: string; job_title?: string; last_name?: string; no_of_employees?: | "" | "1-20" | "21-50" | "51-100" | "101-250" | "251-500" | "501-1,000" | "1,001-5,000" | "5,001-10,000" | "More than 10,000"; org?: string; phone?: string; purchasing_time_frame?: | "" | "Within a month" | "1-3 months" | "4-6 months" | "More than 6 months" | "No timeframe"; role_in_purchase_process?: | "" | "Decision Maker" | "Evaluator/Recommender" | "Influencer" | "Not involved"; state?: string; status?: "pending" | "approved" | "denied"; zip?: string; } & { create_time?: string; join_url?: string; status?: string; }[]; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarAbsentees

WebinarCreate()¶

WebinarCreate(...args): Promise<{
  agenda?: string;
  created_at?: string;
  creation_source?: "other" | "open_api" | "web_portal";
  duration?: number;
  encrypted_passcode?: string;
  h323_passcode?: string;
  host_email?: string;
  host_id?: string;
  id?: number;
  is_simulive?: boolean;
  join_url?: string;
  occurrences?: readonly {
     duration?: number;
     occurrence_id?: string;
     start_time?: string;
     status?: "available" | "deleted";
  }[];
  password?: string;
  record_file_id?: string;
  recurrence?: {
     end_date_time?: string;
     end_times?: number;
     monthly_day?: number;
     monthly_week?: -1 | 1 | 2 | 3 | 4;
     monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
     repeat_interval?: number;
     type: 1 | 2 | 3;
     weekly_days?: string;
  };
  registration_url?: string;
  settings?: {
     add_audio_watermark?: boolean;
     add_watermark?: boolean;
     additional_data_center_regions?: readonly string[];
     allow_host_control_participant_mute_state?: boolean;
     allow_multiple_devices?: boolean;
     alternative_host_update_polls?: boolean;
     alternative_hosts?: string;
     approval_type?: 0 | 1 | 2;
     attendees_and_panelists_reminder_email_notification?: {
        enable?: boolean;
        type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
     };
     audio?: "both" | "telephony" | "voip" | "thirdParty";
     audio_conference_info?: string;
     authentication_domains?: string;
     authentication_name?: string;
     authentication_option?: string;
     auto_recording?: "none" | "local" | "cloud";
     close_registration?: boolean;
     contact_email?: string;
     contact_name?: string;
     email_in_attendee_report?: boolean;
     email_language?: string;
     enable_session_branding?: boolean;
     enforce_login?: boolean;
     enforce_login_domains?: string;
     follow_up_absentees_email_notification?: {
        enable?: boolean;
        type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
     };
     follow_up_attendees_email_notification?: {
        enable?: boolean;
        type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
     };
     global_dial_in_countries?: readonly string[];
     global_dial_in_numbers?: readonly {
        city?: string;
        country?: string;
        country_name?: string;
        number?: string;
        type?: "toll" | "tollfree" | "premium";
     }[];
     hd_video?: boolean;
     hd_video_for_attendees?: boolean;
     host_video?: boolean;
     language_interpretation?: {
        enable?: boolean;
        interpreters?: readonly {
           email?: string;
           interpreter_languages?: string;
           languages?: string;
        }[];
     };
     meeting_authentication?: boolean;
     on_demand?: boolean;
     panelist_authentication?: boolean;
     panelists_invitation_email_notification?: boolean;
     panelists_video?: boolean;
     post_webinar_survey?: boolean;
     practice_session?: boolean;
     question_and_answer?: {
        allow_anonymous_questions?: boolean;
        allow_auto_reply?: boolean;
        allow_submit_questions?: boolean;
        answer_questions?: "all" | "only";
        attendees_can_comment?: boolean;
        attendees_can_upvote?: boolean;
        auto_reply_text?: string;
        enable?: boolean;
     };
     registrants_confirmation_email?: boolean;
     registrants_email_notification?: boolean;
     registrants_restrict_number?: number;
     registration_type?: 1 | 2 | 3;
     request_permission_to_unmute_participants?: boolean;
     send_1080p_video_to_attendees?: boolean;
     show_join_info?: boolean;
     show_share_button?: boolean;
     sign_language_interpretation?: {
        enable?: boolean;
        interpreters?: readonly {
           email?: string;
           sign_language?: string;
        }[];
     };
     survey_url?: string;
  };
  simulive_delay_start?: {
     enable?: boolean;
     time?: number;
     timeunit?: string;
  };
  start_time?: string;
  start_url?: string;
  template_id?: string;
  timezone?: string;
  topic?: string;
  tracking_fields?: readonly {
     field?: string;
     value?: string;
     visible?: boolean;
  }[];
  transition_to_live?: boolean;
  type?: 5 | 6 | 9;
  uuid?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /users/{userId}/webinars"`>]

Returns¶

Promise\<{ agenda?: string; created_at?: string; creation_source?: "other" | "open_api" | "web_portal"; duration?: number; encrypted_passcode?: string; h323_passcode?: string; host_email?: string; host_id?: string; id?: number; is_simulive?: boolean; join_url?: string; occurrences?: readonly { duration?: number; occurrence_id?: string; start_time?: string; status?: "available" | "deleted"; }[]; password?: string; record_file_id?: string; recurrence?: { end_date_time?: string; end_times?: number; monthly_day?: number; monthly_week?: -1 | 1 | 2 | 3 | 4; monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7; repeat_interval?: number; type: 1 | 2 | 3; weekly_days?: string; }; registration_url?: string; settings?: { add_audio_watermark?: boolean; add_watermark?: boolean; additional_data_center_regions?: readonly string[]; allow_host_control_participant_mute_state?: boolean; allow_multiple_devices?: boolean; alternative_host_update_polls?: boolean; alternative_hosts?: string; approval_type?: 0 | 1 | 2; attendees_and_panelists_reminder_email_notification?: { enable?: boolean; type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7; }; audio?: "both" | "telephony" | "voip" | "thirdParty"; audio_conference_info?: string; authentication_domains?: string; authentication_name?: string; authentication_option?: string; auto_recording?: "none" | "local" | "cloud"; close_registration?: boolean; contact_email?: string; contact_name?: string; email_in_attendee_report?: boolean; email_language?: string; enable_session_branding?: boolean; enforce_login?: boolean; enforce_login_domains?: string; follow_up_absentees_email_notification?: { enable?: boolean; type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7; }; follow_up_attendees_email_notification?: { enable?: boolean; type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7; }; global_dial_in_countries?: readonly string[]; global_dial_in_numbers?: readonly { city?: string; country?: string; country_name?: string; number?: string; type?: "toll" | "tollfree" | "premium"; }[]; hd_video?: boolean; hd_video_for_attendees?: boolean; host_video?: boolean; language_interpretation?: { enable?: boolean; interpreters?: readonly { email?: string; interpreter_languages?: string; languages?: string; }[]; }; meeting_authentication?: boolean; on_demand?: boolean; panelist_authentication?: boolean; panelists_invitation_email_notification?: boolean; panelists_video?: boolean; post_webinar_survey?: boolean; practice_session?: boolean; question_and_answer?: { allow_anonymous_questions?: boolean; allow_auto_reply?: boolean; allow_submit_questions?: boolean; answer_questions?: "all" | "only"; attendees_can_comment?: boolean; attendees_can_upvote?: boolean; auto_reply_text?: string; enable?: boolean; }; registrants_confirmation_email?: boolean; registrants_email_notification?: boolean; registrants_restrict_number?: number; registration_type?: 1 | 2 | 3; request_permission_to_unmute_participants?: boolean; send_1080p_video_to_attendees?: boolean; show_join_info?: boolean; show_share_button?: boolean; sign_language_interpretation?: { enable?: boolean; interpreters?: readonly { email?: string; sign_language?: string; }[]; }; survey_url?: string; }; simulive_delay_start?: { enable?: boolean; time?: number; timeunit?: string; }; start_time?: string; start_url?: string; template_id?: string; timezone?: string; topic?: string; tracking_fields?: readonly { field?: string; value?: string; visible?: boolean; }[]; transition_to_live?: boolean; type?: 5 | 6 | 9; uuid?: string; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarCreate

WebinarDelete()¶

WebinarDelete(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"DELETE /webinars/{webinarId}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarDelete

WebinarInviteLinksCreate()¶

WebinarInviteLinksCreate(...args): Promise<{
  attendees?: readonly {
     join_url?: string;
     name?: string;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /webinars/{webinarId}/invite_links"`>]

Returns¶

Promise\<{ attendees?: readonly { join_url?: string; name?: string; }[]; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarInviteLinksCreate

WebinarLiveStreamingJoinToken()¶

WebinarLiveStreamingJoinToken(...args): Promise<{
  expire_in?: 120;
  token?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /webinars/{webinarId}/jointoken/live_streaming"`>]

Returns¶

Promise\<{ expire_in?: 120; token?: string; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarLiveStreamingJoinToken

WebinarLiveStreamStatusUpdate()¶

WebinarLiveStreamStatusUpdate(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PATCH /webinars/{webinarId}/livestream/status"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarLiveStreamStatusUpdate

WebinarLiveStreamUpdate()¶

WebinarLiveStreamUpdate(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PATCH /webinars/{webinarId}/livestream"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarLiveStreamUpdate

WebinarLocalArchivingArchiveToken()¶

WebinarLocalArchivingArchiveToken(...args): Promise<{
  expire_in?: 120;
  token?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /webinars/{webinarId}/jointoken/local_archiving"`>]

Returns¶

Promise\<{ expire_in?: 120; token?: string; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarLocalArchivingArchiveToken

WebinarLocalRecordingJoinToken()¶

WebinarLocalRecordingJoinToken(...args): Promise<{
  expire_in?: 120;
  token?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /webinars/{webinarId}/jointoken/local_recording"`>]

Returns¶

Promise\<{ expire_in?: 120; token?: string; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarLocalRecordingJoinToken

WebinarPanelistCreate()¶

WebinarPanelistCreate(...args): Promise<{
  id?: string;
  updated_at?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /webinars/{webinarId}/panelists"`>]

Returns¶

Promise\<{ id?: string; updated_at?: string; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarPanelistCreate

WebinarPanelistDelete()¶

WebinarPanelistDelete(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"DELETE /webinars/{webinarId}/panelists/{panelistId}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarPanelistDelete

WebinarPanelists()¶

WebinarPanelists(...args): Promise<{
  panelists?: readonly {
     id?: string;
   } & {
     email?: string;
     name?: string;
   } & {
     join_url?: string;
   } & {
     name_tag_description?: string;
     name_tag_id?: string;
     name_tag_name?: string;
     name_tag_pronouns?: string;
     virtual_background_id?: string;
  }[];
  total_records?: number;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /webinars/{webinarId}/panelists"`>]

Returns¶

Promise\<{ panelists?: readonly { id?: string; } & { email?: string; name?: string; } & { join_url?: string; } & { name_tag_description?: string; name_tag_id?: string; name_tag_name?: string; name_tag_pronouns?: string; virtual_background_id?: string; }[]; total_records?: number; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarPanelists

WebinarPanelistsDelete()¶

WebinarPanelistsDelete(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"DELETE /webinars/{webinarId}/panelists"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarPanelistsDelete

WebinarPollCreate()¶

WebinarPollCreate(...args): Promise<{
  id?: string;
  status?: "started" | "ended" | "notstart" | "sharing";
} & {
  anonymous?: boolean;
  poll_type?: 1 | 2 | 3;
  questions?: readonly {
     answer_max_character?: number;
     answer_min_character?: number;
     answer_required?: boolean;
     answers?: readonly string[];
     case_sensitive?: boolean;
     name?: string;
     prompts?: readonly {
        prompt_question?: string;
        prompt_right_answers?: readonly string[];
     }[];
     rating_max_label?: string;
     rating_max_value?: number;
     rating_min_label?: string;
     rating_min_value?: number;
     right_answers?: readonly string[];
     show_as_dropdown?: boolean;
     type?:   | "single"
        | "multiple"
        | "matching"
        | "rank_order"
        | "short_answer"
        | "long_answer"
        | "fill_in_the_blank"
        | "rating_scale";
  }[];
  title?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /webinars/{webinarId}/polls"`>]

Returns¶

Promise\<{ id?: string; status?: "started" | "ended" | "notstart" | "sharing"; } & { anonymous?: boolean; poll_type?: 1 | 2 | 3; questions?: readonly { answer_max_character?: number; answer_min_character?: number; answer_required?: boolean; answers?: readonly string[]; case_sensitive?: boolean; name?: string; prompts?: readonly { prompt_question?: string; prompt_right_answers?: readonly string[]; }[]; rating_max_label?: string; rating_max_value?: number; rating_min_label?: string; rating_min_value?: number; right_answers?: readonly string[]; show_as_dropdown?: boolean; type?: | "single" | "multiple" | "matching" | "rank_order" | "short_answer" | "long_answer" | "fill_in_the_blank" | "rating_scale"; }[]; title?: string; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarPollCreate

WebinarPollDelete()¶

WebinarPollDelete(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"DELETE /webinars/{webinarId}/polls/{pollId}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarPollDelete

WebinarPollGet()¶

WebinarPollGet(...args): Promise<{
  id?: string;
  status?: "started" | "ended" | "notstart" | "sharing" | "deactivated";
} & {
  anonymous?: boolean;
  poll_type?: 1 | 2 | 3;
  questions?: readonly {
     answer_max_character?: number;
     answer_min_character?: number;
     answer_required?: boolean;
     answers?: readonly string[];
     case_sensitive?: boolean;
     name?: string;
     prompts?: readonly {
        prompt_question?: string;
        prompt_right_answers?: readonly string[];
     }[];
     rating_max_label?: string;
     rating_max_value?: number;
     rating_min_label?: string;
     rating_min_value?: number;
     right_answers?: readonly string[];
     show_as_dropdown?: boolean;
     type?:   | "single"
        | "multiple"
        | "matching"
        | "rank_order"
        | "short_answer"
        | "long_answer"
        | "fill_in_the_blank"
        | "rating_scale";
  }[];
  title?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /webinars/{webinarId}/polls/{pollId}"`>]

Returns¶

Promise\<{ id?: string; status?: "started" | "ended" | "notstart" | "sharing" | "deactivated"; } & { anonymous?: boolean; poll_type?: 1 | 2 | 3; questions?: readonly { answer_max_character?: number; answer_min_character?: number; answer_required?: boolean; answers?: readonly string[]; case_sensitive?: boolean; name?: string; prompts?: readonly { prompt_question?: string; prompt_right_answers?: readonly string[]; }[]; rating_max_label?: string; rating_max_value?: number; rating_min_label?: string; rating_min_value?: number; right_answers?: readonly string[]; show_as_dropdown?: boolean; type?: | "single" | "multiple" | "matching" | "rank_order" | "short_answer" | "long_answer" | "fill_in_the_blank" | "rating_scale"; }[]; title?: string; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarPollGet

WebinarPolls()¶

WebinarPolls(...args): Promise<{
  polls?: readonly {
     id?: string;
     status?: "started" | "ended" | "notstart" | "sharing" | "deactivated";
   } & {
     anonymous?: boolean;
     poll_type?: 1 | 2 | 3;
     questions?: readonly {
        answer_max_character?: number;
        answer_min_character?: number;
        answer_required?: boolean;
        answers?: readonly string[];
        case_sensitive?: boolean;
        name?: string;
        prompts?: readonly {
           prompt_question?: string;
           prompt_right_answers?: readonly string[];
        }[];
        rating_max_label?: string;
        rating_max_value?: number;
        rating_min_label?: string;
        rating_min_value?: number;
        right_answers?: readonly string[];
        show_as_dropdown?: boolean;
        type?:   | "single"
           | "multiple"
           | "matching"
           | "rank_order"
           | "short_answer"
           | "long_answer"
           | "fill_in_the_blank"
           | "rating_scale";
     }[];
     title?: string;
  }[];
  total_records?: number;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /webinars/{webinarId}/polls"`>]

Returns¶

Promise\<{ polls?: readonly { id?: string; status?: "started" | "ended" | "notstart" | "sharing" | "deactivated"; } & { anonymous?: boolean; poll_type?: 1 | 2 | 3; questions?: readonly { answer_max_character?: number; answer_min_character?: number; answer_required?: boolean; answers?: readonly string[]; case_sensitive?: boolean; name?: string; prompts?: readonly { prompt_question?: string; prompt_right_answers?: readonly string[]; }[]; rating_max_label?: string; rating_max_value?: number; rating_min_label?: string; rating_min_value?: number; right_answers?: readonly string[]; show_as_dropdown?: boolean; type?: | "single" | "multiple" | "matching" | "rank_order" | "short_answer" | "long_answer" | "fill_in_the_blank" | "rating_scale"; }[]; title?: string; }[]; total_records?: number; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarPolls

WebinarPollUpdate()¶

WebinarPollUpdate(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PUT /webinars/{webinarId}/polls/{pollId}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarPollUpdate

WebinarRegistrantCreate()¶

WebinarRegistrantCreate(...args): Promise<{
  id?: number;
  join_url?: string;
  occurrences?: readonly {
     duration?: number;
     occurrence_id?: string;
     start_time?: string;
     status?: string;
  }[];
  registrant_id?: string;
  start_time?: string;
  topic?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /webinars/{webinarId}/registrants"`>]

Returns¶

Promise\<{ id?: number; join_url?: string; occurrences?: readonly { duration?: number; occurrence_id?: string; start_time?: string; status?: string; }[]; registrant_id?: string; start_time?: string; topic?: string; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarRegistrantCreate

WebinarRegistrantGet()¶

WebinarRegistrantGet(...args): Promise<{
  id?: string;
} & {
  address?: string;
  city?: string;
  comments?: string;
  country?: string;
  custom_questions?: readonly {
     title?: string;
     value?: string;
  }[];
  email: string;
  first_name: string;
  industry?: string;
  job_title?: string;
  last_name?: string;
  no_of_employees?:   | ""
     | "1-20"
     | "21-50"
     | "51-100"
     | "101-250"
     | "251-500"
     | "501-1,000"
     | "1,001-5,000"
     | "5,001-10,000"
     | "More than 10,000";
  org?: string;
  phone?: string;
  purchasing_time_frame?:   | ""
     | "Within a month"
     | "1-3 months"
     | "4-6 months"
     | "More than 6 months"
     | "No timeframe";
  role_in_purchase_process?:   | ""
     | "Decision Maker"
     | "Evaluator/Recommender"
     | "Influencer"
     | "Not involved";
  state?: string;
  status?: "pending" | "approved" | "denied";
  zip?: string;
} & {
  language?:   | "de-DE"
     | "en-US"
     | "es-ES"
     | "fr-FR"
     | "it-IT"
     | "pl-PL"
     | "pt-PT"
     | "ru-RU"
     | "vi-VN"
     | "zh-CN"
     | "zh-TW"
     | "jp-JP"
     | "ko-KO"
     | "Tr-TR";
} & {
  create_time?: string;
  join_url?: string;
  status?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /webinars/{webinarId}/registrants/{registrantId}"`>]

Returns¶

Promise\<{ id?: string; } & { address?: string; city?: string; comments?: string; country?: string; custom_questions?: readonly { title?: string; value?: string; }[]; email: string; first_name: string; industry?: string; job_title?: string; last_name?: string; no_of_employees?: | "" | "1-20" | "21-50" | "51-100" | "101-250" | "251-500" | "501-1,000" | "1,001-5,000" | "5,001-10,000" | "More than 10,000"; org?: string; phone?: string; purchasing_time_frame?: | "" | "Within a month" | "1-3 months" | "4-6 months" | "More than 6 months" | "No timeframe"; role_in_purchase_process?: | "" | "Decision Maker" | "Evaluator/Recommender" | "Influencer" | "Not involved"; state?: string; status?: "pending" | "approved" | "denied"; zip?: string; } & { language?: | "de-DE" | "en-US" | "es-ES" | "fr-FR" | "it-IT" | "pl-PL" | "pt-PT" | "ru-RU" | "vi-VN" | "zh-CN" | "zh-TW" | "jp-JP" | "ko-KO" | "Tr-TR"; } & { create_time?: string; join_url?: string; status?: string; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarRegistrantGet

WebinarRegistrantQuestionUpdate()¶

WebinarRegistrantQuestionUpdate(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PATCH /webinars/{webinarId}/registrants/questions"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarRegistrantQuestionUpdate

WebinarRegistrants()¶

WebinarRegistrants(...args): Promise<{
  next_page_token?: string;
  page_count?: number;
  page_number?: number;
  page_size?: number;
  total_records?: number;
} & {
  registrants?: readonly {
     id?: string;
   } & {
     address?: string;
     city?: string;
     comments?: string;
     country?: string;
     custom_questions?: readonly {
        title?: string;
        value?: string;
     }[];
     email: string;
     first_name: string;
     industry?: string;
     job_title?: string;
     last_name?: string;
     no_of_employees?:   | ""
        | "1-20"
        | "21-50"
        | "51-100"
        | "101-250"
        | "251-500"
        | "501-1,000"
        | "1,001-5,000"
        | "5,001-10,000"
        | "More than 10,000";
     org?: string;
     phone?: string;
     purchasing_time_frame?:   | ""
        | "Within a month"
        | "1-3 months"
        | "4-6 months"
        | "More than 6 months"
        | "No timeframe";
     role_in_purchase_process?:   | ""
        | "Decision Maker"
        | "Evaluator/Recommender"
        | "Influencer"
        | "Not involved";
     state?: string;
     status?: "pending" | "approved" | "denied";
     zip?: string;
   } & {
     create_time?: string;
     join_url?: string;
     status?: string;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /webinars/{webinarId}/registrants"`>]

Returns¶

Promise\<{ next_page_token?: string; page_count?: number; page_number?: number; page_size?: number; total_records?: number; } & { registrants?: readonly { id?: string; } & { address?: string; city?: string; comments?: string; country?: string; custom_questions?: readonly { title?: string; value?: string; }[]; email: string; first_name: string; industry?: string; job_title?: string; last_name?: string; no_of_employees?: | "" | "1-20" | "21-50" | "51-100" | "101-250" | "251-500" | "501-1,000" | "1,001-5,000" | "5,001-10,000" | "More than 10,000"; org?: string; phone?: string; purchasing_time_frame?: | "" | "Within a month" | "1-3 months" | "4-6 months" | "More than 6 months" | "No timeframe"; role_in_purchase_process?: | "" | "Decision Maker" | "Evaluator/Recommender" | "Influencer" | "Not involved"; state?: string; status?: "pending" | "approved" | "denied"; zip?: string; } & { create_time?: string; join_url?: string; status?: string; }[]; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarRegistrants

WebinarRegistrantsQuestionsGet()¶

WebinarRegistrantsQuestionsGet(...args): Promise<{
  custom_questions?: readonly {
     answers?: readonly string[];
     required?: boolean;
     title?: string;
     type?: "short" | "multiple" | "single_radio" | "single_dropdown";
  }[];
  questions?: readonly {
     field_name?:   | "state"
        | "phone"
        | "last_name"
        | "address"
        | "city"
        | "country"
        | "zip"
        | "industry"
        | "org"
        | "job_title"
        | "purchasing_time_frame"
        | "role_in_purchase_process"
        | "no_of_employees"
        | "comments";
     required?: boolean;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /webinars/{webinarId}/registrants/questions"`>]

Returns¶

Promise\<{ custom_questions?: readonly { answers?: readonly string[]; required?: boolean; title?: string; type?: "short" | "multiple" | "single_radio" | "single_dropdown"; }[]; questions?: readonly { field_name?: | "state" | "phone" | "last_name" | "address" | "city" | "country" | "zip" | "industry" | "org" | "job_title" | "purchasing_time_frame" | "role_in_purchase_process" | "no_of_employees" | "comments"; required?: boolean; }[]; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarRegistrantsQuestionsGet

WebinarRegistrantStatus()¶

WebinarRegistrantStatus(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PUT /webinars/{webinarId}/registrants/status"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarRegistrantStatus

Webinars()¶

Webinars(...args): Promise<{
  next_page_token?: string;
  page_count?: number;
  page_number?: number;
  page_size?: number;
  total_records?: number;
} & {
  webinars?: readonly {
     agenda?: string;
     created_at?: string;
     duration?: number;
     host_id?: string;
     id?: number;
     is_events_webinar?: boolean;
     is_simulive?: boolean;
     join_url?: string;
     start_time?: string;
     timezone?: string;
     topic?: string;
     type?: 5 | 6 | 9;
     uuid?: string;
  }[];
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /users/{userId}/webinars"`>]

Returns¶

Promise\<{ next_page_token?: string; page_count?: number; page_number?: number; page_size?: number; total_records?: number; } & { webinars?: readonly { agenda?: string; created_at?: string; duration?: number; host_id?: string; id?: number; is_events_webinar?: boolean; is_simulive?: boolean; join_url?: string; start_time?: string; timezone?: string; topic?: string; type?: 5 | 6 | 9; uuid?: string; }[]; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.Webinars

WebinarStatus()¶

WebinarStatus(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PUT /webinars/{webinarId}/status"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarStatus

WebinarSurveyDelete()¶

WebinarSurveyDelete(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"DELETE /webinars/{webinarId}/survey"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarSurveyDelete

WebinarSurveyGet()¶

WebinarSurveyGet(...args): Promise<{
  custom_survey?: {
     anonymous?: boolean;
     feedback?: string;
     numbered_questions?: boolean;
     questions?: readonly {
        answer_max_character?: number;
        answer_min_character?: number;
        answer_required?: boolean;
        answers?: readonly string[];
        name?: string;
        prompts?: readonly {
           prompt_question?: string;
        }[];
        rating_max_label?: string;
        rating_max_value?: number;
        rating_min_label?: string;
        rating_min_value?: number;
        show_as_dropdown?: boolean;
        type?:   | "single"
           | "multiple"
           | "matching"
           | "rank_order"
           | "short_answer"
           | "long_answer"
           | "fill_in_the_blank"
           | "rating_scale";
     }[];
     show_question_type?: boolean;
     title?: string;
  };
  show_in_the_browser?: boolean;
  show_in_the_follow_up_email?: boolean;
  third_party_survey?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /webinars/{webinarId}/survey"`>]

Returns¶

Promise\<{ custom_survey?: { anonymous?: boolean; feedback?: string; numbered_questions?: boolean; questions?: readonly { answer_max_character?: number; answer_min_character?: number; answer_required?: boolean; answers?: readonly string[]; name?: string; prompts?: readonly { prompt_question?: string; }[]; rating_max_label?: string; rating_max_value?: number; rating_min_label?: string; rating_min_value?: number; show_as_dropdown?: boolean; type?: | "single" | "multiple" | "matching" | "rank_order" | "short_answer" | "long_answer" | "fill_in_the_blank" | "rating_scale"; }[]; show_question_type?: boolean; title?: string; }; show_in_the_browser?: boolean; show_in_the_follow_up_email?: boolean; third_party_survey?: string; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarSurveyGet

WebinarSurveyUpdate()¶

WebinarSurveyUpdate(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PATCH /webinars/{webinarId}/survey"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarSurveyUpdate

WebinarTemplateCreate()¶

WebinarTemplateCreate(...args): Promise<{
  id?: string;
  name?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"POST /users/{userId}/webinar_templates"`>]

Returns¶

Promise\<{ id?: string; name?: string; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarTemplateCreate

WebinarToken()¶

WebinarToken(...args): Promise<{
  token?: string;
}>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"GET /webinars/{webinarId}/token"`>]

Returns¶

Promise\<{ token?: string; }>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarToken

WebinarUpdate()¶

WebinarUpdate(...args): Promise<void>;

Parameters¶

Parameter	Type
...`args`	[`ZoomMeetingsApiOperationInput`\<`"PATCH /webinars/{webinarId}"`>]

Returns¶

Promise\<void>

Inherited from¶

ZoomMeetingsApiWebinarsGeneratedClient.WebinarUpdate

ZoomMeetingsApiOperation¶

Properties¶

functionName¶

functionName: string;

method¶

method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";

operationId¶

operationId: string;

path¶

path: string;

summary¶

summary: string;

tags¶

tags: readonly string[];

uid¶

uid: string;

ZoomMeetingsApiOperationQueryMap¶

Properties¶

DELETE /devices/{deviceId}¶

DELETE /devices/{deviceId}: {
};

DELETE /devices/zpa/vendors/{vendor}/mac_addresses/{macAddress}¶

DELETE /devices/zpa/vendors/{vendor}/mac_addresses/{macAddress}: {
};

DELETE /h323/devices/{deviceId}¶

DELETE /h323/devices/{deviceId}: {
};

DELETE /live_meetings/{meetingId}/chat/messages/{messageId}¶

DELETE /live_meetings/{meetingId}/chat/messages/{messageId}: {
  file_ids?: string;
};

file_ids?¶

optional file_ids?: string;

DELETE /live_webinars/{webinarId}/chat/messages/{messageId}¶

DELETE /live_webinars/{webinarId}/chat/messages/{messageId}: {
  file_ids?: string;
};

file_ids?¶

optional file_ids?: string;

DELETE /meetings/{meetingId}¶

DELETE /meetings/{meetingId}: {
  cancel_meeting_reminder?: boolean;
  occurrence_id?: string;
  schedule_for_reminder?: boolean;
};

cancel_meeting_reminder?¶

optional cancel_meeting_reminder?: boolean;

occurrence_id?¶

optional occurrence_id?: string;

schedule_for_reminder?¶

optional schedule_for_reminder?: boolean;

DELETE /meetings/{meetingId}/meeting_summary¶

DELETE /meetings/{meetingId}/meeting_summary: {
};

DELETE /meetings/{meetingId}/open_apps¶

DELETE /meetings/{meetingId}/open_apps: {
};

DELETE /meetings/{meetingId}/polls/{pollId}¶

DELETE /meetings/{meetingId}/polls/{pollId}: {
};

DELETE /meetings/{meetingId}/recordings¶

DELETE /meetings/{meetingId}/recordings: {
  action?: "delete" | "trash";
};

action?¶

optional action?: "delete" | "trash";

DELETE /meetings/{meetingId}/recordings/{recordingId}¶

DELETE /meetings/{meetingId}/recordings/{recordingId}: {
  action?: "delete" | "trash";
};

action?¶

optional action?: "delete" | "trash";

DELETE /meetings/{meetingId}/registrants/{registrantId}¶

DELETE /meetings/{meetingId}/registrants/{registrantId}: {
  occurrence_id?: string;
};

occurrence_id?¶

optional occurrence_id?: string;

DELETE /meetings/{meetingId}/survey¶

DELETE /meetings/{meetingId}/survey: {
};

DELETE /meetings/{meetingId}/transcript¶

DELETE /meetings/{meetingId}/transcript: {
};

DELETE /past_meetings/{meetingUUID}/archive_files¶

DELETE /past_meetings/{meetingUUID}/archive_files: {
};

DELETE /sip_phones/phones/{phoneId}¶

DELETE /sip_phones/phones/{phoneId}: {
};

DELETE /tracking_fields/{fieldId}¶

DELETE /tracking_fields/{fieldId}: {
};

DELETE /users/{userId}/tsp/{tspId}¶

DELETE /users/{userId}/tsp/{tspId}: {
};

DELETE /webinars/{webinarId}¶

DELETE /webinars/{webinarId}: {
  cancel_webinar_reminder?: boolean;
  occurrence_id?: string;
};

cancel_webinar_reminder?¶

optional cancel_webinar_reminder?: boolean;

occurrence_id?¶

optional occurrence_id?: string;

DELETE /webinars/{webinarId}/branding/name_tags¶

DELETE /webinars/{webinarId}/branding/name_tags: {
  name_tag_ids?: string;
};

name_tag_ids?¶

optional name_tag_ids?: string;

DELETE /webinars/{webinarId}/branding/virtual_backgrounds¶

DELETE /webinars/{webinarId}/branding/virtual_backgrounds: {
  ids?: string;
};

ids?¶

optional ids?: string;

DELETE /webinars/{webinarId}/branding/wallpaper¶

DELETE /webinars/{webinarId}/branding/wallpaper: {
};

DELETE /webinars/{webinarId}/panelists¶

DELETE /webinars/{webinarId}/panelists: {
};

DELETE /webinars/{webinarId}/panelists/{panelistId}¶

DELETE /webinars/{webinarId}/panelists/{panelistId}: {
};

DELETE /webinars/{webinarId}/polls/{pollId}¶

DELETE /webinars/{webinarId}/polls/{pollId}: {
};

DELETE /webinars/{webinarId}/registrants/{registrantId}¶

DELETE /webinars/{webinarId}/registrants/{registrantId}: {
  occurrence_id?: string;
};

occurrence_id?¶

optional occurrence_id?: string;

DELETE /webinars/{webinarId}/survey¶

DELETE /webinars/{webinarId}/survey: {
};

GET /archive_files¶

GET /archive_files: {
  from?: string;
  group_id?: string;
  group_ids?: string;
  next_page_token?: string;
  page_size?: number;
  query_date_type?: "meeting_start_time" | "archive_complete_time";
  to?: string;
};

from?¶

optional from?: string;

group_id?¶

optional group_id?: string;

group_ids?¶

optional group_ids?: string;

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

query_date_type?¶

optional query_date_type?: "meeting_start_time" | "archive_complete_time";

to?¶

optional to?: string;

GET /archive_files/statistics¶

GET /archive_files/statistics: {
  from?: string;
  to?: string;
};

from?¶

optional from?: string;

to?¶

optional to?: string;

GET /devices¶

GET /devices: {
  device_model?: string;
  device_status?: -1 | 0 | 1;
  device_type?: -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6;
  device_vendor?: string;
  is_enrolled_in_zdm?: boolean;
  next_page_token?: string;
  page_size?: number;
  platform_os?: "win" | "mac" | "ipad" | "iphone" | "android" | "linux";
  search_text?: string;
};

device_model?¶

optional device_model?: string;

device_status?¶

optional device_status?: -1 | 0 | 1;

device_type?¶

optional device_type?: -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6;

device_vendor?¶

optional device_vendor?: string;

is_enrolled_in_zdm?¶

optional is_enrolled_in_zdm?: boolean;

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

platform_os?¶

optional platform_os?: "win" | "mac" | "ipad" | "iphone" | "android" | "linux";

search_text?¶

optional search_text?: string;

GET /devices/{deviceId}¶

GET /devices/{deviceId}: {
};

GET /devices/groups¶

GET /devices/groups: {
  next_page_token?: string;
  page_size?: number;
};

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

GET /devices/zpa/settings¶

GET /devices/zpa/settings: {
  user_id?: string;
};

user_id?¶

optional user_id?: string;

GET /devices/zpa/zdm_groups/{zdmGroupId}/versions¶

GET /devices/zpa/zdm_groups/{zdmGroupId}/versions: {
};

GET /h323/devices¶

GET /h323/devices: {
  next_page_token?: string;
  page_number?: number;
  page_size?: number;
};

next_page_token?¶

optional next_page_token?: string;

page_number?¶

optional page_number?: number;

page_size?¶

optional page_size?: number;

GET /meetings/{meetingId}¶

GET /meetings/{meetingId}: {
  occurrence_id?: string;
  show_previous_occurrences?: boolean;
};

occurrence_id?¶

optional occurrence_id?: string;

show_previous_occurrences?¶

optional show_previous_occurrences?: boolean;

GET /meetings/{meetingId}/invitation¶

GET /meetings/{meetingId}/invitation: {
};

GET /meetings/{meetingId}/jointoken/live_streaming¶

GET /meetings/{meetingId}/jointoken/live_streaming: {
};

GET /meetings/{meetingId}/jointoken/local_archiving¶

GET /meetings/{meetingId}/jointoken/local_archiving: {
};

GET /meetings/{meetingId}/jointoken/local_recording¶

GET /meetings/{meetingId}/jointoken/local_recording: {
  bypass_waiting_room?: boolean;
};

bypass_waiting_room?¶

optional bypass_waiting_room?: boolean;

GET /meetings/{meetingId}/livestream¶

GET /meetings/{meetingId}/livestream: {
};

GET /meetings/{meetingId}/meeting_summary¶

GET /meetings/{meetingId}/meeting_summary: {
};

GET /meetings/{meetingId}/polls¶

GET /meetings/{meetingId}/polls: {
  anonymous?: boolean;
};

anonymous?¶

optional anonymous?: boolean;

GET /meetings/{meetingId}/polls/{pollId}¶

GET /meetings/{meetingId}/polls/{pollId}: {
};

GET /meetings/{meetingId}/recordings¶

GET /meetings/{meetingId}/recordings: {
  include_fields?: string;
  ttl?: number;
};

include_fields?¶

optional include_fields?: string;

ttl?¶

optional ttl?: number;

GET /meetings/{meetingId}/recordings/analytics_details¶

GET /meetings/{meetingId}/recordings/analytics_details: {
  from?: string;
  next_page_token?: string;
  page_size?: number;
  to?: string;
  type?: "by_view" | "by_download";
};

from?¶

optional from?: string;

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

to?¶

optional to?: string;

type?¶

optional type?: "by_view" | "by_download";

GET /meetings/{meetingId}/recordings/analytics_summary¶

GET /meetings/{meetingId}/recordings/analytics_summary: {
  from?: string;
  to?: string;
};

from?¶

optional from?: string;

to?¶

optional to?: string;

GET /meetings/{meetingId}/recordings/registrants¶

GET /meetings/{meetingId}/recordings/registrants: {
  next_page_token?: string;
  page_number?: number;
  page_size?: number;
  status?: "pending" | "approved" | "denied";
};

next_page_token?¶

optional next_page_token?: string;

page_number?¶

optional page_number?: number;

page_size?¶

optional page_size?: number;

status?¶

optional status?: "pending" | "approved" | "denied";

GET /meetings/{meetingId}/recordings/registrants/questions¶

GET /meetings/{meetingId}/recordings/registrants/questions: {
};

GET /meetings/{meetingId}/recordings/settings¶

GET /meetings/{meetingId}/recordings/settings: {
};

GET /meetings/{meetingId}/registrants¶

GET /meetings/{meetingId}/registrants: {
  next_page_token?: string;
  occurrence_id?: string;
  page_number?: number;
  page_size?: number;
  status?: "pending" | "approved" | "denied";
};

next_page_token?¶

optional next_page_token?: string;

occurrence_id?¶

optional occurrence_id?: string;

page_number?¶

optional page_number?: number;

page_size?¶

optional page_size?: number;

status?¶

optional status?: "pending" | "approved" | "denied";

GET /meetings/{meetingId}/registrants/{registrantId}¶

GET /meetings/{meetingId}/registrants/{registrantId}: {
};

GET /meetings/{meetingId}/registrants/questions¶

GET /meetings/{meetingId}/registrants/questions: {
};

GET /meetings/{meetingId}/survey¶

GET /meetings/{meetingId}/survey: {
};

GET /meetings/{meetingId}/token¶

GET /meetings/{meetingId}/token: {
  type?: "closed_caption_token";
};

type?¶

optional type?: "closed_caption_token";

GET /meetings/{meetingId}/transcript¶

GET /meetings/{meetingId}/transcript: {
};

GET /meetings/meeting_summaries¶

GET /meetings/meeting_summaries: {
  from?: string;
  next_page_token?: string;
  page_size?: number;
  time_filter_field?: "summary_start_time" | "summary_created_time";
  to?: string;
};

from?¶

optional from?: string;

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

time_filter_field?¶

optional time_filter_field?: "summary_start_time" | "summary_created_time";

to?¶

optional to?: string;

GET /past_meetings/{meetingId}¶

GET /past_meetings/{meetingId}: {
};

GET /past_meetings/{meetingId}/instances¶

GET /past_meetings/{meetingId}/instances: {
  from?: string;
  to?: string;
};

from?¶

optional from?: string;

to?¶

optional to?: string;

GET /past_meetings/{meetingId}/participants¶

GET /past_meetings/{meetingId}/participants: {
  next_page_token?: string;
  page_size?: number;
};

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

GET /past_meetings/{meetingId}/polls¶

GET /past_meetings/{meetingId}/polls: {
};

GET /past_meetings/{meetingId}/qa¶

GET /past_meetings/{meetingId}/qa: {
};

GET /past_meetings/{meetingUUID}/archive_files¶

GET /past_meetings/{meetingUUID}/archive_files: {
};

GET /past_webinars/{webinarId}/absentees¶

GET /past_webinars/{webinarId}/absentees: {
  next_page_token?: string;
  occurrence_id?: string;
  page_size?: number;
};

next_page_token?¶

optional next_page_token?: string;

occurrence_id?¶

optional occurrence_id?: string;

page_size?¶

optional page_size?: number;

GET /past_webinars/{webinarId}/instances¶

GET /past_webinars/{webinarId}/instances: {
};

GET /past_webinars/{webinarId}/participants¶

GET /past_webinars/{webinarId}/participants: {
  next_page_token?: string;
  page_size?: number;
};

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

GET /past_webinars/{webinarId}/polls¶

GET /past_webinars/{webinarId}/polls: {
};

GET /past_webinars/{webinarId}/qa¶

GET /past_webinars/{webinarId}/qa: {
};

GET /report/activities¶

GET /report/activities: {
  from?: string;
  next_page_token?: string;
  page_size?: number;
  to?: string;
};

from?¶

optional from?: string;

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

to?¶

optional to?: string;

GET /report/billing¶

GET /report/billing: {
};

GET /report/billing/invoices¶

GET /report/billing/invoices: {
  billing_id: string;
};

billing_id¶

billing_id: string;

GET /report/cloud_recording¶

GET /report/cloud_recording: {
  from: string;
  group_id?: string;
  to: string;
};

from¶

from: string;

group_id?¶

optional group_id?: string;

to¶

to: string;

GET /report/daily¶

GET /report/daily: {
  group_id?: string;
  month?: number;
  year?: number;
};

group_id?¶

optional group_id?: string;

month?¶

optional month?: number;

year?¶

optional year?: number;

GET /report/disclaimer¶

GET /report/disclaimer: {
  disclaimer_type?:   | "summary"
     | "query"
     | "recording"
     | "all"
     | "login"
     | "joinMeeting"
     | "remoteControl"
     | "meetingConnector"
     | "archive"
     | "AICompanion"
     | "caption"
     | "joinSDKMeeting"
     | "NDI"
     | "joinWebinar"
     | "internalMMRGuestJoin"
     | "liveStream"
     | "phoneACR"
     | "viewBOActivity"
     | "webinarBO"
     | "unmuteAudio"
     | "joinOnZoom"
     | "GDPR"
     | "chinaMeeting"
     | "zappJoin"
     | "softUpdateReminder";
  from: string;
  group_id?: string;
  next_page_token?: string;
  page_size?: number;
  search_value?: string;
  to: string;
};

disclaimer_type?¶

optional disclaimer_type?:
  | "summary"
  | "query"
  | "recording"
  | "all"
  | "login"
  | "joinMeeting"
  | "remoteControl"
  | "meetingConnector"
  | "archive"
  | "AICompanion"
  | "caption"
  | "joinSDKMeeting"
  | "NDI"
  | "joinWebinar"
  | "internalMMRGuestJoin"
  | "liveStream"
  | "phoneACR"
  | "viewBOActivity"
  | "webinarBO"
  | "unmuteAudio"
  | "joinOnZoom"
  | "GDPR"
  | "chinaMeeting"
  | "zappJoin"
  | "softUpdateReminder";

from¶

from: string;

group_id?¶

optional group_id?: string;

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

search_value?¶

optional search_value?: string;

to¶

to: string;

GET /report/history_meetings¶

GET /report/history_meetings: {
  date_type?: "start_time" | "end_time";
  from: string;
  group_id?: string;
  meeting_feature?:   | "annotation"
     | "closed_caption"
     | "poll"
     | "whiteboard"
     | "reaction"
     | "screen_sharing"
     | "video_on"
     | "remote_control"
     | "language_interpretation"
     | "telephone_usage"
     | "in_meeting_chat"
     | "join_by_room"
     | "waiting_room"
     | "live_transcription"
     | "zoom_apps"
     | "raise_hand"
     | "virtual_background"
     | "immersive_scene"
     | "avatar"
     | "switch_to_mobile"
     | "file_sharing"
     | "meeting_summary"
     | "meeting_questions"
     | "record_to_computer"
     | "record_to_cloud"
     | "live_translation"
     | "registration"
     | "smart_recording"
     | "multi_speaker"
     | "meeting_wallpaper"
     | "gen_ai_virtual_background"
     | "multi_share"
     | "document_collaboration"
     | "portrait_lighting"
     | "personalized_audio_isolation"
     | "color_themes";
  meeting_type?: "all" | "meeting" | "webinar";
  next_page_token?: string;
  page_size?: number;
  report_type?: "all" | "poll" | "survey" | "qa" | "resource" | "reaction";
  search_key?: string;
  to: string;
};

date_type?¶

optional date_type?: "start_time" | "end_time";

from¶

from: string;

group_id?¶

optional group_id?: string;

meeting_feature?¶

optional meeting_feature?:
  | "annotation"
  | "closed_caption"
  | "poll"
  | "whiteboard"
  | "reaction"
  | "screen_sharing"
  | "video_on"
  | "remote_control"
  | "language_interpretation"
  | "telephone_usage"
  | "in_meeting_chat"
  | "join_by_room"
  | "waiting_room"
  | "live_transcription"
  | "zoom_apps"
  | "raise_hand"
  | "virtual_background"
  | "immersive_scene"
  | "avatar"
  | "switch_to_mobile"
  | "file_sharing"
  | "meeting_summary"
  | "meeting_questions"
  | "record_to_computer"
  | "record_to_cloud"
  | "live_translation"
  | "registration"
  | "smart_recording"
  | "multi_speaker"
  | "meeting_wallpaper"
  | "gen_ai_virtual_background"
  | "multi_share"
  | "document_collaboration"
  | "portrait_lighting"
  | "personalized_audio_isolation"
  | "color_themes";

meeting_type?¶

optional meeting_type?: "all" | "meeting" | "webinar";

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

report_type?¶

optional report_type?: "all" | "poll" | "survey" | "qa" | "resource" | "reaction";

search_key?¶

optional search_key?: string;

to¶

to: string;

GET /report/meeting_activities¶

GET /report/meeting_activities: {
  activity_type:   | "All Activities"
     | "Meeting Created"
     | "Meeting Started"
     | "User Join"
     | "User Left"
     | "Remote Control"
     | "In-Meeting Chat"
     | "Meeting Ended";
  from: string;
  meeting_number?: string;
  next_page_token?: string;
  page_size?: number;
  search_key?: string;
  to: string;
};

activity_type¶

activity_type:
  | "All Activities"
  | "Meeting Created"
  | "Meeting Started"
  | "User Join"
  | "User Left"
  | "Remote Control"
  | "In-Meeting Chat"
  | "Meeting Ended";

from¶

from: string;

meeting_number?¶

optional meeting_number?: string;

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

search_key?¶

optional search_key?: string;

to¶

to: string;

GET /report/meetings/{meetingId}¶

GET /report/meetings/{meetingId}: {
};

GET /report/meetings/{meetingId}/participants¶

GET /report/meetings/{meetingId}/participants: {
  include_fields?: "registrant_id";
  next_page_token?: string;
  page_size?: number;
};

include_fields?¶

optional include_fields?: "registrant_id";

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

GET /report/meetings/{meetingId}/polls¶

GET /report/meetings/{meetingId}/polls: {
};

GET /report/meetings/{meetingId}/qa¶

GET /report/meetings/{meetingId}/qa: {
};

GET /report/meetings/{meetingId}/survey¶

GET /report/meetings/{meetingId}/survey: {
};

GET /report/operationlogs¶

GET /report/operationlogs: {
  category_type?:   | "user"
     | "recording"
     | "role"
     | "all"
     | "webinar"
     | "user_settings"
     | "account"
     | "billing"
     | "im"
     | "phone_contacts"
     | "sub_account"
     | "zoom_rooms";
  from: string;
  next_page_token?: string;
  page_size?: number;
  to: string;
};

category_type?¶

optional category_type?:
  | "user"
  | "recording"
  | "role"
  | "all"
  | "webinar"
  | "user_settings"
  | "account"
  | "billing"
  | "im"
  | "phone_contacts"
  | "sub_account"
  | "zoom_rooms";

from¶

from: string;

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

to¶

to: string;

GET /report/remote_support¶

GET /report/remote_support: {
  from: string;
  next_page_token?: string;
  page_size?: string;
  to: string;
};

from¶

from: string;

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: string;

to¶

to: string;

GET /report/telephone¶

GET /report/telephone: {
  from: string;
  next_page_token?: string;
  page_number?: number;
  page_size?: number;
  query_date_type?: "meeting_start_time" | "start_time" | "end_time" | "meeting_end_time";
  to: string;
  type?: "2" | "1" | "3";
};

from¶

from: string;

next_page_token?¶

optional next_page_token?: string;

page_number?¶

optional page_number?: number;

page_size?¶

optional page_size?: number;

query_date_type?¶

optional query_date_type?: "meeting_start_time" | "start_time" | "end_time" | "meeting_end_time";

to¶

to: string;

type?¶

optional type?: "2" | "1" | "3";

GET /report/upcoming_events¶

GET /report/upcoming_events: {
  from: string;
  group_id?: string;
  next_page_token?: string;
  page_size?: number;
  to: string;
  type?: "all" | "meeting" | "webinar";
};

from¶

from: string;

group_id?¶

optional group_id?: string;

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

to¶

to: string;

type?¶

optional type?: "all" | "meeting" | "webinar";

GET /report/users¶

GET /report/users: {
  from: string;
  group_id?: string;
  next_page_token?: string;
  page_number?: number;
  page_size?: number;
  to: string;
  type?: "active" | "inactive";
};

from¶

from: string;

group_id?¶

optional group_id?: string;

next_page_token?¶

optional next_page_token?: string;

page_number?¶

optional page_number?: number;

page_size?¶

optional page_size?: number;

to¶

to: string;

type?¶

optional type?: "active" | "inactive";

GET /report/users/{userId}/meetings¶

GET /report/users/{userId}/meetings: {
  from: string;
  next_page_token?: string;
  page_size?: number;
  to: string;
  type?: "past" | "pastOne" | "pastJoined";
};

from¶

from: string;

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

to¶

to: string;

type?¶

optional type?: "past" | "pastOne" | "pastJoined";

GET /report/webinars/{webinarId}¶

GET /report/webinars/{webinarId}: {
};

GET /report/webinars/{webinarId}/participants¶

GET /report/webinars/{webinarId}/participants: {
  include_fields?: "registrant_id";
  next_page_token?: string;
  page_size?: number;
};

include_fields?¶

optional include_fields?: "registrant_id";

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

GET /report/webinars/{webinarId}/polls¶

GET /report/webinars/{webinarId}/polls: {
};

GET /report/webinars/{webinarId}/qa¶

GET /report/webinars/{webinarId}/qa: {
};

GET /report/webinars/{webinarId}/survey¶

GET /report/webinars/{webinarId}/survey: {
};

GET /sip_phones/phones¶

GET /sip_phones/phones: {
  next_page_token?: string;
  page_size?: number;
  search_key?: string;
};

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

search_key?¶

optional search_key?: string;

GET /tracking_fields¶

GET /tracking_fields: {
};

GET /tracking_fields/{fieldId}¶

GET /tracking_fields/{fieldId}: {
};

GET /tsp¶

GET /tsp: {
};

GET /users/{userId}/meeting_templates¶

GET /users/{userId}/meeting_templates: {
};

GET /users/{userId}/meetings¶

GET /users/{userId}/meetings: {
  from?: string;
  next_page_token?: string;
  page_number?: number;
  page_size?: number;
  timezone?: string;
  to?: string;
  type?:   | "live"
     | "scheduled"
     | "upcoming"
     | "upcoming_meetings"
     | "previous_meetings";
};

from?¶

optional from?: string;

next_page_token?¶

optional next_page_token?: string;

page_number?¶

optional page_number?: number;

page_size?¶

optional page_size?: number;

timezone?¶

optional timezone?: string;

to?¶

optional to?: string;

type?¶

optional type?:
  | "live"
  | "scheduled"
  | "upcoming"
  | "upcoming_meetings"
  | "previous_meetings";

GET /users/{userId}/pac¶

GET /users/{userId}/pac: {
};

GET /users/{userId}/recordings¶

GET /users/{userId}/recordings: {
  from?: string;
  mc?: string;
  meeting_id?: number;
  next_page_token?: string;
  page_size?: number;
  to?: string;
  trash?: boolean;
  trash_type?: string;
};

from?¶

optional from?: string;

mc?¶

optional mc?: string;

meeting_id?¶

optional meeting_id?: number;

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

to?¶

optional to?: string;

trash?¶

optional trash?: boolean;

trash_type?¶

optional trash_type?: string;

GET /users/{userId}/tsp¶

GET /users/{userId}/tsp: {
};

GET /users/{userId}/tsp/{tspId}¶

GET /users/{userId}/tsp/{tspId}: {
};

GET /users/{userId}/upcoming_meetings¶

GET /users/{userId}/upcoming_meetings: {
};

GET /users/{userId}/webinar_templates¶

GET /users/{userId}/webinar_templates: {
};

GET /users/{userId}/webinars¶

GET /users/{userId}/webinars: {
  include_events_webinar?: boolean;
  page_number?: number;
  page_size?: number;
  type?: "scheduled" | "upcoming";
};

include_events_webinar?¶

optional include_events_webinar?: boolean;

page_number?¶

optional page_number?: number;

page_size?¶

optional page_size?: number;

type?¶

optional type?: "scheduled" | "upcoming";

GET /webinars/{webinarId}¶

GET /webinars/{webinarId}: {
  occurrence_id?: string;
  show_previous_occurrences?: boolean;
};

occurrence_id?¶

optional occurrence_id?: string;

show_previous_occurrences?¶

optional show_previous_occurrences?: boolean;

GET /webinars/{webinarId}/branding¶

GET /webinars/{webinarId}/branding: {
};

GET /webinars/{webinarId}/jointoken/live_streaming¶

GET /webinars/{webinarId}/jointoken/live_streaming: {
};

GET /webinars/{webinarId}/jointoken/local_archiving¶

GET /webinars/{webinarId}/jointoken/local_archiving: {
};

GET /webinars/{webinarId}/jointoken/local_recording¶

GET /webinars/{webinarId}/jointoken/local_recording: {
};

GET /webinars/{webinarId}/livestream¶

GET /webinars/{webinarId}/livestream: {
};

GET /webinars/{webinarId}/panelists¶

GET /webinars/{webinarId}/panelists: {
};

GET /webinars/{webinarId}/polls¶

GET /webinars/{webinarId}/polls: {
  anonymous?: boolean;
};

anonymous?¶

optional anonymous?: boolean;

GET /webinars/{webinarId}/polls/{pollId}¶

GET /webinars/{webinarId}/polls/{pollId}: {
};

GET /webinars/{webinarId}/registrants¶

GET /webinars/{webinarId}/registrants: {
  next_page_token?: string;
  occurrence_id?: string;
  page_number?: number;
  page_size?: number;
  status?: "pending" | "approved" | "denied";
  tracking_source_id?: string;
};

next_page_token?¶

optional next_page_token?: string;

occurrence_id?¶

optional occurrence_id?: string;

page_number?¶

optional page_number?: number;

page_size?¶

optional page_size?: number;

status?¶

optional status?: "pending" | "approved" | "denied";

tracking_source_id?¶

optional tracking_source_id?: string;

GET /webinars/{webinarId}/registrants/{registrantId}¶

GET /webinars/{webinarId}/registrants/{registrantId}: {
  occurrence_id?: string;
};

occurrence_id?¶

optional occurrence_id?: string;

GET /webinars/{webinarId}/registrants/questions¶

GET /webinars/{webinarId}/registrants/questions: {
};

GET /webinars/{webinarId}/survey¶

GET /webinars/{webinarId}/survey: {
};

GET /webinars/{webinarId}/token¶

GET /webinars/{webinarId}/token: {
  type?: "closed_caption_token";
};

type?¶

optional type?: "closed_caption_token";

GET /webinars/{webinarId}/tracking_sources¶

GET /webinars/{webinarId}/tracking_sources: {
};

PATCH /archive_files/{fileId}¶

PATCH /archive_files/{fileId}: {
};

PATCH /devices/{deviceId}¶

PATCH /devices/{deviceId}: {
};

PATCH /devices/{deviceId}/assign_group¶

PATCH /devices/{deviceId}/assign_group: {
  group_id: string;
};

group_id¶

group_id: string;

PATCH /devices/{deviceId}/assignment¶

PATCH /devices/{deviceId}/assignment: {
};

PATCH /h323/devices/{deviceId}¶

PATCH /h323/devices/{deviceId}: {
};

PATCH /live_meetings/{meetingId}/chat/messages/{messageId}¶

PATCH /live_meetings/{meetingId}/chat/messages/{messageId}: {
};

PATCH /live_meetings/{meetingId}/events¶

PATCH /live_meetings/{meetingId}/events: {
};

PATCH /live_meetings/{meetingId}/rtms_app/status¶

PATCH /live_meetings/{meetingId}/rtms_app/status: {
};

PATCH /meetings/{meetingId}¶

PATCH /meetings/{meetingId}: {
  occurrence_id?: string;
};

occurrence_id?¶

optional occurrence_id?: string;

PATCH /meetings/{meetingId}/livestream¶

PATCH /meetings/{meetingId}/livestream: {
};

PATCH /meetings/{meetingId}/livestream/status¶

PATCH /meetings/{meetingId}/livestream/status: {
};

PATCH /meetings/{meetingId}/recordings/registrants/questions¶

PATCH /meetings/{meetingId}/recordings/registrants/questions: {
};

PATCH /meetings/{meetingId}/recordings/settings¶

PATCH /meetings/{meetingId}/recordings/settings: {
};

PATCH /meetings/{meetingId}/registrants/questions¶

PATCH /meetings/{meetingId}/registrants/questions: {
};

PATCH /meetings/{meetingId}/survey¶

PATCH /meetings/{meetingId}/survey: {
};

PATCH /sip_phones/phones/{phoneId}¶

PATCH /sip_phones/phones/{phoneId}: {
};

PATCH /tracking_fields/{fieldId}¶

PATCH /tracking_fields/{fieldId}: {
};

PATCH /tsp¶

PATCH /tsp: {
};

PATCH /users/{userId}/tsp/{tspId}¶

PATCH /users/{userId}/tsp/{tspId}: {
};

PATCH /users/{userId}/tsp/settings¶

PATCH /users/{userId}/tsp/settings: {
};

PATCH /webinars/{webinarId}¶

PATCH /webinars/{webinarId}: {
  occurrence_id?: string;
};

occurrence_id?¶

optional occurrence_id?: string;

PATCH /webinars/{webinarId}/branding/name_tags/{nameTagId}¶

PATCH /webinars/{webinarId}/branding/name_tags/{nameTagId}: {
};

PATCH /webinars/{webinarId}/branding/virtual_backgrounds¶

PATCH /webinars/{webinarId}/branding/virtual_backgrounds: {
  id?: string;
  set_default_for_all_panelists?: boolean;
};

id?¶

optional id?: string;

set_default_for_all_panelists?¶

optional set_default_for_all_panelists?: boolean;

PATCH /webinars/{webinarId}/livestream¶

PATCH /webinars/{webinarId}/livestream: {
};

PATCH /webinars/{webinarId}/livestream/status¶

PATCH /webinars/{webinarId}/livestream/status: {
};

PATCH /webinars/{webinarId}/registrants/questions¶

PATCH /webinars/{webinarId}/registrants/questions: {
};

PATCH /webinars/{webinarId}/survey¶

PATCH /webinars/{webinarId}/survey: {
};

POST /devices¶

POST /devices: {
};

POST /devices/zpa/assignment¶

POST /devices/zpa/assignment: {
};

POST /devices/zpa/upgrade¶

POST /devices/zpa/upgrade: {
};

POST /h323/devices¶

POST /h323/devices: {
};

POST /meetings/{meetingId}/batch_polls¶

POST /meetings/{meetingId}/batch_polls: {
};

POST /meetings/{meetingId}/batch_registrants¶

POST /meetings/{meetingId}/batch_registrants: {
};

POST /meetings/{meetingId}/invite_links¶

POST /meetings/{meetingId}/invite_links: {
};

POST /meetings/{meetingId}/open_apps¶

POST /meetings/{meetingId}/open_apps: {
};

POST /meetings/{meetingId}/polls¶

POST /meetings/{meetingId}/polls: {
};

POST /meetings/{meetingId}/recordings/registrants¶

POST /meetings/{meetingId}/recordings/registrants: {
};

POST /meetings/{meetingId}/registrants¶

POST /meetings/{meetingId}/registrants: {
  occurrence_ids?: string;
};

occurrence_ids?¶

optional occurrence_ids?: string;

POST /meetings/{meetingId}/sip_dialing¶

POST /meetings/{meetingId}/sip_dialing: {
};

POST /sip_phones/phones¶

POST /sip_phones/phones: {
};

POST /tracking_fields¶

POST /tracking_fields: {
};

POST /users/{userId}/meeting_templates¶

POST /users/{userId}/meeting_templates: {
};

POST /users/{userId}/meetings¶

POST /users/{userId}/meetings: {
};

POST /users/{userId}/tsp¶

POST /users/{userId}/tsp: {
};

POST /users/{userId}/webinar_templates¶

POST /users/{userId}/webinar_templates: {
};

POST /users/{userId}/webinars¶

POST /users/{userId}/webinars: {
};

POST /webinars/{webinarId}/batch_registrants¶

POST /webinars/{webinarId}/batch_registrants: {
};

POST /webinars/{webinarId}/branding/name_tags¶

POST /webinars/{webinarId}/branding/name_tags: {
};

POST /webinars/{webinarId}/branding/virtual_backgrounds¶

POST /webinars/{webinarId}/branding/virtual_backgrounds: {
};

POST /webinars/{webinarId}/branding/wallpaper¶

POST /webinars/{webinarId}/branding/wallpaper: {
};

POST /webinars/{webinarId}/invite_links¶

POST /webinars/{webinarId}/invite_links: {
};

POST /webinars/{webinarId}/panelists¶

POST /webinars/{webinarId}/panelists: {
};

POST /webinars/{webinarId}/polls¶

POST /webinars/{webinarId}/polls: {
};

POST /webinars/{webinarId}/registrants¶

POST /webinars/{webinarId}/registrants: {
  occurrence_ids?: string;
};

occurrence_ids?¶

optional occurrence_ids?: string;

POST /webinars/{webinarId}/sip_dialing¶

POST /webinars/{webinarId}/sip_dialing: {
};

PUT /meetings/{meetingId}/polls/{pollId}¶

PUT /meetings/{meetingId}/polls/{pollId}: {
};

PUT /meetings/{meetingId}/recordings/{recordingId}/status¶

PUT /meetings/{meetingId}/recordings/{recordingId}/status: {
};

PUT /meetings/{meetingId}/recordings/registrants/status¶

PUT /meetings/{meetingId}/recordings/registrants/status: {
};

PUT /meetings/{meetingId}/registrants/status¶

PUT /meetings/{meetingId}/registrants/status: {
  occurrence_id?: string;
};

occurrence_id?¶

optional occurrence_id?: string;

PUT /meetings/{meetingId}/status¶

PUT /meetings/{meetingId}/status: {
};

PUT /meetings/{meetingUUID}/recordings/status¶

PUT /meetings/{meetingUUID}/recordings/status: {
};

PUT /webinars/{webinarId}/polls/{pollId}¶

PUT /webinars/{webinarId}/polls/{pollId}: {
};

PUT /webinars/{webinarId}/registrants/status¶

PUT /webinars/{webinarId}/registrants/status: {
  occurrence_id?: string;
};

occurrence_id?¶

optional occurrence_id?: string;

PUT /webinars/{webinarId}/status¶

PUT /webinars/{webinarId}/status: {
};

ZoomMeetingsApiOperationQueryRequiredMap¶

Properties¶

DELETE /devices/{deviceId}¶

DELETE /devices/{deviceId}: false;

DELETE /devices/zpa/vendors/{vendor}/mac_addresses/{macAddress}¶

DELETE /devices/zpa/vendors/{vendor}/mac_addresses/{macAddress}: false;

DELETE /h323/devices/{deviceId}¶

DELETE /h323/devices/{deviceId}: false;

DELETE /live_meetings/{meetingId}/chat/messages/{messageId}¶

DELETE /live_meetings/{meetingId}/chat/messages/{messageId}: false;

DELETE /live_webinars/{webinarId}/chat/messages/{messageId}¶

DELETE /live_webinars/{webinarId}/chat/messages/{messageId}: false;

DELETE /meetings/{meetingId}¶

DELETE /meetings/{meetingId}: false;

DELETE /meetings/{meetingId}/meeting_summary¶

DELETE /meetings/{meetingId}/meeting_summary: false;

DELETE /meetings/{meetingId}/open_apps¶

DELETE /meetings/{meetingId}/open_apps: false;

DELETE /meetings/{meetingId}/polls/{pollId}¶

DELETE /meetings/{meetingId}/polls/{pollId}: false;

DELETE /meetings/{meetingId}/recordings¶

DELETE /meetings/{meetingId}/recordings: false;

DELETE /meetings/{meetingId}/recordings/{recordingId}¶

DELETE /meetings/{meetingId}/recordings/{recordingId}: false;

DELETE /meetings/{meetingId}/registrants/{registrantId}¶

DELETE /meetings/{meetingId}/registrants/{registrantId}: false;

DELETE /meetings/{meetingId}/survey¶

DELETE /meetings/{meetingId}/survey: false;

DELETE /meetings/{meetingId}/transcript¶

DELETE /meetings/{meetingId}/transcript: false;

DELETE /past_meetings/{meetingUUID}/archive_files¶

DELETE /past_meetings/{meetingUUID}/archive_files: false;

DELETE /sip_phones/phones/{phoneId}¶

DELETE /sip_phones/phones/{phoneId}: false;

DELETE /tracking_fields/{fieldId}¶

DELETE /tracking_fields/{fieldId}: false;

DELETE /users/{userId}/tsp/{tspId}¶

DELETE /users/{userId}/tsp/{tspId}: false;

DELETE /webinars/{webinarId}¶

DELETE /webinars/{webinarId}: false;

DELETE /webinars/{webinarId}/branding/name_tags¶

DELETE /webinars/{webinarId}/branding/name_tags: false;

DELETE /webinars/{webinarId}/branding/virtual_backgrounds¶

DELETE /webinars/{webinarId}/branding/virtual_backgrounds: false;

DELETE /webinars/{webinarId}/branding/wallpaper¶

DELETE /webinars/{webinarId}/branding/wallpaper: false;

DELETE /webinars/{webinarId}/panelists¶

DELETE /webinars/{webinarId}/panelists: false;

DELETE /webinars/{webinarId}/panelists/{panelistId}¶

DELETE /webinars/{webinarId}/panelists/{panelistId}: false;

DELETE /webinars/{webinarId}/polls/{pollId}¶

DELETE /webinars/{webinarId}/polls/{pollId}: false;

DELETE /webinars/{webinarId}/registrants/{registrantId}¶

DELETE /webinars/{webinarId}/registrants/{registrantId}: false;

DELETE /webinars/{webinarId}/survey¶

DELETE /webinars/{webinarId}/survey: false;

GET /archive_files¶

GET /archive_files: false;

GET /archive_files/statistics¶

GET /archive_files/statistics: false;

GET /devices¶

GET /devices: false;

GET /devices/{deviceId}¶

GET /devices/{deviceId}: false;

GET /devices/groups¶

GET /devices/groups: false;

GET /devices/zpa/settings¶

GET /devices/zpa/settings: false;

GET /devices/zpa/zdm_groups/{zdmGroupId}/versions¶

GET /devices/zpa/zdm_groups/{zdmGroupId}/versions: false;

GET /h323/devices¶

GET /h323/devices: false;

GET /meetings/{meetingId}¶

GET /meetings/{meetingId}: false;

GET /meetings/{meetingId}/invitation¶

GET /meetings/{meetingId}/invitation: false;

GET /meetings/{meetingId}/jointoken/live_streaming¶

GET /meetings/{meetingId}/jointoken/live_streaming: false;

GET /meetings/{meetingId}/jointoken/local_archiving¶

GET /meetings/{meetingId}/jointoken/local_archiving: false;

GET /meetings/{meetingId}/jointoken/local_recording¶

GET /meetings/{meetingId}/jointoken/local_recording: false;

GET /meetings/{meetingId}/livestream¶

GET /meetings/{meetingId}/livestream: false;

GET /meetings/{meetingId}/meeting_summary¶

GET /meetings/{meetingId}/meeting_summary: false;

GET /meetings/{meetingId}/polls¶

GET /meetings/{meetingId}/polls: false;

GET /meetings/{meetingId}/polls/{pollId}¶

GET /meetings/{meetingId}/polls/{pollId}: false;

GET /meetings/{meetingId}/recordings¶

GET /meetings/{meetingId}/recordings: false;

GET /meetings/{meetingId}/recordings/analytics_details¶

GET /meetings/{meetingId}/recordings/analytics_details: false;

GET /meetings/{meetingId}/recordings/analytics_summary¶

GET /meetings/{meetingId}/recordings/analytics_summary: false;

GET /meetings/{meetingId}/recordings/registrants¶

GET /meetings/{meetingId}/recordings/registrants: false;

GET /meetings/{meetingId}/recordings/registrants/questions¶

GET /meetings/{meetingId}/recordings/registrants/questions: false;

GET /meetings/{meetingId}/recordings/settings¶

GET /meetings/{meetingId}/recordings/settings: false;

GET /meetings/{meetingId}/registrants¶

GET /meetings/{meetingId}/registrants: false;

GET /meetings/{meetingId}/registrants/{registrantId}¶

GET /meetings/{meetingId}/registrants/{registrantId}: false;

GET /meetings/{meetingId}/registrants/questions¶

GET /meetings/{meetingId}/registrants/questions: false;

GET /meetings/{meetingId}/survey¶

GET /meetings/{meetingId}/survey: false;

GET /meetings/{meetingId}/token¶

GET /meetings/{meetingId}/token: false;

GET /meetings/{meetingId}/transcript¶

GET /meetings/{meetingId}/transcript: false;

GET /meetings/meeting_summaries¶

GET /meetings/meeting_summaries: false;

GET /past_meetings/{meetingId}¶

GET /past_meetings/{meetingId}: false;

GET /past_meetings/{meetingId}/instances¶

GET /past_meetings/{meetingId}/instances: false;

GET /past_meetings/{meetingId}/participants¶

GET /past_meetings/{meetingId}/participants: false;

GET /past_meetings/{meetingId}/polls¶

GET /past_meetings/{meetingId}/polls: false;

GET /past_meetings/{meetingId}/qa¶

GET /past_meetings/{meetingId}/qa: false;

GET /past_meetings/{meetingUUID}/archive_files¶

GET /past_meetings/{meetingUUID}/archive_files: false;

GET /past_webinars/{webinarId}/absentees¶

GET /past_webinars/{webinarId}/absentees: false;

GET /past_webinars/{webinarId}/instances¶

GET /past_webinars/{webinarId}/instances: false;

GET /past_webinars/{webinarId}/participants¶

GET /past_webinars/{webinarId}/participants: false;

GET /past_webinars/{webinarId}/polls¶

GET /past_webinars/{webinarId}/polls: false;

GET /past_webinars/{webinarId}/qa¶

GET /past_webinars/{webinarId}/qa: false;

GET /report/activities¶

GET /report/activities: false;

GET /report/billing¶

GET /report/billing: false;

GET /report/billing/invoices¶

GET /report/billing/invoices: true;

GET /report/cloud_recording¶

GET /report/cloud_recording: true;

GET /report/daily¶

GET /report/daily: false;

GET /report/disclaimer¶

GET /report/disclaimer: true;

GET /report/history_meetings¶

GET /report/history_meetings: true;

GET /report/meeting_activities¶

GET /report/meeting_activities: true;

GET /report/meetings/{meetingId}¶

GET /report/meetings/{meetingId}: false;

GET /report/meetings/{meetingId}/participants¶

GET /report/meetings/{meetingId}/participants: false;

GET /report/meetings/{meetingId}/polls¶

GET /report/meetings/{meetingId}/polls: false;

GET /report/meetings/{meetingId}/qa¶

GET /report/meetings/{meetingId}/qa: false;

GET /report/meetings/{meetingId}/survey¶

GET /report/meetings/{meetingId}/survey: false;

GET /report/operationlogs¶

GET /report/operationlogs: true;

GET /report/remote_support¶

GET /report/remote_support: true;

GET /report/telephone¶

GET /report/telephone: true;

GET /report/upcoming_events¶

GET /report/upcoming_events: true;

GET /report/users¶

GET /report/users: true;

GET /report/users/{userId}/meetings¶

GET /report/users/{userId}/meetings: true;

GET /report/webinars/{webinarId}¶

GET /report/webinars/{webinarId}: false;

GET /report/webinars/{webinarId}/participants¶

GET /report/webinars/{webinarId}/participants: false;

GET /report/webinars/{webinarId}/polls¶

GET /report/webinars/{webinarId}/polls: false;

GET /report/webinars/{webinarId}/qa¶

GET /report/webinars/{webinarId}/qa: false;

GET /report/webinars/{webinarId}/survey¶

GET /report/webinars/{webinarId}/survey: false;

GET /sip_phones/phones¶

GET /sip_phones/phones: false;

GET /tracking_fields¶

GET /tracking_fields: false;

GET /tracking_fields/{fieldId}¶

GET /tracking_fields/{fieldId}: false;

GET /tsp¶

GET /tsp: false;

GET /users/{userId}/meeting_templates¶

GET /users/{userId}/meeting_templates: false;

GET /users/{userId}/meetings¶

GET /users/{userId}/meetings: false;

GET /users/{userId}/pac¶

GET /users/{userId}/pac: false;

GET /users/{userId}/recordings¶

GET /users/{userId}/recordings: false;

GET /users/{userId}/tsp¶

GET /users/{userId}/tsp: false;

GET /users/{userId}/tsp/{tspId}¶

GET /users/{userId}/tsp/{tspId}: false;

GET /users/{userId}/upcoming_meetings¶

GET /users/{userId}/upcoming_meetings: false;

GET /users/{userId}/webinar_templates¶

GET /users/{userId}/webinar_templates: false;

GET /users/{userId}/webinars¶

GET /users/{userId}/webinars: false;

GET /webinars/{webinarId}¶

GET /webinars/{webinarId}: false;

GET /webinars/{webinarId}/branding¶

GET /webinars/{webinarId}/branding: false;

GET /webinars/{webinarId}/jointoken/live_streaming¶

GET /webinars/{webinarId}/jointoken/live_streaming: false;

GET /webinars/{webinarId}/jointoken/local_archiving¶

GET /webinars/{webinarId}/jointoken/local_archiving: false;

GET /webinars/{webinarId}/jointoken/local_recording¶

GET /webinars/{webinarId}/jointoken/local_recording: false;

GET /webinars/{webinarId}/livestream¶

GET /webinars/{webinarId}/livestream: false;

GET /webinars/{webinarId}/panelists¶

GET /webinars/{webinarId}/panelists: false;

GET /webinars/{webinarId}/polls¶

GET /webinars/{webinarId}/polls: false;

GET /webinars/{webinarId}/polls/{pollId}¶

GET /webinars/{webinarId}/polls/{pollId}: false;

GET /webinars/{webinarId}/registrants¶

GET /webinars/{webinarId}/registrants: false;

GET /webinars/{webinarId}/registrants/{registrantId}¶

GET /webinars/{webinarId}/registrants/{registrantId}: false;

GET /webinars/{webinarId}/registrants/questions¶

GET /webinars/{webinarId}/registrants/questions: false;

GET /webinars/{webinarId}/survey¶

GET /webinars/{webinarId}/survey: false;

GET /webinars/{webinarId}/token¶

GET /webinars/{webinarId}/token: false;

GET /webinars/{webinarId}/tracking_sources¶

GET /webinars/{webinarId}/tracking_sources: false;

PATCH /archive_files/{fileId}¶

PATCH /archive_files/{fileId}: false;

PATCH /devices/{deviceId}¶

PATCH /devices/{deviceId}: false;

PATCH /devices/{deviceId}/assign_group¶

PATCH /devices/{deviceId}/assign_group: true;

PATCH /devices/{deviceId}/assignment¶

PATCH /devices/{deviceId}/assignment: false;

PATCH /h323/devices/{deviceId}¶

PATCH /h323/devices/{deviceId}: false;

PATCH /live_meetings/{meetingId}/chat/messages/{messageId}¶

PATCH /live_meetings/{meetingId}/chat/messages/{messageId}: false;

PATCH /live_meetings/{meetingId}/events¶

PATCH /live_meetings/{meetingId}/events: false;

PATCH /live_meetings/{meetingId}/rtms_app/status¶

PATCH /live_meetings/{meetingId}/rtms_app/status: false;

PATCH /meetings/{meetingId}¶

PATCH /meetings/{meetingId}: false;

PATCH /meetings/{meetingId}/livestream¶

PATCH /meetings/{meetingId}/livestream: false;

PATCH /meetings/{meetingId}/livestream/status¶

PATCH /meetings/{meetingId}/livestream/status: false;

PATCH /meetings/{meetingId}/recordings/registrants/questions¶

PATCH /meetings/{meetingId}/recordings/registrants/questions: false;

PATCH /meetings/{meetingId}/recordings/settings¶

PATCH /meetings/{meetingId}/recordings/settings: false;

PATCH /meetings/{meetingId}/registrants/questions¶

PATCH /meetings/{meetingId}/registrants/questions: false;

PATCH /meetings/{meetingId}/survey¶

PATCH /meetings/{meetingId}/survey: false;

PATCH /sip_phones/phones/{phoneId}¶

PATCH /sip_phones/phones/{phoneId}: false;

PATCH /tracking_fields/{fieldId}¶

PATCH /tracking_fields/{fieldId}: false;

PATCH /tsp¶

PATCH /tsp: false;

PATCH /users/{userId}/tsp/{tspId}¶

PATCH /users/{userId}/tsp/{tspId}: false;

PATCH /users/{userId}/tsp/settings¶

PATCH /users/{userId}/tsp/settings: false;

PATCH /webinars/{webinarId}¶

PATCH /webinars/{webinarId}: false;

PATCH /webinars/{webinarId}/branding/name_tags/{nameTagId}¶

PATCH /webinars/{webinarId}/branding/name_tags/{nameTagId}: false;

PATCH /webinars/{webinarId}/branding/virtual_backgrounds¶

PATCH /webinars/{webinarId}/branding/virtual_backgrounds: false;

PATCH /webinars/{webinarId}/livestream¶

PATCH /webinars/{webinarId}/livestream: false;

PATCH /webinars/{webinarId}/livestream/status¶

PATCH /webinars/{webinarId}/livestream/status: false;

PATCH /webinars/{webinarId}/registrants/questions¶

PATCH /webinars/{webinarId}/registrants/questions: false;

PATCH /webinars/{webinarId}/survey¶

PATCH /webinars/{webinarId}/survey: false;

POST /devices¶

POST /devices: false;

POST /devices/zpa/assignment¶

POST /devices/zpa/assignment: false;

POST /devices/zpa/upgrade¶

POST /devices/zpa/upgrade: false;

POST /h323/devices¶

POST /h323/devices: false;

POST /meetings/{meetingId}/batch_polls¶

POST /meetings/{meetingId}/batch_polls: false;

POST /meetings/{meetingId}/batch_registrants¶

POST /meetings/{meetingId}/batch_registrants: false;

POST /meetings/{meetingId}/invite_links¶

POST /meetings/{meetingId}/invite_links: false;

POST /meetings/{meetingId}/open_apps¶

POST /meetings/{meetingId}/open_apps: false;

POST /meetings/{meetingId}/polls¶

POST /meetings/{meetingId}/polls: false;

POST /meetings/{meetingId}/recordings/registrants¶

POST /meetings/{meetingId}/recordings/registrants: false;

POST /meetings/{meetingId}/registrants¶

POST /meetings/{meetingId}/registrants: false;

POST /meetings/{meetingId}/sip_dialing¶

POST /meetings/{meetingId}/sip_dialing: false;

POST /sip_phones/phones¶

POST /sip_phones/phones: false;

POST /tracking_fields¶

POST /tracking_fields: false;

POST /users/{userId}/meeting_templates¶

POST /users/{userId}/meeting_templates: false;

POST /users/{userId}/meetings¶

POST /users/{userId}/meetings: false;

POST /users/{userId}/tsp¶

POST /users/{userId}/tsp: false;

POST /users/{userId}/webinar_templates¶

POST /users/{userId}/webinar_templates: false;

POST /users/{userId}/webinars¶

POST /users/{userId}/webinars: false;

POST /webinars/{webinarId}/batch_registrants¶

POST /webinars/{webinarId}/batch_registrants: false;

POST /webinars/{webinarId}/branding/name_tags¶

POST /webinars/{webinarId}/branding/name_tags: false;

POST /webinars/{webinarId}/branding/virtual_backgrounds¶

POST /webinars/{webinarId}/branding/virtual_backgrounds: false;

POST /webinars/{webinarId}/branding/wallpaper¶

POST /webinars/{webinarId}/branding/wallpaper: false;

POST /webinars/{webinarId}/invite_links¶

POST /webinars/{webinarId}/invite_links: false;

POST /webinars/{webinarId}/panelists¶

POST /webinars/{webinarId}/panelists: false;

POST /webinars/{webinarId}/polls¶

POST /webinars/{webinarId}/polls: false;

POST /webinars/{webinarId}/registrants¶

POST /webinars/{webinarId}/registrants: false;

POST /webinars/{webinarId}/sip_dialing¶

POST /webinars/{webinarId}/sip_dialing: false;

PUT /meetings/{meetingId}/polls/{pollId}¶

PUT /meetings/{meetingId}/polls/{pollId}: false;

PUT /meetings/{meetingId}/recordings/{recordingId}/status¶

PUT /meetings/{meetingId}/recordings/{recordingId}/status: false;

PUT /meetings/{meetingId}/recordings/registrants/status¶

PUT /meetings/{meetingId}/recordings/registrants/status: false;

PUT /meetings/{meetingId}/registrants/status¶

PUT /meetings/{meetingId}/registrants/status: false;

PUT /meetings/{meetingId}/status¶

PUT /meetings/{meetingId}/status: false;

PUT /meetings/{meetingUUID}/recordings/status¶

PUT /meetings/{meetingUUID}/recordings/status: false;

PUT /webinars/{webinarId}/polls/{pollId}¶

PUT /webinars/{webinarId}/polls/{pollId}: false;

PUT /webinars/{webinarId}/registrants/status¶

PUT /webinars/{webinarId}/registrants/status: false;

PUT /webinars/{webinarId}/status¶

PUT /webinars/{webinarId}/status: false;

ZoomMeetingsApiOperationRequestBodyMap¶

Properties¶

DELETE /devices/{deviceId}¶

DELETE /devices/{deviceId}: never;

DELETE /devices/zpa/vendors/{vendor}/mac_addresses/{macAddress}¶

DELETE /devices/zpa/vendors/{vendor}/mac_addresses/{macAddress}: never;

DELETE /h323/devices/{deviceId}¶

DELETE /h323/devices/{deviceId}: never;

DELETE /live_meetings/{meetingId}/chat/messages/{messageId}¶

DELETE /live_meetings/{meetingId}/chat/messages/{messageId}: never;

DELETE /live_webinars/{webinarId}/chat/messages/{messageId}¶

DELETE /live_webinars/{webinarId}/chat/messages/{messageId}: never;

DELETE /meetings/{meetingId}¶

DELETE /meetings/{meetingId}: never;

DELETE /meetings/{meetingId}/meeting_summary¶

DELETE /meetings/{meetingId}/meeting_summary: never;

DELETE /meetings/{meetingId}/open_apps¶

DELETE /meetings/{meetingId}/open_apps: never;

DELETE /meetings/{meetingId}/polls/{pollId}¶

DELETE /meetings/{meetingId}/polls/{pollId}: never;

DELETE /meetings/{meetingId}/recordings¶

DELETE /meetings/{meetingId}/recordings: never;

DELETE /meetings/{meetingId}/recordings/{recordingId}¶

DELETE /meetings/{meetingId}/recordings/{recordingId}: never;

DELETE /meetings/{meetingId}/registrants/{registrantId}¶

DELETE /meetings/{meetingId}/registrants/{registrantId}: never;

DELETE /meetings/{meetingId}/survey¶

DELETE /meetings/{meetingId}/survey: never;

DELETE /meetings/{meetingId}/transcript¶

DELETE /meetings/{meetingId}/transcript: never;

DELETE /past_meetings/{meetingUUID}/archive_files¶

DELETE /past_meetings/{meetingUUID}/archive_files: never;

DELETE /sip_phones/phones/{phoneId}¶

DELETE /sip_phones/phones/{phoneId}: never;

DELETE /tracking_fields/{fieldId}¶

DELETE /tracking_fields/{fieldId}: never;

DELETE /users/{userId}/tsp/{tspId}¶

DELETE /users/{userId}/tsp/{tspId}: never;

DELETE /webinars/{webinarId}¶

DELETE /webinars/{webinarId}: never;

DELETE /webinars/{webinarId}/branding/name_tags¶

DELETE /webinars/{webinarId}/branding/name_tags: never;

DELETE /webinars/{webinarId}/branding/virtual_backgrounds¶

DELETE /webinars/{webinarId}/branding/virtual_backgrounds: never;

DELETE /webinars/{webinarId}/branding/wallpaper¶

DELETE /webinars/{webinarId}/branding/wallpaper: never;

DELETE /webinars/{webinarId}/panelists¶

DELETE /webinars/{webinarId}/panelists: never;

DELETE /webinars/{webinarId}/panelists/{panelistId}¶

DELETE /webinars/{webinarId}/panelists/{panelistId}: never;

DELETE /webinars/{webinarId}/polls/{pollId}¶

DELETE /webinars/{webinarId}/polls/{pollId}: never;

DELETE /webinars/{webinarId}/registrants/{registrantId}¶

DELETE /webinars/{webinarId}/registrants/{registrantId}: never;

DELETE /webinars/{webinarId}/survey¶

DELETE /webinars/{webinarId}/survey: never;

GET /archive_files¶

GET /archive_files: never;

GET /archive_files/statistics¶

GET /archive_files/statistics: never;

GET /devices¶

GET /devices: never;

GET /devices/{deviceId}¶

GET /devices/{deviceId}: never;

GET /devices/groups¶

GET /devices/groups: never;

GET /devices/zpa/settings¶

GET /devices/zpa/settings: never;

GET /devices/zpa/zdm_groups/{zdmGroupId}/versions¶

GET /devices/zpa/zdm_groups/{zdmGroupId}/versions: never;

GET /h323/devices¶

GET /h323/devices: never;

GET /meetings/{meetingId}¶

GET /meetings/{meetingId}: never;

GET /meetings/{meetingId}/invitation¶

GET /meetings/{meetingId}/invitation: never;

GET /meetings/{meetingId}/jointoken/live_streaming¶

GET /meetings/{meetingId}/jointoken/live_streaming: never;

GET /meetings/{meetingId}/jointoken/local_archiving¶

GET /meetings/{meetingId}/jointoken/local_archiving: never;

GET /meetings/{meetingId}/jointoken/local_recording¶

GET /meetings/{meetingId}/jointoken/local_recording: never;

GET /meetings/{meetingId}/livestream¶

GET /meetings/{meetingId}/livestream: never;

GET /meetings/{meetingId}/meeting_summary¶

GET /meetings/{meetingId}/meeting_summary: never;

GET /meetings/{meetingId}/polls¶

GET /meetings/{meetingId}/polls: never;

GET /meetings/{meetingId}/polls/{pollId}¶

GET /meetings/{meetingId}/polls/{pollId}: never;

GET /meetings/{meetingId}/recordings¶

GET /meetings/{meetingId}/recordings: never;

GET /meetings/{meetingId}/recordings/analytics_details¶

GET /meetings/{meetingId}/recordings/analytics_details: never;

GET /meetings/{meetingId}/recordings/analytics_summary¶

GET /meetings/{meetingId}/recordings/analytics_summary: never;

GET /meetings/{meetingId}/recordings/registrants¶

GET /meetings/{meetingId}/recordings/registrants: never;

GET /meetings/{meetingId}/recordings/registrants/questions¶

GET /meetings/{meetingId}/recordings/registrants/questions: never;

GET /meetings/{meetingId}/recordings/settings¶

GET /meetings/{meetingId}/recordings/settings: never;

GET /meetings/{meetingId}/registrants¶

GET /meetings/{meetingId}/registrants: never;

GET /meetings/{meetingId}/registrants/{registrantId}¶

GET /meetings/{meetingId}/registrants/{registrantId}: never;

GET /meetings/{meetingId}/registrants/questions¶

GET /meetings/{meetingId}/registrants/questions: never;

GET /meetings/{meetingId}/survey¶

GET /meetings/{meetingId}/survey: never;

GET /meetings/{meetingId}/token¶

GET /meetings/{meetingId}/token: never;

GET /meetings/{meetingId}/transcript¶

GET /meetings/{meetingId}/transcript: never;

GET /meetings/meeting_summaries¶

GET /meetings/meeting_summaries: never;

GET /past_meetings/{meetingId}¶

GET /past_meetings/{meetingId}: never;

GET /past_meetings/{meetingId}/instances¶

GET /past_meetings/{meetingId}/instances: never;

GET /past_meetings/{meetingId}/participants¶

GET /past_meetings/{meetingId}/participants: never;

GET /past_meetings/{meetingId}/polls¶

GET /past_meetings/{meetingId}/polls: never;

GET /past_meetings/{meetingId}/qa¶

GET /past_meetings/{meetingId}/qa: never;

GET /past_meetings/{meetingUUID}/archive_files¶

GET /past_meetings/{meetingUUID}/archive_files: never;

GET /past_webinars/{webinarId}/absentees¶

GET /past_webinars/{webinarId}/absentees: never;

GET /past_webinars/{webinarId}/instances¶

GET /past_webinars/{webinarId}/instances: never;

GET /past_webinars/{webinarId}/participants¶

GET /past_webinars/{webinarId}/participants: never;

GET /past_webinars/{webinarId}/polls¶

GET /past_webinars/{webinarId}/polls: never;

GET /past_webinars/{webinarId}/qa¶

GET /past_webinars/{webinarId}/qa: never;

GET /report/activities¶

GET /report/activities: never;

GET /report/billing¶

GET /report/billing: never;

GET /report/billing/invoices¶

GET /report/billing/invoices: never;

GET /report/cloud_recording¶

GET /report/cloud_recording: never;

GET /report/daily¶

GET /report/daily: never;

GET /report/disclaimer¶

GET /report/disclaimer: never;

GET /report/history_meetings¶

GET /report/history_meetings: never;

GET /report/meeting_activities¶

GET /report/meeting_activities: never;

GET /report/meetings/{meetingId}¶

GET /report/meetings/{meetingId}: never;

GET /report/meetings/{meetingId}/participants¶

GET /report/meetings/{meetingId}/participants: never;

GET /report/meetings/{meetingId}/polls¶

GET /report/meetings/{meetingId}/polls: never;

GET /report/meetings/{meetingId}/qa¶

GET /report/meetings/{meetingId}/qa: never;

GET /report/meetings/{meetingId}/survey¶

GET /report/meetings/{meetingId}/survey: never;

GET /report/operationlogs¶

GET /report/operationlogs: never;

GET /report/remote_support¶

GET /report/remote_support: never;

GET /report/telephone¶

GET /report/telephone: never;

GET /report/upcoming_events¶

GET /report/upcoming_events: never;

GET /report/users¶

GET /report/users: never;

GET /report/users/{userId}/meetings¶

GET /report/users/{userId}/meetings: never;

GET /report/webinars/{webinarId}¶

GET /report/webinars/{webinarId}: never;

GET /report/webinars/{webinarId}/participants¶

GET /report/webinars/{webinarId}/participants: never;

GET /report/webinars/{webinarId}/polls¶

GET /report/webinars/{webinarId}/polls: never;

GET /report/webinars/{webinarId}/qa¶

GET /report/webinars/{webinarId}/qa: never;

GET /report/webinars/{webinarId}/survey¶

GET /report/webinars/{webinarId}/survey: never;

GET /sip_phones/phones¶

GET /sip_phones/phones: never;

GET /tracking_fields¶

GET /tracking_fields: never;

GET /tracking_fields/{fieldId}¶

GET /tracking_fields/{fieldId}: never;

GET /tsp¶

GET /tsp: never;

GET /users/{userId}/meeting_templates¶

GET /users/{userId}/meeting_templates: never;

GET /users/{userId}/meetings¶

GET /users/{userId}/meetings: never;

GET /users/{userId}/pac¶

GET /users/{userId}/pac: never;

GET /users/{userId}/recordings¶

GET /users/{userId}/recordings: never;

GET /users/{userId}/tsp¶

GET /users/{userId}/tsp: never;

GET /users/{userId}/tsp/{tspId}¶

GET /users/{userId}/tsp/{tspId}: never;

GET /users/{userId}/upcoming_meetings¶

GET /users/{userId}/upcoming_meetings: never;

GET /users/{userId}/webinar_templates¶

GET /users/{userId}/webinar_templates: never;

GET /users/{userId}/webinars¶

GET /users/{userId}/webinars: never;

GET /webinars/{webinarId}¶

GET /webinars/{webinarId}: never;

GET /webinars/{webinarId}/branding¶

GET /webinars/{webinarId}/branding: never;

GET /webinars/{webinarId}/jointoken/live_streaming¶

GET /webinars/{webinarId}/jointoken/live_streaming: never;

GET /webinars/{webinarId}/jointoken/local_archiving¶

GET /webinars/{webinarId}/jointoken/local_archiving: never;

GET /webinars/{webinarId}/jointoken/local_recording¶

GET /webinars/{webinarId}/jointoken/local_recording: never;

GET /webinars/{webinarId}/livestream¶

GET /webinars/{webinarId}/livestream: never;

GET /webinars/{webinarId}/panelists¶

GET /webinars/{webinarId}/panelists: never;

GET /webinars/{webinarId}/polls¶

GET /webinars/{webinarId}/polls: never;

GET /webinars/{webinarId}/polls/{pollId}¶

GET /webinars/{webinarId}/polls/{pollId}: never;

GET /webinars/{webinarId}/registrants¶

GET /webinars/{webinarId}/registrants: never;

GET /webinars/{webinarId}/registrants/{registrantId}¶

GET /webinars/{webinarId}/registrants/{registrantId}: never;

GET /webinars/{webinarId}/registrants/questions¶

GET /webinars/{webinarId}/registrants/questions: never;

GET /webinars/{webinarId}/survey¶

GET /webinars/{webinarId}/survey: never;

GET /webinars/{webinarId}/token¶

GET /webinars/{webinarId}/token: never;

GET /webinars/{webinarId}/tracking_sources¶

GET /webinars/{webinarId}/tracking_sources: never;

PATCH /archive_files/{fileId}¶

PATCH /archive_files/{fileId}: {
  auto_delete: boolean;
};

auto_delete¶

auto_delete: boolean;

PATCH /devices/{deviceId}¶

PATCH /devices/{deviceId}: {
  device_name: string;
  device_type?: 0 | 1 | 3;
  room_id?: string;
  tag?: string;
};

device_name¶

device_name: string;

device_type?¶

optional device_type?: 0 | 1 | 3;

room_id?¶

optional room_id?: string;

tag?¶

optional tag?: string;

PATCH /devices/{deviceId}/assign_group¶

PATCH /devices/{deviceId}/assign_group: never;

PATCH /devices/{deviceId}/assignment¶

PATCH /devices/{deviceId}/assignment: {
  app_type?: "ZR" | "ZRC" | "ZRP" | "ZRW";
  room_id?: string;
};

app_type?¶

optional app_type?: "ZR" | "ZRC" | "ZRP" | "ZRW";

room_id?¶

optional room_id?: string;

PATCH /h323/devices/{deviceId}¶

PATCH /h323/devices/{deviceId}: {
  encryption: "auto" | "yes" | "no";
  ip: string;
  name: string;
  protocol: "H.323" | "SIP";
};

encryption¶

encryption: "auto" | "yes" | "no";

ip¶

ip: string;

name¶

name: string;

protocol¶

protocol: "H.323" | "SIP";

PATCH /live_meetings/{meetingId}/chat/messages/{messageId}¶

PATCH /live_meetings/{meetingId}/chat/messages/{messageId}: {
  message_content: string;
};

message_content¶

message_content: string;

PATCH /live_meetings/{meetingId}/events¶

PATCH /live_meetings/{meetingId}/events: {
  method?:   | "recording.start"
     | "recording.stop"
     | "recording.pause"
     | "recording.resume"
     | "participant.invite"
     | "participant.invite.callout"
     | "participant.invite.room_system_callout"
     | "waiting_room.update"
     | "ai_companion.start"
     | "ai_companion.stop"
     | "ai_companion.disable"
     | "participant.remove";
  params?: {
     ai_companion_mode?: "summary" | "all" | "questions";
     call_type?: string;
     contacts?: readonly {
        email?: string;
        id?: string;
     }[];
     delete_meeting_assets?: boolean;
     device_ip?: string;
     h323_headers?: {
        from_display_name?: string;
        to_display_name?: string;
     };
     invite_options?: {
        require_greeting?: boolean;
        require_pressing_one?: boolean;
     };
     invitee_name?: string;
     participant_uuid?: string;
     phone_number?: string;
     retain_meeting_transcript?: boolean;
     sip_headers?: {
        additional_headers?: readonly {
           key?: string;
           value?: string;
        }[];
        from_display_name?: string;
        from_uri?: string;
        to_display_name?: string;
     };
     waiting_room_description?: string;
     waiting_room_title?: string;
  };
};

method?¶

optional method?:
  | "recording.start"
  | "recording.stop"
  | "recording.pause"
  | "recording.resume"
  | "participant.invite"
  | "participant.invite.callout"
  | "participant.invite.room_system_callout"
  | "waiting_room.update"
  | "ai_companion.start"
  | "ai_companion.stop"
  | "ai_companion.disable"
  | "participant.remove";

params?¶

optional params?: {
  ai_companion_mode?: "summary" | "all" | "questions";
  call_type?: string;
  contacts?: readonly {
     email?: string;
     id?: string;
  }[];
  delete_meeting_assets?: boolean;
  device_ip?: string;
  h323_headers?: {
     from_display_name?: string;
     to_display_name?: string;
  };
  invite_options?: {
     require_greeting?: boolean;
     require_pressing_one?: boolean;
  };
  invitee_name?: string;
  participant_uuid?: string;
  phone_number?: string;
  retain_meeting_transcript?: boolean;
  sip_headers?: {
     additional_headers?: readonly {
        key?: string;
        value?: string;
     }[];
     from_display_name?: string;
     from_uri?: string;
     to_display_name?: string;
  };
  waiting_room_description?: string;
  waiting_room_title?: string;
};

params.ai_companion_mode?¶

optional ai_companion_mode?: "summary" | "all" | "questions";

params.call_type?¶

optional call_type?: string;

params.contacts?¶

optional contacts?: readonly {
  email?: string;
  id?: string;
}[];

params.delete_meeting_assets?¶

optional delete_meeting_assets?: boolean;

params.device_ip?¶

optional device_ip?: string;

params.h323_headers?¶

optional h323_headers?: {
  from_display_name?: string;
  to_display_name?: string;
};

params.h323_headers.from_display_name?¶

optional from_display_name?: string;

params.h323_headers.to_display_name?¶

optional to_display_name?: string;

params.invite_options?¶

optional invite_options?: {
  require_greeting?: boolean;
  require_pressing_one?: boolean;
};

params.invite_options.require_greeting?¶

optional require_greeting?: boolean;

params.invite_options.require_pressing_one?¶

optional require_pressing_one?: boolean;

params.invitee_name?¶

optional invitee_name?: string;

params.participant_uuid?¶

optional participant_uuid?: string;

params.phone_number?¶

optional phone_number?: string;

params.retain_meeting_transcript?¶

optional retain_meeting_transcript?: boolean;

params.sip_headers?¶

optional sip_headers?: {
  additional_headers?: readonly {
     key?: string;
     value?: string;
  }[];
  from_display_name?: string;
  from_uri?: string;
  to_display_name?: string;
};

params.sip_headers.additional_headers?¶

optional additional_headers?: readonly {
  key?: string;
  value?: string;
}[];

params.sip_headers.from_display_name?¶

optional from_display_name?: string;

params.sip_headers.from_uri?¶

optional from_uri?: string;

params.sip_headers.to_display_name?¶

optional to_display_name?: string;

params.waiting_room_description?¶

optional waiting_room_description?: string;

params.waiting_room_title?¶

optional waiting_room_title?: string;

PATCH /live_meetings/{meetingId}/rtms_app/status¶

PATCH /live_meetings/{meetingId}/rtms_app/status: {
  action?: "stop" | "start" | "pause" | "resume";
  settings?: {
     client_id: string;
     participant_user_id?: string;
  };
};

action?¶

optional action?: "stop" | "start" | "pause" | "resume";

settings?¶

optional settings?: {
  client_id: string;
  participant_user_id?: string;
};

settings.client_id¶

client_id: string;

settings.participant_user_id?¶

optional participant_user_id?: string;

PATCH /meetings/{meetingId}¶

PATCH /meetings/{meetingId}: {
  agenda?: string;
  duration?: number;
  password?: string;
  pre_schedule?: boolean;
  recurrence?: {
     end_date_time?: string;
     end_times?: number;
     monthly_day?: number;
     monthly_week?: -1 | 1 | 2 | 3 | 4;
     monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
     repeat_interval?: number;
     type: 1 | 2 | 3;
     weekly_days?: "2" | "1" | "3" | "4" | "5" | "6" | "7";
  };
  schedule_for?: string;
  settings?: {
     allow_host_control_participant_mute_state?: boolean;
     allow_multiple_devices?: boolean;
     alternative_host_manage_cloud_recording?: boolean;
     alternative_host_manage_meeting_summary?: boolean;
     alternative_host_update_polls?: boolean;
     alternative_hosts?: string;
     alternative_hosts_email_notification?: boolean;
     approval_type?: 0 | 1 | 2;
     approved_or_denied_countries_or_regions?: {
        approved_list?: readonly string[];
        denied_list?: readonly string[];
        enable?: boolean;
        method?: "approve" | "deny";
     };
     audio?: "both" | "telephony" | "voip" | "thirdParty";
     audio_conference_info?: string;
     authentication_domains?: string;
     authentication_exception?: readonly {
        email?: string;
        join_url?: string;
        name?: string;
     }[];
     authentication_name?: string;
     authentication_option?: string;
     auto_add_recording_to_video_management?: {
        channels?: readonly {
           channel_id: string;
           name?: string;
        }[];
        enable: boolean;
     };
     auto_recording?: "none" | "local" | "cloud";
     auto_start_ai_companion_questions?: boolean;
     auto_start_meeting_summary?: boolean;
     breakout_room?: {
        enable?: boolean;
        rooms?: readonly {
           name?: string;
           participants?: readonly string[];
        }[];
     };
     calendar_type?: 1 | 2;
     close_registration?: boolean;
     cn_meeting?: boolean;
     contact_email?: string;
     contact_name?: string;
     continuous_meeting_chat?: {
        auto_add_invited_external_users?: boolean;
        auto_add_meeting_participants?: boolean;
        enable?: boolean;
     };
     custom_keys?: readonly {
        key?: string;
        value?: string;
     }[];
     device_testing?: boolean;
     disable_participant_video?: boolean;
     email_in_attendee_report?: boolean;
     email_notification?: boolean;
     encryption_type?: "enhanced_encryption" | "e2ee";
     enforce_login?: boolean;
     enforce_login_domains?: string;
     focus_mode?: boolean;
     global_dial_in_countries?: readonly string[];
     global_dial_in_numbers?: readonly {
        city?: string;
        country?: string;
        country_name?: string;
        number?: string;
        type?: "toll" | "tollfree";
     }[];
     host_save_video_order?: boolean;
     host_video?: boolean;
     in_meeting?: boolean;
     internal_meeting?: boolean;
     jbh_time?: 0 | 5 | 10 | 15;
     join_before_host?: boolean;
     language_interpretation?: {
        enable?: boolean;
        interpreters?: readonly {
           email?: string;
           interpreter_languages?: string;
           languages?: string;
        }[];
     };
     meeting_authentication?: boolean;
     meeting_invitees?: readonly {
        email?: string;
     }[];
     mute_upon_entry?: boolean;
     participant_focused_meeting?: boolean;
     participant_video?: boolean;
     private_meeting?: boolean;
     push_change_to_calendar?: boolean;
     question_and_answer?: {
        allow_anonymous_questions?: boolean;
        allow_submit_questions?: boolean;
        attendees_can_comment?: boolean;
        attendees_can_upvote?: boolean;
        enable?: boolean;
        question_visibility?: "all" | "answered";
     };
     registrants_confirmation_email?: boolean;
     registrants_email_notification?: boolean;
     registration_type?: 1 | 2 | 3;
     request_permission_to_unmute_participants?: boolean;
     resources?: readonly {
        permission_level?: "editor" | "commenter" | "viewer";
        resource_id?: string;
        resource_type?: "whiteboard";
     }[];
     show_share_button?: boolean;
     sign_language_interpretation?: {
        enable?: boolean;
        interpreters?: readonly {
           email?: string;
           sign_language?: string;
        }[];
     };
     summary_template_id?: string;
     use_pmi?: boolean;
     waiting_room?: boolean;
     waiting_room_options?: {
        mode: "custom" | "follow_setting";
        who_goes_to_waiting_room?:   | "everyone"
           | "users_not_in_account"
           | "users_not_in_account_or_whitelisted_domains"
           | "users_not_on_invite"
           | "users_not_in_org";
     };
     watermark?: boolean;
     who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;
     who_will_receive_summary?: 1 | 2 | 3 | 4;
  };
  start_time?: string;
  template_id?: string;
  timezone?: string;
  topic?: string;
  tracking_fields?: readonly {
     field?: string;
     value?: string;
  }[];
  type?: 1 | 2 | 3 | 8 | 10;
};

agenda?¶

optional agenda?: string;

duration?¶

optional duration?: number;

password?¶

optional password?: string;

pre_schedule?¶

optional pre_schedule?: boolean;

recurrence?¶

optional recurrence?: {
  end_date_time?: string;
  end_times?: number;
  monthly_day?: number;
  monthly_week?: -1 | 1 | 2 | 3 | 4;
  monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
  repeat_interval?: number;
  type: 1 | 2 | 3;
  weekly_days?: "2" | "1" | "3" | "4" | "5" | "6" | "7";
};

recurrence.end_date_time?¶

optional end_date_time?: string;

recurrence.end_times?¶

optional end_times?: number;

recurrence.monthly_day?¶

optional monthly_day?: number;

recurrence.monthly_week?¶

optional monthly_week?: -1 | 1 | 2 | 3 | 4;

recurrence.monthly_week_day?¶

optional monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;

recurrence.repeat_interval?¶

optional repeat_interval?: number;

recurrence.type¶

type: 1 | 2 | 3;

recurrence.weekly_days?¶

optional weekly_days?: "2" | "1" | "3" | "4" | "5" | "6" | "7";

schedule_for?¶

optional schedule_for?: string;

settings?¶

optional settings?: {
  allow_host_control_participant_mute_state?: boolean;
  allow_multiple_devices?: boolean;
  alternative_host_manage_cloud_recording?: boolean;
  alternative_host_manage_meeting_summary?: boolean;
  alternative_host_update_polls?: boolean;
  alternative_hosts?: string;
  alternative_hosts_email_notification?: boolean;
  approval_type?: 0 | 1 | 2;
  approved_or_denied_countries_or_regions?: {
     approved_list?: readonly string[];
     denied_list?: readonly string[];
     enable?: boolean;
     method?: "approve" | "deny";
  };
  audio?: "both" | "telephony" | "voip" | "thirdParty";
  audio_conference_info?: string;
  authentication_domains?: string;
  authentication_exception?: readonly {
     email?: string;
     join_url?: string;
     name?: string;
  }[];
  authentication_name?: string;
  authentication_option?: string;
  auto_add_recording_to_video_management?: {
     channels?: readonly {
        channel_id: string;
        name?: string;
     }[];
     enable: boolean;
  };
  auto_recording?: "none" | "local" | "cloud";
  auto_start_ai_companion_questions?: boolean;
  auto_start_meeting_summary?: boolean;
  breakout_room?: {
     enable?: boolean;
     rooms?: readonly {
        name?: string;
        participants?: readonly string[];
     }[];
  };
  calendar_type?: 1 | 2;
  close_registration?: boolean;
  cn_meeting?: boolean;
  contact_email?: string;
  contact_name?: string;
  continuous_meeting_chat?: {
     auto_add_invited_external_users?: boolean;
     auto_add_meeting_participants?: boolean;
     enable?: boolean;
  };
  custom_keys?: readonly {
     key?: string;
     value?: string;
  }[];
  device_testing?: boolean;
  disable_participant_video?: boolean;
  email_in_attendee_report?: boolean;
  email_notification?: boolean;
  encryption_type?: "enhanced_encryption" | "e2ee";
  enforce_login?: boolean;
  enforce_login_domains?: string;
  focus_mode?: boolean;
  global_dial_in_countries?: readonly string[];
  global_dial_in_numbers?: readonly {
     city?: string;
     country?: string;
     country_name?: string;
     number?: string;
     type?: "toll" | "tollfree";
  }[];
  host_save_video_order?: boolean;
  host_video?: boolean;
  in_meeting?: boolean;
  internal_meeting?: boolean;
  jbh_time?: 0 | 5 | 10 | 15;
  join_before_host?: boolean;
  language_interpretation?: {
     enable?: boolean;
     interpreters?: readonly {
        email?: string;
        interpreter_languages?: string;
        languages?: string;
     }[];
  };
  meeting_authentication?: boolean;
  meeting_invitees?: readonly {
     email?: string;
  }[];
  mute_upon_entry?: boolean;
  participant_focused_meeting?: boolean;
  participant_video?: boolean;
  private_meeting?: boolean;
  push_change_to_calendar?: boolean;
  question_and_answer?: {
     allow_anonymous_questions?: boolean;
     allow_submit_questions?: boolean;
     attendees_can_comment?: boolean;
     attendees_can_upvote?: boolean;
     enable?: boolean;
     question_visibility?: "all" | "answered";
  };
  registrants_confirmation_email?: boolean;
  registrants_email_notification?: boolean;
  registration_type?: 1 | 2 | 3;
  request_permission_to_unmute_participants?: boolean;
  resources?: readonly {
     permission_level?: "editor" | "commenter" | "viewer";
     resource_id?: string;
     resource_type?: "whiteboard";
  }[];
  show_share_button?: boolean;
  sign_language_interpretation?: {
     enable?: boolean;
     interpreters?: readonly {
        email?: string;
        sign_language?: string;
     }[];
  };
  summary_template_id?: string;
  use_pmi?: boolean;
  waiting_room?: boolean;
  waiting_room_options?: {
     mode: "custom" | "follow_setting";
     who_goes_to_waiting_room?:   | "everyone"
        | "users_not_in_account"
        | "users_not_in_account_or_whitelisted_domains"
        | "users_not_on_invite"
        | "users_not_in_org";
  };
  watermark?: boolean;
  who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;
  who_will_receive_summary?: 1 | 2 | 3 | 4;
};

settings.allow_host_control_participant_mute_state?¶

optional allow_host_control_participant_mute_state?: boolean;

settings.allow_multiple_devices?¶

optional allow_multiple_devices?: boolean;

settings.alternative_host_manage_cloud_recording?¶

optional alternative_host_manage_cloud_recording?: boolean;

settings.alternative_host_manage_meeting_summary?¶

optional alternative_host_manage_meeting_summary?: boolean;

settings.alternative_host_update_polls?¶

optional alternative_host_update_polls?: boolean;

settings.alternative_hosts?¶

optional alternative_hosts?: string;

settings.alternative_hosts_email_notification?¶

optional alternative_hosts_email_notification?: boolean;

settings.approval_type?¶

optional approval_type?: 0 | 1 | 2;

settings.approved_or_denied_countries_or_regions?¶

optional approved_or_denied_countries_or_regions?: {
  approved_list?: readonly string[];
  denied_list?: readonly string[];
  enable?: boolean;
  method?: "approve" | "deny";
};

settings.approved_or_denied_countries_or_regions.approved_list?¶

optional approved_list?: readonly string[];

settings.approved_or_denied_countries_or_regions.denied_list?¶

optional denied_list?: readonly string[];

settings.approved_or_denied_countries_or_regions.enable?¶

optional enable?: boolean;

settings.approved_or_denied_countries_or_regions.method?¶

optional method?: "approve" | "deny";

settings.audio?¶

optional audio?: "both" | "telephony" | "voip" | "thirdParty";

settings.audio_conference_info?¶

optional audio_conference_info?: string;

settings.authentication_domains?¶

optional authentication_domains?: string;

settings.authentication_exception?¶

optional authentication_exception?: readonly {
  email?: string;
  join_url?: string;
  name?: string;
}[];

settings.authentication_name?¶

optional authentication_name?: string;

settings.authentication_option?¶

optional authentication_option?: string;

settings.auto_add_recording_to_video_management?¶

optional auto_add_recording_to_video_management?: {
  channels?: readonly {
     channel_id: string;
     name?: string;
  }[];
  enable: boolean;
};

settings.auto_add_recording_to_video_management.channels?¶

optional channels?: readonly {
  channel_id: string;
  name?: string;
}[];

settings.auto_add_recording_to_video_management.enable¶

enable: boolean;

settings.auto_recording?¶

optional auto_recording?: "none" | "local" | "cloud";

settings.auto_start_ai_companion_questions?¶

optional auto_start_ai_companion_questions?: boolean;

settings.auto_start_meeting_summary?¶

optional auto_start_meeting_summary?: boolean;

settings.breakout_room?¶

optional breakout_room?: {
  enable?: boolean;
  rooms?: readonly {
     name?: string;
     participants?: readonly string[];
  }[];
};

settings.breakout_room.enable?¶

optional enable?: boolean;

settings.breakout_room.rooms?¶

optional rooms?: readonly {
  name?: string;
  participants?: readonly string[];
}[];

settings.calendar_type?¶

optional calendar_type?: 1 | 2;

settings.close_registration?¶

optional close_registration?: boolean;

settings.cn_meeting?¶

optional cn_meeting?: boolean;

settings.contact_email?¶

optional contact_email?: string;

settings.contact_name?¶

optional contact_name?: string;

settings.continuous_meeting_chat?¶

optional continuous_meeting_chat?: {
  auto_add_invited_external_users?: boolean;
  auto_add_meeting_participants?: boolean;
  enable?: boolean;
};

settings.continuous_meeting_chat.auto_add_invited_external_users?¶

optional auto_add_invited_external_users?: boolean;

settings.continuous_meeting_chat.auto_add_meeting_participants?¶

optional auto_add_meeting_participants?: boolean;

settings.continuous_meeting_chat.enable?¶

optional enable?: boolean;

settings.custom_keys?¶

optional custom_keys?: readonly {
  key?: string;
  value?: string;
}[];

settings.device_testing?¶

optional device_testing?: boolean;

settings.disable_participant_video?¶

optional disable_participant_video?: boolean;

settings.email_in_attendee_report?¶

optional email_in_attendee_report?: boolean;

settings.email_notification?¶

optional email_notification?: boolean;

settings.encryption_type?¶

optional encryption_type?: "enhanced_encryption" | "e2ee";

settings.enforce_login?¶

optional enforce_login?: boolean;

settings.enforce_login_domains?¶

optional enforce_login_domains?: string;

settings.focus_mode?¶

optional focus_mode?: boolean;

settings.global_dial_in_countries?¶

optional global_dial_in_countries?: readonly string[];

settings.global_dial_in_numbers?¶

optional global_dial_in_numbers?: readonly {
  city?: string;
  country?: string;
  country_name?: string;
  number?: string;
  type?: "toll" | "tollfree";
}[];

settings.host_save_video_order?¶

optional host_save_video_order?: boolean;

settings.host_video?¶

optional host_video?: boolean;

settings.in_meeting?¶

optional in_meeting?: boolean;

settings.internal_meeting?¶

optional internal_meeting?: boolean;

settings.jbh_time?¶

optional jbh_time?: 0 | 5 | 10 | 15;

settings.join_before_host?¶

optional join_before_host?: boolean;

settings.language_interpretation?¶

optional language_interpretation?: {
  enable?: boolean;
  interpreters?: readonly {
     email?: string;
     interpreter_languages?: string;
     languages?: string;
  }[];
};

settings.language_interpretation.enable?¶

optional enable?: boolean;

settings.language_interpretation.interpreters?¶

optional interpreters?: readonly {
  email?: string;
  interpreter_languages?: string;
  languages?: string;
}[];

settings.meeting_authentication?¶

optional meeting_authentication?: boolean;

settings.meeting_invitees?¶

optional meeting_invitees?: readonly {
  email?: string;
}[];

settings.mute_upon_entry?¶

optional mute_upon_entry?: boolean;

settings.participant_focused_meeting?¶

optional participant_focused_meeting?: boolean;

settings.participant_video?¶

optional participant_video?: boolean;

settings.private_meeting?¶

optional private_meeting?: boolean;

settings.push_change_to_calendar?¶

optional push_change_to_calendar?: boolean;

settings.question_and_answer?¶

optional question_and_answer?: {
  allow_anonymous_questions?: boolean;
  allow_submit_questions?: boolean;
  attendees_can_comment?: boolean;
  attendees_can_upvote?: boolean;
  enable?: boolean;
  question_visibility?: "all" | "answered";
};

settings.question_and_answer.allow_anonymous_questions?¶

optional allow_anonymous_questions?: boolean;

settings.question_and_answer.allow_submit_questions?¶

optional allow_submit_questions?: boolean;

settings.question_and_answer.attendees_can_comment?¶

optional attendees_can_comment?: boolean;

settings.question_and_answer.attendees_can_upvote?¶

optional attendees_can_upvote?: boolean;

settings.question_and_answer.enable?¶

optional enable?: boolean;

settings.question_and_answer.question_visibility?¶

optional question_visibility?: "all" | "answered";

settings.registrants_confirmation_email?¶

optional registrants_confirmation_email?: boolean;

settings.registrants_email_notification?¶

optional registrants_email_notification?: boolean;

settings.registration_type?¶

optional registration_type?: 1 | 2 | 3;

settings.request_permission_to_unmute_participants?¶

optional request_permission_to_unmute_participants?: boolean;

settings.resources?¶

optional resources?: readonly {
  permission_level?: "editor" | "commenter" | "viewer";
  resource_id?: string;
  resource_type?: "whiteboard";
}[];

settings.show_share_button?¶

optional show_share_button?: boolean;

settings.sign_language_interpretation?¶

optional sign_language_interpretation?: {
  enable?: boolean;
  interpreters?: readonly {
     email?: string;
     sign_language?: string;
  }[];
};

settings.sign_language_interpretation.enable?¶

optional enable?: boolean;

settings.sign_language_interpretation.interpreters?¶

optional interpreters?: readonly {
  email?: string;
  sign_language?: string;
}[];

settings.summary_template_id?¶

optional summary_template_id?: string;

settings.use_pmi?¶

optional use_pmi?: boolean;

settings.waiting_room?¶

optional waiting_room?: boolean;

settings.waiting_room_options?¶

optional waiting_room_options?: {
  mode: "custom" | "follow_setting";
  who_goes_to_waiting_room?:   | "everyone"
     | "users_not_in_account"
     | "users_not_in_account_or_whitelisted_domains"
     | "users_not_on_invite"
     | "users_not_in_org";
};

settings.waiting_room_options.mode¶

mode: "custom" | "follow_setting";

settings.waiting_room_options.who_goes_to_waiting_room?¶

optional who_goes_to_waiting_room?:
  | "everyone"
  | "users_not_in_account"
  | "users_not_in_account_or_whitelisted_domains"
  | "users_not_on_invite"
  | "users_not_in_org";

settings.watermark?¶

optional watermark?: boolean;

settings.who_can_ask_questions?¶

optional who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;

settings.who_will_receive_summary?¶

optional who_will_receive_summary?: 1 | 2 | 3 | 4;

start_time?¶

optional start_time?: string;

template_id?¶

optional template_id?: string;

timezone?¶

optional timezone?: string;

topic?¶

optional topic?: string;

tracking_fields?¶

optional tracking_fields?: readonly {
  field?: string;
  value?: string;
}[];

type?¶

optional type?: 1 | 2 | 3 | 8 | 10;

PATCH /meetings/{meetingId}/livestream¶

PATCH /meetings/{meetingId}/livestream: {
  page_url: string;
  resolution?: string;
  stream_key: string;
  stream_url: string;
};

page_url¶

page_url: string;

resolution?¶

optional resolution?: string;

stream_key¶

stream_key: string;

stream_url¶

stream_url: string;

PATCH /meetings/{meetingId}/livestream/status¶

PATCH /meetings/{meetingId}/livestream/status: {
  action?: "mode" | "stop" | "start";
  settings?: {
     active_speaker_name?: boolean;
     close_caption?: "off" | "burnt-in" | "embedded";
     display_name?: string;
     layout?: "gallery_view" | "follow_host" | "speaker_view";
  };
};

action?¶

optional action?: "mode" | "stop" | "start";

settings?¶

optional settings?: {
  active_speaker_name?: boolean;
  close_caption?: "off" | "burnt-in" | "embedded";
  display_name?: string;
  layout?: "gallery_view" | "follow_host" | "speaker_view";
};

settings.active_speaker_name?¶

optional active_speaker_name?: boolean;

settings.close_caption?¶

optional close_caption?: "off" | "burnt-in" | "embedded";

settings.display_name?¶

optional display_name?: string;

settings.layout?¶

optional layout?: "gallery_view" | "follow_host" | "speaker_view";

PATCH /meetings/{meetingId}/recordings/registrants/questions¶

PATCH /meetings/{meetingId}/recordings/registrants/questions: {
  custom_questions?: readonly {
     answers?: readonly string[];
     required?: boolean;
     title?: string;
     type?: "short" | "single" | "multiple";
  }[];
  questions?: readonly {
     field_name?:   | "state"
        | "phone"
        | "last_name"
        | "address"
        | "city"
        | "country"
        | "zip"
        | "industry"
        | "org"
        | "job_title"
        | "purchasing_time_frame"
        | "role_in_purchase_process"
        | "no_of_employees"
        | "comments";
     required?: boolean;
  }[];
};

custom_questions?¶

optional custom_questions?: readonly {
  answers?: readonly string[];
  required?: boolean;
  title?: string;
  type?: "short" | "single" | "multiple";
}[];

questions?¶

optional questions?: readonly {
  field_name?:   | "state"
     | "phone"
     | "last_name"
     | "address"
     | "city"
     | "country"
     | "zip"
     | "industry"
     | "org"
     | "job_title"
     | "purchasing_time_frame"
     | "role_in_purchase_process"
     | "no_of_employees"
     | "comments";
  required?: boolean;
}[];

PATCH /meetings/{meetingId}/recordings/settings¶

PATCH /meetings/{meetingId}/recordings/settings: {
  approval_type?: 0 | 1 | 2;
  authentication_domains?: string;
  authentication_option?: string;
  auto_delete?: boolean;
  on_demand?: boolean;
  password?: string;
  recording_authentication?: boolean;
  send_email_to_host?: boolean;
  share_recording?: "none" | "publicly" | "internally";
  show_social_share_buttons?: boolean;
  topic?: string;
  viewer_download?: boolean;
};

approval_type?¶

optional approval_type?: 0 | 1 | 2;

authentication_domains?¶

optional authentication_domains?: string;

authentication_option?¶

optional authentication_option?: string;

auto_delete?¶

optional auto_delete?: boolean;

on_demand?¶

optional on_demand?: boolean;

password?¶

optional password?: string;

recording_authentication?¶

optional recording_authentication?: boolean;

send_email_to_host?¶

optional send_email_to_host?: boolean;

share_recording?¶

optional share_recording?: "none" | "publicly" | "internally";

show_social_share_buttons?¶

optional show_social_share_buttons?: boolean;

topic?¶

optional topic?: string;

viewer_download?¶

optional viewer_download?: boolean;

PATCH /meetings/{meetingId}/registrants/questions¶

PATCH /meetings/{meetingId}/registrants/questions: {
  custom_questions?: readonly {
     answers?: readonly string[];
     required?: boolean;
     title?: string;
     type?: "short" | "single";
  }[];
  questions?: readonly {
     field_name?:   | "state"
        | "phone"
        | "last_name"
        | "address"
        | "city"
        | "country"
        | "zip"
        | "industry"
        | "org"
        | "job_title"
        | "purchasing_time_frame"
        | "role_in_purchase_process"
        | "no_of_employees"
        | "comments";
     required?: boolean;
  }[];
};

custom_questions?¶

optional custom_questions?: readonly {
  answers?: readonly string[];
  required?: boolean;
  title?: string;
  type?: "short" | "single";
}[];

questions?¶

optional questions?: readonly {
  field_name?:   | "state"
     | "phone"
     | "last_name"
     | "address"
     | "city"
     | "country"
     | "zip"
     | "industry"
     | "org"
     | "job_title"
     | "purchasing_time_frame"
     | "role_in_purchase_process"
     | "no_of_employees"
     | "comments";
  required?: boolean;
}[];

PATCH /meetings/{meetingId}/survey¶

PATCH /meetings/{meetingId}/survey: {
  custom_survey?: {
     anonymous?: boolean;
     feedback?: string;
     numbered_questions?: boolean;
     questions?: readonly {
        answer_max_character?: number;
        answer_min_character?: number;
        answer_required?: boolean;
        answers?: readonly string[];
        name?: string;
        prompts?: readonly {
           prompt_question?: string;
        }[];
        rating_max_label?: string;
        rating_max_value?: number;
        rating_min_label?: string;
        rating_min_value?: number;
        show_as_dropdown?: boolean;
        type?:   | "single"
           | "multiple"
           | "matching"
           | "rank_order"
           | "short_answer"
           | "long_answer"
           | "fill_in_the_blank"
           | "rating_scale";
     }[];
     show_question_type?: boolean;
     title?: string;
  };
  show_in_the_browser?: boolean;
  third_party_survey?: string;
};

custom_survey?¶

optional custom_survey?: {
  anonymous?: boolean;
  feedback?: string;
  numbered_questions?: boolean;
  questions?: readonly {
     answer_max_character?: number;
     answer_min_character?: number;
     answer_required?: boolean;
     answers?: readonly string[];
     name?: string;
     prompts?: readonly {
        prompt_question?: string;
     }[];
     rating_max_label?: string;
     rating_max_value?: number;
     rating_min_label?: string;
     rating_min_value?: number;
     show_as_dropdown?: boolean;
     type?:   | "single"
        | "multiple"
        | "matching"
        | "rank_order"
        | "short_answer"
        | "long_answer"
        | "fill_in_the_blank"
        | "rating_scale";
  }[];
  show_question_type?: boolean;
  title?: string;
};

custom_survey.anonymous?¶

optional anonymous?: boolean;

custom_survey.feedback?¶

optional feedback?: string;

custom_survey.numbered_questions?¶

optional numbered_questions?: boolean;

custom_survey.questions?¶

optional questions?: readonly {
  answer_max_character?: number;
  answer_min_character?: number;
  answer_required?: boolean;
  answers?: readonly string[];
  name?: string;
  prompts?: readonly {
     prompt_question?: string;
  }[];
  rating_max_label?: string;
  rating_max_value?: number;
  rating_min_label?: string;
  rating_min_value?: number;
  show_as_dropdown?: boolean;
  type?:   | "single"
     | "multiple"
     | "matching"
     | "rank_order"
     | "short_answer"
     | "long_answer"
     | "fill_in_the_blank"
     | "rating_scale";
}[];

custom_survey.show_question_type?¶

optional show_question_type?: boolean;

custom_survey.title?¶

optional title?: string;

show_in_the_browser?¶

optional show_in_the_browser?: boolean;

third_party_survey?¶

optional third_party_survey?: string;

PATCH /sip_phones/phones/{phoneId}¶

PATCH /sip_phones/phones/{phoneId}: {
  authorization_name?: string;
  display_number?: string;
  domain?: string;
  password?: string;
  registration_expire_time?: number;
  server?: {
     proxy_server?: string;
     register_server?: string;
     transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
  };
  server_2?: {
     proxy_server?: string;
     register_server?: string;
     transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
  };
  server_3?: {
     proxy_server?: string;
     register_server?: string;
     transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
  };
  user_name?: string;
  voice_mail?: string;
};

authorization_name?¶

optional authorization_name?: string;

display_number?¶

optional display_number?: string;

domain?¶

optional domain?: string;

password?¶

optional password?: string;

registration_expire_time?¶

optional registration_expire_time?: number;

server?¶

optional server?: {
  proxy_server?: string;
  register_server?: string;
  transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
};

server.proxy_server?¶

optional proxy_server?: string;

server.register_server?¶

optional register_server?: string;

server.transport_protocol?¶

optional transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";

server_2?¶

optional server_2?: {
  proxy_server?: string;
  register_server?: string;
  transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
};

server_2.proxy_server?¶

optional proxy_server?: string;

server_2.register_server?¶

optional register_server?: string;

server_2.transport_protocol?¶

optional transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";

server_3?¶

optional server_3?: {
  proxy_server?: string;
  register_server?: string;
  transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
};

server_3.proxy_server?¶

optional proxy_server?: string;

server_3.register_server?¶

optional register_server?: string;

server_3.transport_protocol?¶

optional transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";

user_name?¶

optional user_name?: string;

voice_mail?¶

optional voice_mail?: string;

PATCH /tracking_fields/{fieldId}¶

PATCH /tracking_fields/{fieldId}: {
  field?: string;
  recommended_values?: readonly string[];
  required?: boolean;
  visible?: boolean;
};

field?¶

optional field?: string;

recommended_values?¶

optional recommended_values?: readonly string[];

required?¶

optional required?: boolean;

visible?¶

optional visible?: boolean;

PATCH /tsp¶

PATCH /tsp: {
  dial_in_number_unrestricted?: boolean;
  enable?: boolean;
  master_account_setting_extended?: boolean;
  modify_credential_forbidden?: boolean;
  tsp_bridge?: "US_TSP_TB" | "EU_TSP_TB";
  tsp_enabled?: boolean;
  tsp_provider?: string;
};

dial_in_number_unrestricted?¶

optional dial_in_number_unrestricted?: boolean;

enable?¶

optional enable?: boolean;

master_account_setting_extended?¶

optional master_account_setting_extended?: boolean;

modify_credential_forbidden?¶

optional modify_credential_forbidden?: boolean;

tsp_bridge?¶

optional tsp_bridge?: "US_TSP_TB" | "EU_TSP_TB";

tsp_enabled?¶

optional tsp_enabled?: boolean;

tsp_provider?¶

optional tsp_provider?: string;

PATCH /users/{userId}/tsp/{tspId}¶

PATCH /users/{userId}/tsp/{tspId}: {
  conference_code: string;
  dial_in_numbers?: readonly {
     code?: string;
     country_label?: string;
     number?: string;
     type?: "toll" | "tollfree" | "media_link";
  }[];
  leader_pin: string;
  tsp_bridge?: "US_TSP_TB" | "EU_TSP_TB";
};

conference_code¶

conference_code: string;

dial_in_numbers?¶

optional dial_in_numbers?: readonly {
  code?: string;
  country_label?: string;
  number?: string;
  type?: "toll" | "tollfree" | "media_link";
}[];

leader_pin¶

leader_pin: string;

tsp_bridge?¶

optional tsp_bridge?: "US_TSP_TB" | "EU_TSP_TB";

PATCH /users/{userId}/tsp/settings¶

PATCH /users/{userId}/tsp/settings: {
  audio_url?: string;
};

audio_url?¶

optional audio_url?: string;

PATCH /webinars/{webinarId}¶

PATCH /webinars/{webinarId}: {
  agenda?: string;
  duration?: number;
  is_simulive?: boolean;
  password?: string;
  record_file_id?: string;
  recurrence?: {
     end_date_time?: string;
     end_times?: number;
     monthly_day?: number;
     monthly_week?: -1 | 1 | 2 | 3 | 4;
     monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
     repeat_interval?: number;
     type: 1 | 2 | 3;
     weekly_days?: "2" | "1" | "3" | "4" | "5" | "6" | "7";
  };
  schedule_for?: string;
  settings?: {
     add_audio_watermark?: boolean;
     add_watermark?: boolean;
     additional_data_center_regions?: readonly string[];
     allow_host_control_participant_mute_state?: boolean;
     allow_multiple_devices?: boolean;
     alternative_host_update_polls?: boolean;
     alternative_hosts?: string;
     approval_type?: 0 | 1 | 2;
     attendees_and_panelists_reminder_email_notification?: {
        enable?: boolean;
        type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
     };
     audio?: "both" | "telephony" | "voip" | "thirdParty";
     audio_conference_info?: string;
     authentication_domains?: string;
     authentication_option?: string;
     auto_recording?: "none" | "local" | "cloud";
     close_registration?: boolean;
     contact_email?: string;
     contact_name?: string;
     email_in_attendee_report?: boolean;
     email_language?: string;
     enable_session_branding?: boolean;
     enforce_login?: boolean;
     enforce_login_domains?: string;
     follow_up_absentees_email_notification?: {
        enable?: boolean;
        type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
     };
     follow_up_attendees_email_notification?: {
        enable?: boolean;
        type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
     };
     global_dial_in_countries?: readonly string[];
     hd_video?: boolean;
     hd_video_for_attendees?: boolean;
     host_video?: boolean;
     language_interpretation?: {
        enable?: boolean;
        interpreters?: readonly {
           email?: string;
           interpreter_languages?: string;
           languages?: string;
        }[];
     };
     meeting_authentication?: boolean;
     notify_registrants?: boolean;
     on_demand?: boolean;
     panelist_authentication?: boolean;
     panelists_invitation_email_notification?: boolean;
     panelists_video?: boolean;
     post_webinar_survey?: boolean;
     practice_session?: boolean;
     question_and_answer?: {
        allow_anonymous_questions?: boolean;
        allow_auto_reply?: boolean;
        allow_submit_questions?: boolean;
        answer_questions?: "all" | "only";
        attendees_can_comment?: boolean;
        attendees_can_upvote?: boolean;
        auto_reply_text?: string;
        enable?: boolean;
     };
     registrants_confirmation_email?: boolean;
     registrants_email_notification?: boolean;
     registrants_restrict_number?: number;
     registration_type?: 1 | 2 | 3;
     request_permission_to_unmute_participants?: boolean;
     send_1080p_video_to_attendees?: boolean;
     show_join_info?: boolean;
     show_share_button?: boolean;
     sign_language_interpretation?: {
        enable?: boolean;
        interpreters?: readonly {
           email?: string;
           sign_language?: string;
        }[];
     };
     survey_url?: string;
  };
  simulive_delay_start?: {
     enable?: boolean;
     time?: number;
     timeunit?: "second" | "minute";
  };
  start_time?: string;
  timezone?: string;
  topic?: string;
  tracking_fields?: readonly {
     field?: string;
     value?: string;
  }[];
  transition_to_live?: boolean;
  type?: 5 | 6 | 9;
};

agenda?¶

optional agenda?: string;

duration?¶

optional duration?: number;

is_simulive?¶

optional is_simulive?: boolean;

password?¶

optional password?: string;

record_file_id?¶

optional record_file_id?: string;

recurrence?¶

optional recurrence?: {
  end_date_time?: string;
  end_times?: number;
  monthly_day?: number;
  monthly_week?: -1 | 1 | 2 | 3 | 4;
  monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
  repeat_interval?: number;
  type: 1 | 2 | 3;
  weekly_days?: "2" | "1" | "3" | "4" | "5" | "6" | "7";
};

recurrence.end_date_time?¶

optional end_date_time?: string;

recurrence.end_times?¶

optional end_times?: number;

recurrence.monthly_day?¶

optional monthly_day?: number;

recurrence.monthly_week?¶

optional monthly_week?: -1 | 1 | 2 | 3 | 4;

recurrence.monthly_week_day?¶

optional monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;

recurrence.repeat_interval?¶

optional repeat_interval?: number;

recurrence.type¶

type: 1 | 2 | 3;

recurrence.weekly_days?¶

optional weekly_days?: "2" | "1" | "3" | "4" | "5" | "6" | "7";

schedule_for?¶

optional schedule_for?: string;

settings?¶

optional settings?: {
  add_audio_watermark?: boolean;
  add_watermark?: boolean;
  additional_data_center_regions?: readonly string[];
  allow_host_control_participant_mute_state?: boolean;
  allow_multiple_devices?: boolean;
  alternative_host_update_polls?: boolean;
  alternative_hosts?: string;
  approval_type?: 0 | 1 | 2;
  attendees_and_panelists_reminder_email_notification?: {
     enable?: boolean;
     type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
  };
  audio?: "both" | "telephony" | "voip" | "thirdParty";
  audio_conference_info?: string;
  authentication_domains?: string;
  authentication_option?: string;
  auto_recording?: "none" | "local" | "cloud";
  close_registration?: boolean;
  contact_email?: string;
  contact_name?: string;
  email_in_attendee_report?: boolean;
  email_language?: string;
  enable_session_branding?: boolean;
  enforce_login?: boolean;
  enforce_login_domains?: string;
  follow_up_absentees_email_notification?: {
     enable?: boolean;
     type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
  };
  follow_up_attendees_email_notification?: {
     enable?: boolean;
     type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
  };
  global_dial_in_countries?: readonly string[];
  hd_video?: boolean;
  hd_video_for_attendees?: boolean;
  host_video?: boolean;
  language_interpretation?: {
     enable?: boolean;
     interpreters?: readonly {
        email?: string;
        interpreter_languages?: string;
        languages?: string;
     }[];
  };
  meeting_authentication?: boolean;
  notify_registrants?: boolean;
  on_demand?: boolean;
  panelist_authentication?: boolean;
  panelists_invitation_email_notification?: boolean;
  panelists_video?: boolean;
  post_webinar_survey?: boolean;
  practice_session?: boolean;
  question_and_answer?: {
     allow_anonymous_questions?: boolean;
     allow_auto_reply?: boolean;
     allow_submit_questions?: boolean;
     answer_questions?: "all" | "only";
     attendees_can_comment?: boolean;
     attendees_can_upvote?: boolean;
     auto_reply_text?: string;
     enable?: boolean;
  };
  registrants_confirmation_email?: boolean;
  registrants_email_notification?: boolean;
  registrants_restrict_number?: number;
  registration_type?: 1 | 2 | 3;
  request_permission_to_unmute_participants?: boolean;
  send_1080p_video_to_attendees?: boolean;
  show_join_info?: boolean;
  show_share_button?: boolean;
  sign_language_interpretation?: {
     enable?: boolean;
     interpreters?: readonly {
        email?: string;
        sign_language?: string;
     }[];
  };
  survey_url?: string;
};

settings.add_audio_watermark?¶

optional add_audio_watermark?: boolean;

settings.add_watermark?¶

optional add_watermark?: boolean;

settings.additional_data_center_regions?¶

optional additional_data_center_regions?: readonly string[];

settings.allow_host_control_participant_mute_state?¶

optional allow_host_control_participant_mute_state?: boolean;

settings.allow_multiple_devices?¶

optional allow_multiple_devices?: boolean;

settings.alternative_host_update_polls?¶

optional alternative_host_update_polls?: boolean;

settings.alternative_hosts?¶

optional alternative_hosts?: string;

settings.approval_type?¶

optional approval_type?: 0 | 1 | 2;

settings.attendees_and_panelists_reminder_email_notification?¶

optional attendees_and_panelists_reminder_email_notification?: {
  enable?: boolean;
  type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
};

settings.attendees_and_panelists_reminder_email_notification.enable?¶

optional enable?: boolean;

settings.attendees_and_panelists_reminder_email_notification.type?¶

optional type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;

settings.audio?¶

optional audio?: "both" | "telephony" | "voip" | "thirdParty";

settings.audio_conference_info?¶

optional audio_conference_info?: string;

settings.authentication_domains?¶

optional authentication_domains?: string;

settings.authentication_option?¶

optional authentication_option?: string;

settings.auto_recording?¶

optional auto_recording?: "none" | "local" | "cloud";

settings.close_registration?¶

optional close_registration?: boolean;

settings.contact_email?¶

optional contact_email?: string;

settings.contact_name?¶

optional contact_name?: string;

settings.email_in_attendee_report?¶

optional email_in_attendee_report?: boolean;

settings.email_language?¶

optional email_language?: string;

settings.enable_session_branding?¶

optional enable_session_branding?: boolean;

settings.enforce_login?¶

optional enforce_login?: boolean;

settings.enforce_login_domains?¶

optional enforce_login_domains?: string;

settings.follow_up_absentees_email_notification?¶

optional follow_up_absentees_email_notification?: {
  enable?: boolean;
  type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
};

settings.follow_up_absentees_email_notification.enable?¶

optional enable?: boolean;

settings.follow_up_absentees_email_notification.type?¶

optional type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;

settings.follow_up_attendees_email_notification?¶

optional follow_up_attendees_email_notification?: {
  enable?: boolean;
  type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
};

settings.follow_up_attendees_email_notification.enable?¶

optional enable?: boolean;

settings.follow_up_attendees_email_notification.type?¶

optional type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;

settings.global_dial_in_countries?¶

optional global_dial_in_countries?: readonly string[];

settings.hd_video?¶

optional hd_video?: boolean;

settings.hd_video_for_attendees?¶

optional hd_video_for_attendees?: boolean;

settings.host_video?¶

optional host_video?: boolean;

settings.language_interpretation?¶

optional language_interpretation?: {
  enable?: boolean;
  interpreters?: readonly {
     email?: string;
     interpreter_languages?: string;
     languages?: string;
  }[];
};

settings.language_interpretation.enable?¶

optional enable?: boolean;

settings.language_interpretation.interpreters?¶

optional interpreters?: readonly {
  email?: string;
  interpreter_languages?: string;
  languages?: string;
}[];

settings.meeting_authentication?¶

optional meeting_authentication?: boolean;

settings.notify_registrants?¶

optional notify_registrants?: boolean;

settings.on_demand?¶

optional on_demand?: boolean;

settings.panelist_authentication?¶

optional panelist_authentication?: boolean;

settings.panelists_invitation_email_notification?¶

optional panelists_invitation_email_notification?: boolean;

settings.panelists_video?¶

optional panelists_video?: boolean;

settings.post_webinar_survey?¶

optional post_webinar_survey?: boolean;

settings.practice_session?¶

optional practice_session?: boolean;

settings.question_and_answer?¶

optional question_and_answer?: {
  allow_anonymous_questions?: boolean;
  allow_auto_reply?: boolean;
  allow_submit_questions?: boolean;
  answer_questions?: "all" | "only";
  attendees_can_comment?: boolean;
  attendees_can_upvote?: boolean;
  auto_reply_text?: string;
  enable?: boolean;
};

settings.question_and_answer.allow_anonymous_questions?¶

optional allow_anonymous_questions?: boolean;

settings.question_and_answer.allow_auto_reply?¶

optional allow_auto_reply?: boolean;

settings.question_and_answer.allow_submit_questions?¶

optional allow_submit_questions?: boolean;

settings.question_and_answer.answer_questions?¶

optional answer_questions?: "all" | "only";

settings.question_and_answer.attendees_can_comment?¶

optional attendees_can_comment?: boolean;

settings.question_and_answer.attendees_can_upvote?¶

optional attendees_can_upvote?: boolean;

settings.question_and_answer.auto_reply_text?¶

optional auto_reply_text?: string;

settings.question_and_answer.enable?¶

optional enable?: boolean;

settings.registrants_confirmation_email?¶

optional registrants_confirmation_email?: boolean;

settings.registrants_email_notification?¶

optional registrants_email_notification?: boolean;

settings.registrants_restrict_number?¶

optional registrants_restrict_number?: number;

settings.registration_type?¶

optional registration_type?: 1 | 2 | 3;

settings.request_permission_to_unmute_participants?¶

optional request_permission_to_unmute_participants?: boolean;

settings.send_1080p_video_to_attendees?¶

optional send_1080p_video_to_attendees?: boolean;

settings.show_join_info?¶

optional show_join_info?: boolean;

settings.show_share_button?¶

optional show_share_button?: boolean;

settings.sign_language_interpretation?¶

optional sign_language_interpretation?: {
  enable?: boolean;
  interpreters?: readonly {
     email?: string;
     sign_language?: string;
  }[];
};

settings.sign_language_interpretation.enable?¶

optional enable?: boolean;

settings.sign_language_interpretation.interpreters?¶

optional interpreters?: readonly {
  email?: string;
  sign_language?: string;
}[];

settings.survey_url?¶

optional survey_url?: string;

simulive_delay_start?¶

optional simulive_delay_start?: {
  enable?: boolean;
  time?: number;
  timeunit?: "second" | "minute";
};

simulive_delay_start.enable?¶

optional enable?: boolean;

simulive_delay_start.time?¶

optional time?: number;

simulive_delay_start.timeunit?¶

optional timeunit?: "second" | "minute";

start_time?¶

optional start_time?: string;

timezone?¶

optional timezone?: string;

topic?¶

optional topic?: string;

tracking_fields?¶

optional tracking_fields?: readonly {
  field?: string;
  value?: string;
}[];

transition_to_live?¶

optional transition_to_live?: boolean;

type?¶

optional type?: 5 | 6 | 9;

PATCH /webinars/{webinarId}/branding/name_tags/{nameTagId}¶

PATCH /webinars/{webinarId}/branding/name_tags/{nameTagId}: {
  accent_color?: string;
  background_color?: string;
  is_default?: boolean;
  name?: string;
  set_default_for_all_panelists?: boolean;
  text_color?: string;
};

accent_color?¶

optional accent_color?: string;

background_color?¶

optional background_color?: string;

is_default?¶

optional is_default?: boolean;

name?¶

optional name?: string;

set_default_for_all_panelists?¶

optional set_default_for_all_panelists?: boolean;

text_color?¶

optional text_color?: string;

PATCH /webinars/{webinarId}/branding/virtual_backgrounds¶

PATCH /webinars/{webinarId}/branding/virtual_backgrounds: never;

PATCH /webinars/{webinarId}/livestream¶

PATCH /webinars/{webinarId}/livestream: {
  page_url: string;
  resolution?: string;
  stream_key: string;
  stream_url: string;
};

page_url¶

page_url: string;

resolution?¶

optional resolution?: string;

stream_key¶

stream_key: string;

stream_url¶

stream_url: string;

PATCH /webinars/{webinarId}/livestream/status¶

PATCH /webinars/{webinarId}/livestream/status: {
  action?: "stop" | "start";
  settings?: {
     active_speaker_name?: boolean;
     close_caption?: "off" | "burnt-in" | "embedded";
     display_name?: string;
  };
};

action?¶

optional action?: "stop" | "start";

settings?¶

optional settings?: {
  active_speaker_name?: boolean;
  close_caption?: "off" | "burnt-in" | "embedded";
  display_name?: string;
};

settings.active_speaker_name?¶

optional active_speaker_name?: boolean;

settings.close_caption?¶

optional close_caption?: "off" | "burnt-in" | "embedded";

settings.display_name?¶

optional display_name?: string;

PATCH /webinars/{webinarId}/registrants/questions¶

PATCH /webinars/{webinarId}/registrants/questions: {
  custom_questions?: readonly {
     answers?: readonly string[];
     required?: boolean;
     title?: string;
     type?: "short" | "multiple" | "single_radio" | "single_dropdown";
  }[];
  questions?: readonly {
     field_name?:   | "state"
        | "phone"
        | "last_name"
        | "address"
        | "city"
        | "country"
        | "zip"
        | "industry"
        | "org"
        | "job_title"
        | "purchasing_time_frame"
        | "role_in_purchase_process"
        | "no_of_employees"
        | "comments";
     required?: boolean;
  }[];
};

custom_questions?¶

optional custom_questions?: readonly {
  answers?: readonly string[];
  required?: boolean;
  title?: string;
  type?: "short" | "multiple" | "single_radio" | "single_dropdown";
}[];

questions?¶

optional questions?: readonly {
  field_name?:   | "state"
     | "phone"
     | "last_name"
     | "address"
     | "city"
     | "country"
     | "zip"
     | "industry"
     | "org"
     | "job_title"
     | "purchasing_time_frame"
     | "role_in_purchase_process"
     | "no_of_employees"
     | "comments";
  required?: boolean;
}[];

PATCH /webinars/{webinarId}/survey¶

PATCH /webinars/{webinarId}/survey: {
  custom_survey?: {
     anonymous?: boolean;
     feedback?: string;
     numbered_questions?: boolean;
     questions?: readonly {
        answer_max_character?: number;
        answer_min_character?: number;
        answer_required?: boolean;
        answers?: readonly string[];
        name?: string;
        prompts?: readonly {
           prompt_question?: string;
        }[];
        rating_max_label?: string;
        rating_max_value?: number;
        rating_min_label?: string;
        rating_min_value?: number;
        show_as_dropdown?: boolean;
        type?:   | "single"
           | "multiple"
           | "matching"
           | "rank_order"
           | "short_answer"
           | "long_answer"
           | "fill_in_the_blank"
           | "rating_scale";
     }[];
     show_question_type?: boolean;
     title?: string;
  };
  show_in_the_browser?: boolean;
  show_in_the_follow_up_email?: boolean;
  third_party_survey?: string;
};

custom_survey?¶

optional custom_survey?: {
  anonymous?: boolean;
  feedback?: string;
  numbered_questions?: boolean;
  questions?: readonly {
     answer_max_character?: number;
     answer_min_character?: number;
     answer_required?: boolean;
     answers?: readonly string[];
     name?: string;
     prompts?: readonly {
        prompt_question?: string;
     }[];
     rating_max_label?: string;
     rating_max_value?: number;
     rating_min_label?: string;
     rating_min_value?: number;
     show_as_dropdown?: boolean;
     type?:   | "single"
        | "multiple"
        | "matching"
        | "rank_order"
        | "short_answer"
        | "long_answer"
        | "fill_in_the_blank"
        | "rating_scale";
  }[];
  show_question_type?: boolean;
  title?: string;
};

custom_survey.anonymous?¶

optional anonymous?: boolean;

custom_survey.feedback?¶

optional feedback?: string;

custom_survey.numbered_questions?¶

optional numbered_questions?: boolean;

custom_survey.questions?¶

optional questions?: readonly {
  answer_max_character?: number;
  answer_min_character?: number;
  answer_required?: boolean;
  answers?: readonly string[];
  name?: string;
  prompts?: readonly {
     prompt_question?: string;
  }[];
  rating_max_label?: string;
  rating_max_value?: number;
  rating_min_label?: string;
  rating_min_value?: number;
  show_as_dropdown?: boolean;
  type?:   | "single"
     | "multiple"
     | "matching"
     | "rank_order"
     | "short_answer"
     | "long_answer"
     | "fill_in_the_blank"
     | "rating_scale";
}[];

custom_survey.show_question_type?¶

optional show_question_type?: boolean;

custom_survey.title?¶

optional title?: string;

show_in_the_browser?¶

optional show_in_the_browser?: boolean;

show_in_the_follow_up_email?¶

optional show_in_the_follow_up_email?: boolean;

third_party_survey?¶

optional third_party_survey?: string;

POST /devices¶

POST /devices: {
  device_name: string;
  device_type: 0 | 1 | 5;
  extension_number?: string;
  mac_address: string;
  model: string;
  room_id?: string;
  serial_number: string;
  tag?: string;
  user_email?: string;
  vendor: string;
  zdm_group_id?: string;
};

device_name¶

device_name: string;

device_type¶

device_type: 0 | 1 | 5;

extension_number?¶

optional extension_number?: string;

mac_address¶

mac_address: string;

model¶

model: string;

room_id?¶

optional room_id?: string;

serial_number¶

serial_number: string;

tag?¶

optional tag?: string;

user_email?¶

optional user_email?: string;

vendor¶

vendor: string;

zdm_group_id?¶

optional zdm_group_id?: string;

POST /devices/zpa/assignment¶

POST /devices/zpa/assignment: {
  extension_number?: string;
  mac_address: string;
  vendor: string;
};

extension_number?¶

optional extension_number?: string;

mac_address¶

mac_address: string;

vendor¶

vendor: string;

POST /devices/zpa/upgrade¶

POST /devices/zpa/upgrade: {
  data:   | {
     firmware_versions?: readonly {
        model?: string;
        vendor?: string;
        version?: string;
     }[];
     upgrade_type: "UPGRADE_FIRMWARE";
   }
     | {
     app_version?: string;
     upgrade_type: "UPGRADE_APP";
   };
  zdm_group_id: string;
};

data¶

data:
  | {
  firmware_versions?: readonly {
     model?: string;
     vendor?: string;
     version?: string;
  }[];
  upgrade_type: "UPGRADE_FIRMWARE";
}
  | {
  app_version?: string;
  upgrade_type: "UPGRADE_APP";
};

zdm_group_id¶

zdm_group_id: string;

POST /h323/devices¶

POST /h323/devices: {
  encryption: "auto" | "yes" | "no";
  ip: string;
  name: string;
  protocol: "H.323" | "SIP";
};

encryption¶

encryption: "auto" | "yes" | "no";

ip¶

ip: string;

name¶

name: string;

protocol¶

protocol: "H.323" | "SIP";

POST /meetings/{meetingId}/batch_polls¶

POST /meetings/{meetingId}/batch_polls: {
  polls?: readonly {
     anonymous?: boolean;
     poll_type?: 1 | 2 | 3;
     questions?: readonly {
        answer_max_character?: number;
        answer_min_character?: number;
        answer_required?: boolean;
        answers?: readonly string[];
        case_sensitive?: boolean;
        name?: string;
        prompts?: readonly {
           prompt_question?: string;
           prompt_right_answers?: readonly string[];
        }[];
        rating_max_label?: string;
        rating_max_value?: number;
        rating_min_label?: string;
        rating_min_value?: number;
        right_answers?: readonly string[];
        show_as_dropdown?: boolean;
        type?:   | "single"
           | "multiple"
           | "matching"
           | "rank_order"
           | "short_answer"
           | "long_answer"
           | "fill_in_the_blank"
           | "rating_scale";
     }[];
     title?: string;
  }[];
};

polls?¶

optional polls?: readonly {
  anonymous?: boolean;
  poll_type?: 1 | 2 | 3;
  questions?: readonly {
     answer_max_character?: number;
     answer_min_character?: number;
     answer_required?: boolean;
     answers?: readonly string[];
     case_sensitive?: boolean;
     name?: string;
     prompts?: readonly {
        prompt_question?: string;
        prompt_right_answers?: readonly string[];
     }[];
     rating_max_label?: string;
     rating_max_value?: number;
     rating_min_label?: string;
     rating_min_value?: number;
     right_answers?: readonly string[];
     show_as_dropdown?: boolean;
     type?:   | "single"
        | "multiple"
        | "matching"
        | "rank_order"
        | "short_answer"
        | "long_answer"
        | "fill_in_the_blank"
        | "rating_scale";
  }[];
  title?: string;
}[];

POST /meetings/{meetingId}/batch_registrants¶

POST /meetings/{meetingId}/batch_registrants: {
  auto_approve?: boolean;
  registrants?: readonly {
     email: string;
     first_name: string;
     last_name?: string;
  }[];
  registrants_confirmation_email?: boolean;
};

auto_approve?¶

optional auto_approve?: boolean;

registrants?¶

optional registrants?: readonly {
  email: string;
  first_name: string;
  last_name?: string;
}[];

registrants_confirmation_email?¶

optional registrants_confirmation_email?: boolean;

POST /meetings/{meetingId}/invite_links¶

POST /meetings/{meetingId}/invite_links: {
  attendees?: readonly {
     disable_audio?: boolean;
     disable_video?: boolean;
     name: string;
  }[];
  ttl?: number;
};

attendees?¶

optional attendees?: readonly {
  disable_audio?: boolean;
  disable_video?: boolean;
  name: string;
}[];

ttl?¶

optional ttl?: number;

POST /meetings/{meetingId}/open_apps¶

POST /meetings/{meetingId}/open_apps: never;

POST /meetings/{meetingId}/polls¶

POST /meetings/{meetingId}/polls: {
  anonymous?: boolean;
  poll_type?: 1 | 2 | 3;
  questions?: readonly {
     answer_max_character?: number;
     answer_min_character?: number;
     answer_required?: boolean;
     answers?: readonly string[];
     case_sensitive?: boolean;
     name?: string;
     prompts?: readonly {
        prompt_question?: string;
        prompt_right_answers?: readonly string[];
     }[];
     rating_max_label?: string;
     rating_max_value?: number;
     rating_min_label?: string;
     rating_min_value?: number;
     right_answers?: readonly string[];
     show_as_dropdown?: boolean;
     type?:   | "single"
        | "multiple"
        | "matching"
        | "rank_order"
        | "short_answer"
        | "long_answer"
        | "fill_in_the_blank"
        | "rating_scale";
  }[];
  title?: string;
};

anonymous?¶

optional anonymous?: boolean;

poll_type?¶

optional poll_type?: 1 | 2 | 3;

questions?¶

optional questions?: readonly {
  answer_max_character?: number;
  answer_min_character?: number;
  answer_required?: boolean;
  answers?: readonly string[];
  case_sensitive?: boolean;
  name?: string;
  prompts?: readonly {
     prompt_question?: string;
     prompt_right_answers?: readonly string[];
  }[];
  rating_max_label?: string;
  rating_max_value?: number;
  rating_min_label?: string;
  rating_min_value?: number;
  right_answers?: readonly string[];
  show_as_dropdown?: boolean;
  type?:   | "single"
     | "multiple"
     | "matching"
     | "rank_order"
     | "short_answer"
     | "long_answer"
     | "fill_in_the_blank"
     | "rating_scale";
}[];

title?¶

optional title?: string;

POST /meetings/{meetingId}/recordings/registrants¶

POST /meetings/{meetingId}/recordings/registrants: {
  address?: string;
  city?: string;
  comments?: string;
  country?: string;
  custom_questions?: readonly {
     title?: string;
     value?: string;
  }[];
  email: string;
  first_name: string;
  industry?: string;
  job_title?: string;
  last_name?: string;
  no_of_employees?:   | ""
     | "1-20"
     | "21-50"
     | "51-100"
     | "101-250"
     | "251-500"
     | "501-1,000"
     | "1,001-5,000"
     | "5,001-10,000"
     | "More than 10,000";
  org?: string;
  phone?: string;
  purchasing_time_frame?:   | ""
     | "Within a month"
     | "1-3 months"
     | "4-6 months"
     | "More than 6 months"
     | "No timeframe";
  role_in_purchase_process?:   | ""
     | "Decision Maker"
     | "Evaluator/Recommender"
     | "Influencer"
     | "Not involved";
  state?: string;
  status?: "pending" | "approved" | "denied";
  zip?: string;
};

address?¶

optional address?: string;

city?¶

optional city?: string;

comments?¶

optional comments?: string;

country?¶

optional country?: string;

custom_questions?¶

optional custom_questions?: readonly {
  title?: string;
  value?: string;
}[];

email¶

email: string;

first_name¶

first_name: string;

industry?¶

optional industry?: string;

job_title?¶

optional job_title?: string;

last_name?¶

optional last_name?: string;

no_of_employees?¶

optional no_of_employees?:
  | ""
  | "1-20"
  | "21-50"
  | "51-100"
  | "101-250"
  | "251-500"
  | "501-1,000"
  | "1,001-5,000"
  | "5,001-10,000"
  | "More than 10,000";

org?¶

optional org?: string;

phone?¶

optional phone?: string;

purchasing_time_frame?¶

optional purchasing_time_frame?:
  | ""
  | "Within a month"
  | "1-3 months"
  | "4-6 months"
  | "More than 6 months"
  | "No timeframe";

role_in_purchase_process?¶

optional role_in_purchase_process?:
  | ""
  | "Decision Maker"
  | "Evaluator/Recommender"
  | "Influencer"
  | "Not involved";

state?¶

optional state?: string;

status?¶

optional status?: "pending" | "approved" | "denied";

zip?¶

optional zip?: string;

POST /meetings/{meetingId}/registrants¶

POST /meetings/{meetingId}/registrants: {
  address?: string;
  city?: string;
  comments?: string;
  country?: string;
  custom_questions?: readonly {
     title?: string;
     value?: string;
  }[];
  email: string;
  first_name: string;
  industry?: string;
  job_title?: string;
  last_name?: string;
  no_of_employees?:   | ""
     | "1-20"
     | "21-50"
     | "51-100"
     | "1,001-5,000"
     | "5,001-10,000"
     | "More than 10,000"
     | "101-500"
     | "500-1,000";
  org?: string;
  phone?: string;
  purchasing_time_frame?:   | ""
     | "Within a month"
     | "1-3 months"
     | "4-6 months"
     | "More than 6 months"
     | "No timeframe";
  role_in_purchase_process?:   | ""
     | "Decision Maker"
     | "Evaluator/Recommender"
     | "Influencer"
     | "Not involved";
  state?: string;
  zip?: string;
} & {
  language?:   | "de-DE"
     | "en-US"
     | "es-ES"
     | "fr-FR"
     | "it-IT"
     | "pl-PL"
     | "pt-PT"
     | "ru-RU"
     | "vi-VN"
     | "zh-CN"
     | "zh-TW"
     | "jp-JP"
     | "ko-KO"
     | "Tr-TR";
} & {
  auto_approve?: boolean;
};

Type Declaration¶

address?¶

optional address?: string;

city?¶

optional city?: string;

comments?¶

optional comments?: string;

country?¶

optional country?: string;

custom_questions?¶

optional custom_questions?: readonly {
  title?: string;
  value?: string;
}[];

email¶

email: string;

first_name¶

first_name: string;

industry?¶

optional industry?: string;

job_title?¶

optional job_title?: string;

last_name?¶

optional last_name?: string;

no_of_employees?¶

optional no_of_employees?:
  | ""
  | "1-20"
  | "21-50"
  | "51-100"
  | "1,001-5,000"
  | "5,001-10,000"
  | "More than 10,000"
  | "101-500"
  | "500-1,000";

org?¶

optional org?: string;

phone?¶

optional phone?: string;

purchasing_time_frame?¶

optional purchasing_time_frame?:
  | ""
  | "Within a month"
  | "1-3 months"
  | "4-6 months"
  | "More than 6 months"
  | "No timeframe";

role_in_purchase_process?¶

optional role_in_purchase_process?:
  | ""
  | "Decision Maker"
  | "Evaluator/Recommender"
  | "Influencer"
  | "Not involved";

state?¶

optional state?: string;

zip?¶

optional zip?: string;

Type Declaration¶

language?¶

optional language?:
  | "de-DE"
  | "en-US"
  | "es-ES"
  | "fr-FR"
  | "it-IT"
  | "pl-PL"
  | "pt-PT"
  | "ru-RU"
  | "vi-VN"
  | "zh-CN"
  | "zh-TW"
  | "jp-JP"
  | "ko-KO"
  | "Tr-TR";

Type Declaration¶

auto_approve?¶

optional auto_approve?: boolean;

POST /meetings/{meetingId}/sip_dialing¶

POST /meetings/{meetingId}/sip_dialing: {
  passcode?: string;
};

passcode?¶

optional passcode?: string;

POST /sip_phones/phones¶

POST /sip_phones/phones: {
  authorization_name: string;
  display_number?: string;
  domain: string;
  password: string;
  registration_expire_time?: number;
  server: {
     proxy_server?: string;
     register_server?: string;
     transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
  };
  server_2?: {
     proxy_server?: string;
     register_server?: string;
     transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
  };
  server_3?: {
     proxy_server?: string;
     register_server?: string;
     transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
  };
  user_email: string;
  user_name: string;
  voice_mail?: string;
};

authorization_name¶

authorization_name: string;

display_number?¶

optional display_number?: string;

domain¶

domain: string;

password¶

password: string;

registration_expire_time?¶

optional registration_expire_time?: number;

server¶

server: {
  proxy_server?: string;
  register_server?: string;
  transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
};

server.proxy_server?¶

optional proxy_server?: string;

server.register_server?¶

optional register_server?: string;

server.transport_protocol?¶

optional transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";

server_2?¶

optional server_2?: {
  proxy_server?: string;
  register_server?: string;
  transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
};

server_2.proxy_server?¶

optional proxy_server?: string;

server_2.register_server?¶

optional register_server?: string;

server_2.transport_protocol?¶

optional transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";

server_3?¶

optional server_3?: {
  proxy_server?: string;
  register_server?: string;
  transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
};

server_3.proxy_server?¶

optional proxy_server?: string;

server_3.register_server?¶

optional register_server?: string;

server_3.transport_protocol?¶

optional transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";

user_email¶

user_email: string;

user_name¶

user_name: string;

voice_mail?¶

optional voice_mail?: string;

POST /tracking_fields¶

POST /tracking_fields: {
  field?: string;
  recommended_values?: readonly string[];
  required?: boolean;
  visible?: boolean;
};

field?¶

optional field?: string;

recommended_values?¶

optional recommended_values?: readonly string[];

required?¶

optional required?: boolean;

visible?¶

optional visible?: boolean;

POST /users/{userId}/meeting_templates¶

POST /users/{userId}/meeting_templates: {
  meeting_id?: number;
  name?: string;
  overwrite?: boolean;
  save_recurrence?: boolean;
};

meeting_id?¶

optional meeting_id?: number;

name?¶

optional name?: string;

overwrite?¶

optional overwrite?: boolean;

save_recurrence?¶

optional save_recurrence?: boolean;

POST /users/{userId}/meetings¶

POST /users/{userId}/meetings: {
  agenda?: string;
  default_password?: boolean;
  duration?: number;
  password?: string;
  pre_schedule?: boolean;
  recurrence?: {
     end_date_time?: string;
     end_times?: number;
     monthly_day?: number;
     monthly_week?: -1 | 1 | 2 | 3 | 4;
     monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
     repeat_interval?: number;
     type: 1 | 2 | 3;
     weekly_days?: "2" | "1" | "3" | "4" | "5" | "6" | "7";
  };
  schedule_for?: string;
  settings?: {
     additional_data_center_regions?: readonly string[];
     allow_host_control_participant_mute_state?: boolean;
     allow_multiple_devices?: boolean;
     alternative_host_manage_cloud_recording?: boolean;
     alternative_host_manage_meeting_summary?: boolean;
     alternative_host_update_polls?: boolean;
     alternative_hosts?: string;
     alternative_hosts_email_notification?: boolean;
     approval_type?: 0 | 1 | 2;
     approved_or_denied_countries_or_regions?: {
        approved_list?: readonly string[];
        denied_list?: readonly string[];
        enable?: boolean;
        method?: "approve" | "deny";
     };
     audio?: "both" | "telephony" | "voip" | "thirdParty";
     audio_conference_info?: string;
     authentication_domains?: string;
     authentication_exception?: readonly {
        email?: string;
        name?: string;
     }[];
     authentication_option?: string;
     auto_add_recording_to_video_management?: {
        channels?: readonly {
           channel_id: string;
           name?: string;
        }[];
        enable: boolean;
     };
     auto_recording?: "none" | "local" | "cloud";
     auto_start_ai_companion_questions?: boolean;
     auto_start_meeting_summary?: boolean;
     breakout_room?: {
        enable?: boolean;
        rooms?: readonly {
           name?: string;
           participants?: readonly string[];
        }[];
     };
     calendar_type?: 1 | 2;
     close_registration?: boolean;
     cn_meeting?: boolean;
     contact_email?: string;
     contact_name?: string;
     continuous_meeting_chat?: {
        auto_add_invited_external_users?: boolean;
        auto_add_meeting_participants?: boolean;
        enable?: boolean;
     };
     device_testing?: boolean;
     disable_participant_video?: boolean;
     email_in_attendee_report?: boolean;
     email_notification?: boolean;
     encryption_type?: "enhanced_encryption" | "e2ee";
     focus_mode?: boolean;
     global_dial_in_countries?: readonly string[];
     host_save_video_order?: boolean;
     host_video?: boolean;
     in_meeting?: boolean;
     internal_meeting?: boolean;
     jbh_time?: 0 | 5 | 10 | 15;
     join_before_host?: boolean;
     language_interpretation?: {
        enable?: boolean;
        interpreters?: readonly {
           email?: string;
           interpreter_languages?: string;
           languages?: string;
        }[];
     };
     meeting_authentication?: boolean;
     meeting_invitees?: readonly {
        email?: string;
     }[];
     mute_upon_entry?: boolean;
     participant_focused_meeting?: boolean;
     participant_video?: boolean;
     private_meeting?: boolean;
     push_change_to_calendar?: boolean;
     question_and_answer?: {
        allow_anonymous_questions?: boolean;
        allow_submit_questions?: boolean;
        attendees_can_comment?: boolean;
        attendees_can_upvote?: boolean;
        enable?: boolean;
        question_visibility?: "all" | "answered";
     };
     registrants_confirmation_email?: boolean;
     registrants_email_notification?: boolean;
     registration_type?: 1 | 2 | 3;
     request_permission_to_unmute_participants?: boolean;
     resources?: readonly {
        permission_level?: "editor" | "commenter" | "viewer";
        resource_id?: string;
        resource_type?: "whiteboard";
     }[];
     show_join_info?: boolean;
     show_share_button?: boolean;
     sign_language_interpretation?: {
        enable?: boolean;
        interpreters?: readonly {
           email?: string;
           sign_language?: string;
        }[];
     };
     summary_template_id?: string;
     use_pmi?: boolean;
     waiting_room?: boolean;
     waiting_room_options?: {
        mode: "custom" | "follow_setting";
        who_goes_to_waiting_room?:   | "everyone"
           | "users_not_in_account"
           | "users_not_in_account_or_whitelisted_domains"
           | "users_not_on_invite"
           | "users_not_in_org";
     };
     watermark?: boolean;
     who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;
     who_will_receive_summary?: 1 | 2 | 3 | 4;
  };
  start_time?: string;
  template_id?: string;
  timezone?: string;
  topic?: string;
  tracking_fields?: readonly {
     field: string;
     value?: string;
  }[];
  type?: 1 | 2 | 3 | 8 | 10;
};

agenda?¶

optional agenda?: string;

default_password?¶

optional default_password?: boolean;

duration?¶

optional duration?: number;

password?¶

optional password?: string;

pre_schedule?¶

optional pre_schedule?: boolean;

recurrence?¶

optional recurrence?: {
  end_date_time?: string;
  end_times?: number;
  monthly_day?: number;
  monthly_week?: -1 | 1 | 2 | 3 | 4;
  monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
  repeat_interval?: number;
  type: 1 | 2 | 3;
  weekly_days?: "2" | "1" | "3" | "4" | "5" | "6" | "7";
};

recurrence.end_date_time?¶

optional end_date_time?: string;

recurrence.end_times?¶

optional end_times?: number;

recurrence.monthly_day?¶

optional monthly_day?: number;

recurrence.monthly_week?¶

optional monthly_week?: -1 | 1 | 2 | 3 | 4;

recurrence.monthly_week_day?¶

optional monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;

recurrence.repeat_interval?¶

optional repeat_interval?: number;

recurrence.type¶

type: 1 | 2 | 3;

recurrence.weekly_days?¶

optional weekly_days?: "2" | "1" | "3" | "4" | "5" | "6" | "7";

schedule_for?¶

optional schedule_for?: string;

settings?¶

optional settings?: {
  additional_data_center_regions?: readonly string[];
  allow_host_control_participant_mute_state?: boolean;
  allow_multiple_devices?: boolean;
  alternative_host_manage_cloud_recording?: boolean;
  alternative_host_manage_meeting_summary?: boolean;
  alternative_host_update_polls?: boolean;
  alternative_hosts?: string;
  alternative_hosts_email_notification?: boolean;
  approval_type?: 0 | 1 | 2;
  approved_or_denied_countries_or_regions?: {
     approved_list?: readonly string[];
     denied_list?: readonly string[];
     enable?: boolean;
     method?: "approve" | "deny";
  };
  audio?: "both" | "telephony" | "voip" | "thirdParty";
  audio_conference_info?: string;
  authentication_domains?: string;
  authentication_exception?: readonly {
     email?: string;
     name?: string;
  }[];
  authentication_option?: string;
  auto_add_recording_to_video_management?: {
     channels?: readonly {
        channel_id: string;
        name?: string;
     }[];
     enable: boolean;
  };
  auto_recording?: "none" | "local" | "cloud";
  auto_start_ai_companion_questions?: boolean;
  auto_start_meeting_summary?: boolean;
  breakout_room?: {
     enable?: boolean;
     rooms?: readonly {
        name?: string;
        participants?: readonly string[];
     }[];
  };
  calendar_type?: 1 | 2;
  close_registration?: boolean;
  cn_meeting?: boolean;
  contact_email?: string;
  contact_name?: string;
  continuous_meeting_chat?: {
     auto_add_invited_external_users?: boolean;
     auto_add_meeting_participants?: boolean;
     enable?: boolean;
  };
  device_testing?: boolean;
  disable_participant_video?: boolean;
  email_in_attendee_report?: boolean;
  email_notification?: boolean;
  encryption_type?: "enhanced_encryption" | "e2ee";
  focus_mode?: boolean;
  global_dial_in_countries?: readonly string[];
  host_save_video_order?: boolean;
  host_video?: boolean;
  in_meeting?: boolean;
  internal_meeting?: boolean;
  jbh_time?: 0 | 5 | 10 | 15;
  join_before_host?: boolean;
  language_interpretation?: {
     enable?: boolean;
     interpreters?: readonly {
        email?: string;
        interpreter_languages?: string;
        languages?: string;
     }[];
  };
  meeting_authentication?: boolean;
  meeting_invitees?: readonly {
     email?: string;
  }[];
  mute_upon_entry?: boolean;
  participant_focused_meeting?: boolean;
  participant_video?: boolean;
  private_meeting?: boolean;
  push_change_to_calendar?: boolean;
  question_and_answer?: {
     allow_anonymous_questions?: boolean;
     allow_submit_questions?: boolean;
     attendees_can_comment?: boolean;
     attendees_can_upvote?: boolean;
     enable?: boolean;
     question_visibility?: "all" | "answered";
  };
  registrants_confirmation_email?: boolean;
  registrants_email_notification?: boolean;
  registration_type?: 1 | 2 | 3;
  request_permission_to_unmute_participants?: boolean;
  resources?: readonly {
     permission_level?: "editor" | "commenter" | "viewer";
     resource_id?: string;
     resource_type?: "whiteboard";
  }[];
  show_join_info?: boolean;
  show_share_button?: boolean;
  sign_language_interpretation?: {
     enable?: boolean;
     interpreters?: readonly {
        email?: string;
        sign_language?: string;
     }[];
  };
  summary_template_id?: string;
  use_pmi?: boolean;
  waiting_room?: boolean;
  waiting_room_options?: {
     mode: "custom" | "follow_setting";
     who_goes_to_waiting_room?:   | "everyone"
        | "users_not_in_account"
        | "users_not_in_account_or_whitelisted_domains"
        | "users_not_on_invite"
        | "users_not_in_org";
  };
  watermark?: boolean;
  who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;
  who_will_receive_summary?: 1 | 2 | 3 | 4;
};

settings.additional_data_center_regions?¶

optional additional_data_center_regions?: readonly string[];

settings.allow_host_control_participant_mute_state?¶

optional allow_host_control_participant_mute_state?: boolean;

settings.allow_multiple_devices?¶

optional allow_multiple_devices?: boolean;

settings.alternative_host_manage_cloud_recording?¶

optional alternative_host_manage_cloud_recording?: boolean;

settings.alternative_host_manage_meeting_summary?¶

optional alternative_host_manage_meeting_summary?: boolean;

settings.alternative_host_update_polls?¶

optional alternative_host_update_polls?: boolean;

settings.alternative_hosts?¶

optional alternative_hosts?: string;

settings.alternative_hosts_email_notification?¶

optional alternative_hosts_email_notification?: boolean;

settings.approval_type?¶

optional approval_type?: 0 | 1 | 2;

settings.approved_or_denied_countries_or_regions?¶

optional approved_or_denied_countries_or_regions?: {
  approved_list?: readonly string[];
  denied_list?: readonly string[];
  enable?: boolean;
  method?: "approve" | "deny";
};

settings.approved_or_denied_countries_or_regions.approved_list?¶

optional approved_list?: readonly string[];

settings.approved_or_denied_countries_or_regions.denied_list?¶

optional denied_list?: readonly string[];

settings.approved_or_denied_countries_or_regions.enable?¶

optional enable?: boolean;

settings.approved_or_denied_countries_or_regions.method?¶

optional method?: "approve" | "deny";

settings.audio?¶

optional audio?: "both" | "telephony" | "voip" | "thirdParty";

settings.audio_conference_info?¶

optional audio_conference_info?: string;

settings.authentication_domains?¶

optional authentication_domains?: string;

settings.authentication_exception?¶

optional authentication_exception?: readonly {
  email?: string;
  name?: string;
}[];

settings.authentication_option?¶

optional authentication_option?: string;

settings.auto_add_recording_to_video_management?¶

optional auto_add_recording_to_video_management?: {
  channels?: readonly {
     channel_id: string;
     name?: string;
  }[];
  enable: boolean;
};

settings.auto_add_recording_to_video_management.channels?¶

optional channels?: readonly {
  channel_id: string;
  name?: string;
}[];

settings.auto_add_recording_to_video_management.enable¶

enable: boolean;

settings.auto_recording?¶

optional auto_recording?: "none" | "local" | "cloud";

settings.auto_start_ai_companion_questions?¶

optional auto_start_ai_companion_questions?: boolean;

settings.auto_start_meeting_summary?¶

optional auto_start_meeting_summary?: boolean;

settings.breakout_room?¶

optional breakout_room?: {
  enable?: boolean;
  rooms?: readonly {
     name?: string;
     participants?: readonly string[];
  }[];
};

settings.breakout_room.enable?¶

optional enable?: boolean;

settings.breakout_room.rooms?¶

optional rooms?: readonly {
  name?: string;
  participants?: readonly string[];
}[];

settings.calendar_type?¶

optional calendar_type?: 1 | 2;

settings.close_registration?¶

optional close_registration?: boolean;

settings.cn_meeting?¶

optional cn_meeting?: boolean;

settings.contact_email?¶

optional contact_email?: string;

settings.contact_name?¶

optional contact_name?: string;

settings.continuous_meeting_chat?¶

optional continuous_meeting_chat?: {
  auto_add_invited_external_users?: boolean;
  auto_add_meeting_participants?: boolean;
  enable?: boolean;
};

settings.continuous_meeting_chat.auto_add_invited_external_users?¶

optional auto_add_invited_external_users?: boolean;

settings.continuous_meeting_chat.auto_add_meeting_participants?¶

optional auto_add_meeting_participants?: boolean;

settings.continuous_meeting_chat.enable?¶

optional enable?: boolean;

settings.device_testing?¶

optional device_testing?: boolean;

settings.disable_participant_video?¶

optional disable_participant_video?: boolean;

settings.email_in_attendee_report?¶

optional email_in_attendee_report?: boolean;

settings.email_notification?¶

optional email_notification?: boolean;

settings.encryption_type?¶

optional encryption_type?: "enhanced_encryption" | "e2ee";

settings.focus_mode?¶

optional focus_mode?: boolean;

settings.global_dial_in_countries?¶

optional global_dial_in_countries?: readonly string[];

settings.host_save_video_order?¶

optional host_save_video_order?: boolean;

settings.host_video?¶

optional host_video?: boolean;

settings.in_meeting?¶

optional in_meeting?: boolean;

settings.internal_meeting?¶

optional internal_meeting?: boolean;

settings.jbh_time?¶

optional jbh_time?: 0 | 5 | 10 | 15;

settings.join_before_host?¶

optional join_before_host?: boolean;

settings.language_interpretation?¶

optional language_interpretation?: {
  enable?: boolean;
  interpreters?: readonly {
     email?: string;
     interpreter_languages?: string;
     languages?: string;
  }[];
};

settings.language_interpretation.enable?¶

optional enable?: boolean;

settings.language_interpretation.interpreters?¶

optional interpreters?: readonly {
  email?: string;
  interpreter_languages?: string;
  languages?: string;
}[];

settings.meeting_authentication?¶

optional meeting_authentication?: boolean;

settings.meeting_invitees?¶

optional meeting_invitees?: readonly {
  email?: string;
}[];

settings.mute_upon_entry?¶

optional mute_upon_entry?: boolean;

settings.participant_focused_meeting?¶

optional participant_focused_meeting?: boolean;

settings.participant_video?¶

optional participant_video?: boolean;

settings.private_meeting?¶

optional private_meeting?: boolean;

settings.push_change_to_calendar?¶

optional push_change_to_calendar?: boolean;

settings.question_and_answer?¶

optional question_and_answer?: {
  allow_anonymous_questions?: boolean;
  allow_submit_questions?: boolean;
  attendees_can_comment?: boolean;
  attendees_can_upvote?: boolean;
  enable?: boolean;
  question_visibility?: "all" | "answered";
};

settings.question_and_answer.allow_anonymous_questions?¶

optional allow_anonymous_questions?: boolean;

settings.question_and_answer.allow_submit_questions?¶

optional allow_submit_questions?: boolean;

settings.question_and_answer.attendees_can_comment?¶

optional attendees_can_comment?: boolean;

settings.question_and_answer.attendees_can_upvote?¶

optional attendees_can_upvote?: boolean;

settings.question_and_answer.enable?¶

optional enable?: boolean;

settings.question_and_answer.question_visibility?¶

optional question_visibility?: "all" | "answered";

settings.registrants_confirmation_email?¶

optional registrants_confirmation_email?: boolean;

settings.registrants_email_notification?¶

optional registrants_email_notification?: boolean;

settings.registration_type?¶

optional registration_type?: 1 | 2 | 3;

settings.request_permission_to_unmute_participants?¶

optional request_permission_to_unmute_participants?: boolean;

settings.resources?¶

optional resources?: readonly {
  permission_level?: "editor" | "commenter" | "viewer";
  resource_id?: string;
  resource_type?: "whiteboard";
}[];

settings.show_join_info?¶

optional show_join_info?: boolean;

settings.show_share_button?¶

optional show_share_button?: boolean;

settings.sign_language_interpretation?¶

optional sign_language_interpretation?: {
  enable?: boolean;
  interpreters?: readonly {
     email?: string;
     sign_language?: string;
  }[];
};

settings.sign_language_interpretation.enable?¶

optional enable?: boolean;

settings.sign_language_interpretation.interpreters?¶

optional interpreters?: readonly {
  email?: string;
  sign_language?: string;
}[];

settings.summary_template_id?¶

optional summary_template_id?: string;

settings.use_pmi?¶

optional use_pmi?: boolean;

settings.waiting_room?¶

optional waiting_room?: boolean;

settings.waiting_room_options?¶

optional waiting_room_options?: {
  mode: "custom" | "follow_setting";
  who_goes_to_waiting_room?:   | "everyone"
     | "users_not_in_account"
     | "users_not_in_account_or_whitelisted_domains"
     | "users_not_on_invite"
     | "users_not_in_org";
};

settings.waiting_room_options.mode¶

mode: "custom" | "follow_setting";

settings.waiting_room_options.who_goes_to_waiting_room?¶

optional who_goes_to_waiting_room?:
  | "everyone"
  | "users_not_in_account"
  | "users_not_in_account_or_whitelisted_domains"
  | "users_not_on_invite"
  | "users_not_in_org";

settings.watermark?¶

optional watermark?: boolean;

settings.who_can_ask_questions?¶

optional who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;

settings.who_will_receive_summary?¶

optional who_will_receive_summary?: 1 | 2 | 3 | 4;

start_time?¶

optional start_time?: string;

template_id?¶

optional template_id?: string;

timezone?¶

optional timezone?: string;

topic?¶

optional topic?: string;

tracking_fields?¶

optional tracking_fields?: readonly {
  field: string;
  value?: string;
}[];

type?¶

optional type?: 1 | 2 | 3 | 8 | 10;

POST /users/{userId}/tsp¶

POST /users/{userId}/tsp: {
  conference_code: string;
  dial_in_numbers?: readonly {
     code?: string;
     country_label?: string;
     number?: string;
     type?: "toll" | "tollfree" | "media_link";
  }[];
  leader_pin: string;
  tsp_bridge?: "US_TSP_TB" | "EU_TSP_TB";
};

conference_code¶

conference_code: string;

dial_in_numbers?¶

optional dial_in_numbers?: readonly {
  code?: string;
  country_label?: string;
  number?: string;
  type?: "toll" | "tollfree" | "media_link";
}[];

leader_pin¶

leader_pin: string;

tsp_bridge?¶

optional tsp_bridge?: "US_TSP_TB" | "EU_TSP_TB";

POST /users/{userId}/webinar_templates¶

POST /users/{userId}/webinar_templates: {
  name?: string;
  overwrite?: boolean;
  save_recurrence?: boolean;
  webinar_id?: number;
};

name?¶

optional name?: string;

overwrite?¶

optional overwrite?: boolean;

save_recurrence?¶

optional save_recurrence?: boolean;

webinar_id?¶

optional webinar_id?: number;

POST /users/{userId}/webinars¶

POST /users/{userId}/webinars: {
  agenda?: string;
  default_passcode?: boolean;
  duration?: number;
  is_simulive?: boolean;
  password?: string;
  record_file_id?: string;
  recurrence?: {
     end_date_time?: string;
     end_times?: number;
     monthly_day?: number;
     monthly_week?: -1 | 1 | 2 | 3 | 4;
     monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
     repeat_interval?: number;
     type: 1 | 2 | 3;
     weekly_days?: string;
  };
  schedule_for?: string;
  settings?: {
     add_audio_watermark?: boolean;
     add_watermark?: boolean;
     additional_data_center_regions?: readonly string[];
     allow_host_control_participant_mute_state?: boolean;
     allow_multiple_devices?: boolean;
     alternative_host_update_polls?: boolean;
     alternative_hosts?: string;
     approval_type?: 0 | 1 | 2;
     attendees_and_panelists_reminder_email_notification?: {
        enable?: boolean;
        type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
     };
     audio?: "both" | "telephony" | "voip" | "thirdParty";
     audio_conference_info?: string;
     authentication_domains?: string;
     authentication_option?: string;
     auto_recording?: "none" | "local" | "cloud";
     close_registration?: boolean;
     contact_email?: string;
     contact_name?: string;
     email_in_attendee_report?: boolean;
     email_language?: string;
     enable_session_branding?: boolean;
     enforce_login?: boolean;
     enforce_login_domains?: string;
     follow_up_absentees_email_notification?: {
        enable?: boolean;
        type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
     };
     follow_up_attendees_email_notification?: {
        enable?: boolean;
        type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
     };
     global_dial_in_countries?: readonly string[];
     hd_video?: boolean;
     hd_video_for_attendees?: boolean;
     host_video?: boolean;
     language_interpretation?: {
        enable?: boolean;
        interpreters?: readonly {
           email?: string;
           interpreter_languages?: string;
           languages?: string;
        }[];
     };
     meeting_authentication?: boolean;
     on_demand?: boolean;
     panelist_authentication?: boolean;
     panelists_invitation_email_notification?: boolean;
     panelists_video?: boolean;
     post_webinar_survey?: boolean;
     practice_session?: boolean;
     question_and_answer?: {
        allow_anonymous_questions?: boolean;
        allow_auto_reply?: boolean;
        allow_submit_questions?: boolean;
        answer_questions?: "all" | "only";
        attendees_can_comment?: boolean;
        attendees_can_upvote?: boolean;
        auto_reply_text?: string;
        enable?: boolean;
     };
     registrants_confirmation_email?: boolean;
     registrants_email_notification?: boolean;
     registrants_restrict_number?: number;
     registration_type?: 1 | 2 | 3;
     request_permission_to_unmute_participants?: boolean;
     send_1080p_video_to_attendees?: boolean;
     show_join_info?: boolean;
     show_share_button?: boolean;
     sign_language_interpretation?: {
        enable?: boolean;
        interpreters?: readonly {
           email?: string;
           sign_language?: string;
        }[];
     };
     survey_url?: string;
  };
  simulive_delay_start?: {
     enable?: boolean;
     time?: number;
     timeunit?: "second" | "minute";
  };
  start_time?: string;
  template_id?: string;
  timezone?: string;
  topic?: string;
  tracking_fields?: readonly {
     field: string;
     value?: string;
  }[];
  transition_to_live?: boolean;
  type?: 5 | 6 | 9;
};

agenda?¶

optional agenda?: string;

default_passcode?¶

optional default_passcode?: boolean;

duration?¶

optional duration?: number;

is_simulive?¶

optional is_simulive?: boolean;

password?¶

optional password?: string;

record_file_id?¶

optional record_file_id?: string;

recurrence?¶

optional recurrence?: {
  end_date_time?: string;
  end_times?: number;
  monthly_day?: number;
  monthly_week?: -1 | 1 | 2 | 3 | 4;
  monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
  repeat_interval?: number;
  type: 1 | 2 | 3;
  weekly_days?: string;
};

recurrence.end_date_time?¶

optional end_date_time?: string;

recurrence.end_times?¶

optional end_times?: number;

recurrence.monthly_day?¶

optional monthly_day?: number;

recurrence.monthly_week?¶

optional monthly_week?: -1 | 1 | 2 | 3 | 4;

recurrence.monthly_week_day?¶

optional monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;

recurrence.repeat_interval?¶

optional repeat_interval?: number;

recurrence.type¶

type: 1 | 2 | 3;

recurrence.weekly_days?¶

optional weekly_days?: string;

schedule_for?¶

optional schedule_for?: string;

settings?¶

optional settings?: {
  add_audio_watermark?: boolean;
  add_watermark?: boolean;
  additional_data_center_regions?: readonly string[];
  allow_host_control_participant_mute_state?: boolean;
  allow_multiple_devices?: boolean;
  alternative_host_update_polls?: boolean;
  alternative_hosts?: string;
  approval_type?: 0 | 1 | 2;
  attendees_and_panelists_reminder_email_notification?: {
     enable?: boolean;
     type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
  };
  audio?: "both" | "telephony" | "voip" | "thirdParty";
  audio_conference_info?: string;
  authentication_domains?: string;
  authentication_option?: string;
  auto_recording?: "none" | "local" | "cloud";
  close_registration?: boolean;
  contact_email?: string;
  contact_name?: string;
  email_in_attendee_report?: boolean;
  email_language?: string;
  enable_session_branding?: boolean;
  enforce_login?: boolean;
  enforce_login_domains?: string;
  follow_up_absentees_email_notification?: {
     enable?: boolean;
     type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
  };
  follow_up_attendees_email_notification?: {
     enable?: boolean;
     type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
  };
  global_dial_in_countries?: readonly string[];
  hd_video?: boolean;
  hd_video_for_attendees?: boolean;
  host_video?: boolean;
  language_interpretation?: {
     enable?: boolean;
     interpreters?: readonly {
        email?: string;
        interpreter_languages?: string;
        languages?: string;
     }[];
  };
  meeting_authentication?: boolean;
  on_demand?: boolean;
  panelist_authentication?: boolean;
  panelists_invitation_email_notification?: boolean;
  panelists_video?: boolean;
  post_webinar_survey?: boolean;
  practice_session?: boolean;
  question_and_answer?: {
     allow_anonymous_questions?: boolean;
     allow_auto_reply?: boolean;
     allow_submit_questions?: boolean;
     answer_questions?: "all" | "only";
     attendees_can_comment?: boolean;
     attendees_can_upvote?: boolean;
     auto_reply_text?: string;
     enable?: boolean;
  };
  registrants_confirmation_email?: boolean;
  registrants_email_notification?: boolean;
  registrants_restrict_number?: number;
  registration_type?: 1 | 2 | 3;
  request_permission_to_unmute_participants?: boolean;
  send_1080p_video_to_attendees?: boolean;
  show_join_info?: boolean;
  show_share_button?: boolean;
  sign_language_interpretation?: {
     enable?: boolean;
     interpreters?: readonly {
        email?: string;
        sign_language?: string;
     }[];
  };
  survey_url?: string;
};

settings.add_audio_watermark?¶

optional add_audio_watermark?: boolean;

settings.add_watermark?¶

optional add_watermark?: boolean;

settings.additional_data_center_regions?¶

optional additional_data_center_regions?: readonly string[];

settings.allow_host_control_participant_mute_state?¶

optional allow_host_control_participant_mute_state?: boolean;

settings.allow_multiple_devices?¶

optional allow_multiple_devices?: boolean;

settings.alternative_host_update_polls?¶

optional alternative_host_update_polls?: boolean;

settings.alternative_hosts?¶

optional alternative_hosts?: string;

settings.approval_type?¶

optional approval_type?: 0 | 1 | 2;

settings.attendees_and_panelists_reminder_email_notification?¶

optional attendees_and_panelists_reminder_email_notification?: {
  enable?: boolean;
  type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
};

settings.attendees_and_panelists_reminder_email_notification.enable?¶

optional enable?: boolean;

settings.attendees_and_panelists_reminder_email_notification.type?¶

optional type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;

settings.audio?¶

optional audio?: "both" | "telephony" | "voip" | "thirdParty";

settings.audio_conference_info?¶

optional audio_conference_info?: string;

settings.authentication_domains?¶

optional authentication_domains?: string;

settings.authentication_option?¶

optional authentication_option?: string;

settings.auto_recording?¶

optional auto_recording?: "none" | "local" | "cloud";

settings.close_registration?¶

optional close_registration?: boolean;

settings.contact_email?¶

optional contact_email?: string;

settings.contact_name?¶

optional contact_name?: string;

settings.email_in_attendee_report?¶

optional email_in_attendee_report?: boolean;

settings.email_language?¶

optional email_language?: string;

settings.enable_session_branding?¶

optional enable_session_branding?: boolean;

settings.enforce_login?¶

optional enforce_login?: boolean;

settings.enforce_login_domains?¶

optional enforce_login_domains?: string;

settings.follow_up_absentees_email_notification?¶

optional follow_up_absentees_email_notification?: {
  enable?: boolean;
  type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
};

settings.follow_up_absentees_email_notification.enable?¶

optional enable?: boolean;

settings.follow_up_absentees_email_notification.type?¶

optional type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;

settings.follow_up_attendees_email_notification?¶

optional follow_up_attendees_email_notification?: {
  enable?: boolean;
  type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
};

settings.follow_up_attendees_email_notification.enable?¶

optional enable?: boolean;

settings.follow_up_attendees_email_notification.type?¶

optional type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;

settings.global_dial_in_countries?¶

optional global_dial_in_countries?: readonly string[];

settings.hd_video?¶

optional hd_video?: boolean;

settings.hd_video_for_attendees?¶

optional hd_video_for_attendees?: boolean;

settings.host_video?¶

optional host_video?: boolean;

settings.language_interpretation?¶

optional language_interpretation?: {
  enable?: boolean;
  interpreters?: readonly {
     email?: string;
     interpreter_languages?: string;
     languages?: string;
  }[];
};

settings.language_interpretation.enable?¶

optional enable?: boolean;

settings.language_interpretation.interpreters?¶

optional interpreters?: readonly {
  email?: string;
  interpreter_languages?: string;
  languages?: string;
}[];

settings.meeting_authentication?¶

optional meeting_authentication?: boolean;

settings.on_demand?¶

optional on_demand?: boolean;

settings.panelist_authentication?¶

optional panelist_authentication?: boolean;

settings.panelists_invitation_email_notification?¶

optional panelists_invitation_email_notification?: boolean;

settings.panelists_video?¶

optional panelists_video?: boolean;

settings.post_webinar_survey?¶

optional post_webinar_survey?: boolean;

settings.practice_session?¶

optional practice_session?: boolean;

settings.question_and_answer?¶

optional question_and_answer?: {
  allow_anonymous_questions?: boolean;
  allow_auto_reply?: boolean;
  allow_submit_questions?: boolean;
  answer_questions?: "all" | "only";
  attendees_can_comment?: boolean;
  attendees_can_upvote?: boolean;
  auto_reply_text?: string;
  enable?: boolean;
};

settings.question_and_answer.allow_anonymous_questions?¶

optional allow_anonymous_questions?: boolean;

settings.question_and_answer.allow_auto_reply?¶

optional allow_auto_reply?: boolean;

settings.question_and_answer.allow_submit_questions?¶

optional allow_submit_questions?: boolean;

settings.question_and_answer.answer_questions?¶

optional answer_questions?: "all" | "only";

settings.question_and_answer.attendees_can_comment?¶

optional attendees_can_comment?: boolean;

settings.question_and_answer.attendees_can_upvote?¶

optional attendees_can_upvote?: boolean;

settings.question_and_answer.auto_reply_text?¶

optional auto_reply_text?: string;

settings.question_and_answer.enable?¶

optional enable?: boolean;

settings.registrants_confirmation_email?¶

optional registrants_confirmation_email?: boolean;

settings.registrants_email_notification?¶

optional registrants_email_notification?: boolean;

settings.registrants_restrict_number?¶

optional registrants_restrict_number?: number;

settings.registration_type?¶

optional registration_type?: 1 | 2 | 3;

settings.request_permission_to_unmute_participants?¶

optional request_permission_to_unmute_participants?: boolean;

settings.send_1080p_video_to_attendees?¶

optional send_1080p_video_to_attendees?: boolean;

settings.show_join_info?¶

optional show_join_info?: boolean;

settings.show_share_button?¶

optional show_share_button?: boolean;

settings.sign_language_interpretation?¶

optional sign_language_interpretation?: {
  enable?: boolean;
  interpreters?: readonly {
     email?: string;
     sign_language?: string;
  }[];
};

settings.sign_language_interpretation.enable?¶

optional enable?: boolean;

settings.sign_language_interpretation.interpreters?¶

optional interpreters?: readonly {
  email?: string;
  sign_language?: string;
}[];

settings.survey_url?¶

optional survey_url?: string;

simulive_delay_start?¶

optional simulive_delay_start?: {
  enable?: boolean;
  time?: number;
  timeunit?: "second" | "minute";
};

simulive_delay_start.enable?¶

optional enable?: boolean;

simulive_delay_start.time?¶

optional time?: number;

simulive_delay_start.timeunit?¶

optional timeunit?: "second" | "minute";

start_time?¶

optional start_time?: string;

template_id?¶

optional template_id?: string;

timezone?¶

optional timezone?: string;

topic?¶

optional topic?: string;

tracking_fields?¶

optional tracking_fields?: readonly {
  field: string;
  value?: string;
}[];

transition_to_live?¶

optional transition_to_live?: boolean;

type?¶

optional type?: 5 | 6 | 9;

POST /webinars/{webinarId}/batch_registrants¶

POST /webinars/{webinarId}/batch_registrants: {
  auto_approve?: boolean;
  registrants?: readonly {
     email: string;
     first_name: string;
     last_name?: string;
  }[];
};

auto_approve?¶

optional auto_approve?: boolean;

registrants?¶

optional registrants?: readonly {
  email: string;
  first_name: string;
  last_name?: string;
}[];

POST /webinars/{webinarId}/branding/name_tags¶

POST /webinars/{webinarId}/branding/name_tags: {
  accent_color: string;
  background_color: string;
  is_default?: boolean;
  name: string;
  set_default_for_all_panelists?: boolean;
  text_color: string;
};

accent_color¶

accent_color: string;

background_color¶

background_color: string;

is_default?¶

optional is_default?: boolean;

name¶

name: string;

set_default_for_all_panelists?¶

optional set_default_for_all_panelists?: boolean;

text_color¶

text_color: string;

POST /webinars/{webinarId}/branding/virtual_backgrounds¶

POST /webinars/{webinarId}/branding/virtual_backgrounds: {
  default?: boolean;
  file: string;
  set_default_for_all_panelists?: boolean;
};

default?¶

optional default?: boolean;

file¶

file: string;

set_default_for_all_panelists?¶

optional set_default_for_all_panelists?: boolean;

POST /webinars/{webinarId}/branding/wallpaper¶

POST /webinars/{webinarId}/branding/wallpaper: {
  file: string;
};

file¶

file: string;

POST /webinars/{webinarId}/invite_links¶

POST /webinars/{webinarId}/invite_links: {
  attendees?: readonly {
     disable_audio?: boolean;
     disable_video?: boolean;
     name: string;
  }[];
  ttl?: number;
};

attendees?¶

optional attendees?: readonly {
  disable_audio?: boolean;
  disable_video?: boolean;
  name: string;
}[];

ttl?¶

optional ttl?: number;

POST /webinars/{webinarId}/panelists¶

POST /webinars/{webinarId}/panelists: {
  panelists?: readonly {
     email?: string;
     name?: string;
   } & {
     name_tag_description?: string;
     name_tag_id?: string;
     name_tag_name?: string;
     name_tag_pronouns?: string;
     virtual_background_id?: string;
  }[];
};

panelists?¶

optional panelists?: readonly {
  email?: string;
  name?: string;
} & {
  name_tag_description?: string;
  name_tag_id?: string;
  name_tag_name?: string;
  name_tag_pronouns?: string;
  virtual_background_id?: string;
}[];

POST /webinars/{webinarId}/polls¶

POST /webinars/{webinarId}/polls: {
  anonymous?: boolean;
  poll_type?: 1 | 2 | 3;
  questions?: readonly {
     answer_max_character?: number;
     answer_min_character?: number;
     answer_required?: boolean;
     answers?: readonly string[];
     case_sensitive?: boolean;
     name?: string;
     prompts?: readonly {
        prompt_question?: string;
        prompt_right_answers?: readonly string[];
     }[];
     rating_max_label?: string;
     rating_max_value?: number;
     rating_min_label?: string;
     rating_min_value?: number;
     right_answers?: readonly string[];
     show_as_dropdown?: boolean;
     type?:   | "single"
        | "multiple"
        | "matching"
        | "rank_order"
        | "short_answer"
        | "long_answer"
        | "fill_in_the_blank"
        | "rating_scale";
  }[];
  title?: string;
};

anonymous?¶

optional anonymous?: boolean;

poll_type?¶

optional poll_type?: 1 | 2 | 3;

questions?¶

optional questions?: readonly {
  answer_max_character?: number;
  answer_min_character?: number;
  answer_required?: boolean;
  answers?: readonly string[];
  case_sensitive?: boolean;
  name?: string;
  prompts?: readonly {
     prompt_question?: string;
     prompt_right_answers?: readonly string[];
  }[];
  rating_max_label?: string;
  rating_max_value?: number;
  rating_min_label?: string;
  rating_min_value?: number;
  right_answers?: readonly string[];
  show_as_dropdown?: boolean;
  type?:   | "single"
     | "multiple"
     | "matching"
     | "rank_order"
     | "short_answer"
     | "long_answer"
     | "fill_in_the_blank"
     | "rating_scale";
}[];

title?¶

optional title?: string;

POST /webinars/{webinarId}/registrants¶

POST /webinars/{webinarId}/registrants: {
  address?: string;
  city?: string;
  comments?: string;
  country?: string;
  custom_questions?: readonly {
     title?: string;
     value?: string;
  }[];
  email: string;
  first_name: string;
  industry?: string;
  job_title?: string;
  language?:   | "de-DE"
     | "en-US"
     | "es-ES"
     | "fr-FR"
     | "it-IT"
     | "pl-PL"
     | "pt-PT"
     | "ru-RU"
     | "vi-VN"
     | "zh-CN"
     | "zh-TW"
     | "jp-JP"
     | "ko-KO"
     | "Tr-TR";
  last_name?: string;
  no_of_employees?:   | ""
     | "1-20"
     | "21-50"
     | "51-100"
     | "1,001-5,000"
     | "5,001-10,000"
     | "More than 10,000"
     | "101-500"
     | "500-1,000";
  org?: string;
  phone?: string;
  purchasing_time_frame?:   | ""
     | "Within a month"
     | "1-3 months"
     | "4-6 months"
     | "More than 6 months"
     | "No timeframe";
  role_in_purchase_process?:   | ""
     | "Decision Maker"
     | "Evaluator/Recommender"
     | "Influencer"
     | "Not involved";
  source_id?: string;
  state?: string;
  zip?: string;
};

address?¶

optional address?: string;

city?¶

optional city?: string;

comments?¶

optional comments?: string;

country?¶

optional country?: string;

custom_questions?¶

optional custom_questions?: readonly {
  title?: string;
  value?: string;
}[];

email¶

email: string;

first_name¶

first_name: string;

industry?¶

optional industry?: string;

job_title?¶

optional job_title?: string;

language?¶

optional language?:
  | "de-DE"
  | "en-US"
  | "es-ES"
  | "fr-FR"
  | "it-IT"
  | "pl-PL"
  | "pt-PT"
  | "ru-RU"
  | "vi-VN"
  | "zh-CN"
  | "zh-TW"
  | "jp-JP"
  | "ko-KO"
  | "Tr-TR";

last_name?¶

optional last_name?: string;

no_of_employees?¶

optional no_of_employees?:
  | ""
  | "1-20"
  | "21-50"
  | "51-100"
  | "1,001-5,000"
  | "5,001-10,000"
  | "More than 10,000"
  | "101-500"
  | "500-1,000";

org?¶

optional org?: string;

phone?¶

optional phone?: string;

purchasing_time_frame?¶

optional purchasing_time_frame?:
  | ""
  | "Within a month"
  | "1-3 months"
  | "4-6 months"
  | "More than 6 months"
  | "No timeframe";

role_in_purchase_process?¶

optional role_in_purchase_process?:
  | ""
  | "Decision Maker"
  | "Evaluator/Recommender"
  | "Influencer"
  | "Not involved";

source_id?¶

optional source_id?: string;

state?¶

optional state?: string;

zip?¶

optional zip?: string;

POST /webinars/{webinarId}/sip_dialing¶

POST /webinars/{webinarId}/sip_dialing: {
  passcode?: string;
};

passcode?¶

optional passcode?: string;

PUT /meetings/{meetingId}/polls/{pollId}¶

PUT /meetings/{meetingId}/polls/{pollId}: {
  anonymous?: boolean;
  poll_type?: 1 | 2 | 3;
  questions?: readonly {
     answer_max_character?: number;
     answer_min_character?: number;
     answer_required?: boolean;
     answers?: readonly string[];
     case_sensitive?: boolean;
     name?: string;
     prompts?: readonly {
        prompt_question?: string;
        prompt_right_answers?: readonly string[];
     }[];
     rating_max_label?: string;
     rating_max_value?: number;
     rating_min_label?: string;
     rating_min_value?: number;
     right_answers?: readonly string[];
     show_as_dropdown?: boolean;
     type?:   | "single"
        | "multiple"
        | "matching"
        | "rank_order"
        | "short_answer"
        | "long_answer"
        | "fill_in_the_blank"
        | "rating_scale";
  }[];
  title?: string;
};

anonymous?¶

optional anonymous?: boolean;

poll_type?¶

optional poll_type?: 1 | 2 | 3;

questions?¶

optional questions?: readonly {
  answer_max_character?: number;
  answer_min_character?: number;
  answer_required?: boolean;
  answers?: readonly string[];
  case_sensitive?: boolean;
  name?: string;
  prompts?: readonly {
     prompt_question?: string;
     prompt_right_answers?: readonly string[];
  }[];
  rating_max_label?: string;
  rating_max_value?: number;
  rating_min_label?: string;
  rating_min_value?: number;
  right_answers?: readonly string[];
  show_as_dropdown?: boolean;
  type?:   | "single"
     | "multiple"
     | "matching"
     | "rank_order"
     | "short_answer"
     | "long_answer"
     | "fill_in_the_blank"
     | "rating_scale";
}[];

title?¶

optional title?: string;

PUT /meetings/{meetingId}/recordings/{recordingId}/status¶

PUT /meetings/{meetingId}/recordings/{recordingId}/status: {
  action?: "recover";
};

action?¶

optional action?: "recover";

PUT /meetings/{meetingId}/recordings/registrants/status¶

PUT /meetings/{meetingId}/recordings/registrants/status: {
  action: "approve" | "deny";
  registrants?: readonly {
     id?: string;
  }[];
};

action¶

action: "approve" | "deny";

registrants?¶

optional registrants?: readonly {
  id?: string;
}[];

PUT /meetings/{meetingId}/registrants/status¶

PUT /meetings/{meetingId}/registrants/status: {
  action: "approve" | "deny" | "cancel";
  registrants?: readonly {
     email?: string;
     id?: string;
  }[];
};

action¶

action: "approve" | "deny" | "cancel";

registrants?¶

optional registrants?: readonly {
  email?: string;
  id?: string;
}[];

PUT /meetings/{meetingId}/status¶

PUT /meetings/{meetingId}/status: {
  action?: "recover" | "end";
};

action?¶

optional action?: "recover" | "end";

PUT /meetings/{meetingUUID}/recordings/status¶

PUT /meetings/{meetingUUID}/recordings/status: {
  action?: "recover";
};

action?¶

optional action?: "recover";

PUT /webinars/{webinarId}/polls/{pollId}¶

PUT /webinars/{webinarId}/polls/{pollId}: {
  anonymous?: boolean;
  poll_type?: 1 | 2 | 3;
  questions?: readonly {
     answer_max_character?: number;
     answer_min_character?: number;
     answer_required?: boolean;
     answers?: readonly string[];
     case_sensitive?: boolean;
     name?: string;
     prompts?: readonly {
        prompt_question?: string;
        prompt_right_answers?: readonly string[];
     }[];
     rating_max_label?: string;
     rating_max_value?: number;
     rating_min_label?: string;
     rating_min_value?: number;
     right_answers?: readonly string[];
     show_as_dropdown?: boolean;
     type?:   | "single"
        | "multiple"
        | "matching"
        | "rank_order"
        | "short_answer"
        | "long_answer"
        | "fill_in_the_blank"
        | "rating_scale";
  }[];
  title?: string;
};

anonymous?¶

optional anonymous?: boolean;

poll_type?¶

optional poll_type?: 1 | 2 | 3;

questions?¶

optional questions?: readonly {
  answer_max_character?: number;
  answer_min_character?: number;
  answer_required?: boolean;
  answers?: readonly string[];
  case_sensitive?: boolean;
  name?: string;
  prompts?: readonly {
     prompt_question?: string;
     prompt_right_answers?: readonly string[];
  }[];
  rating_max_label?: string;
  rating_max_value?: number;
  rating_min_label?: string;
  rating_min_value?: number;
  right_answers?: readonly string[];
  show_as_dropdown?: boolean;
  type?:   | "single"
     | "multiple"
     | "matching"
     | "rank_order"
     | "short_answer"
     | "long_answer"
     | "fill_in_the_blank"
     | "rating_scale";
}[];

title?¶

optional title?: string;

PUT /webinars/{webinarId}/registrants/status¶

PUT /webinars/{webinarId}/registrants/status: {
  action: "approve" | "deny" | "cancel";
  registrants?: readonly {
     email?: string;
     id?: string;
  }[];
};

action¶

action: "approve" | "deny" | "cancel";

registrants?¶

optional registrants?: readonly {
  email?: string;
  id?: string;
}[];

PUT /webinars/{webinarId}/status¶

PUT /webinars/{webinarId}/status: {
  action?: "end";
};

action?¶

optional action?: "end";

ZoomMeetingsApiOperationRequestBodyRequiredMap¶

Properties¶

DELETE /devices/{deviceId}¶

DELETE /devices/{deviceId}: false;

DELETE /devices/zpa/vendors/{vendor}/mac_addresses/{macAddress}¶

DELETE /devices/zpa/vendors/{vendor}/mac_addresses/{macAddress}: false;

DELETE /h323/devices/{deviceId}¶

DELETE /h323/devices/{deviceId}: false;

DELETE /live_meetings/{meetingId}/chat/messages/{messageId}¶

DELETE /live_meetings/{meetingId}/chat/messages/{messageId}: false;

DELETE /live_webinars/{webinarId}/chat/messages/{messageId}¶

DELETE /live_webinars/{webinarId}/chat/messages/{messageId}: false;

DELETE /meetings/{meetingId}¶

DELETE /meetings/{meetingId}: false;

DELETE /meetings/{meetingId}/meeting_summary¶

DELETE /meetings/{meetingId}/meeting_summary: false;

DELETE /meetings/{meetingId}/open_apps¶

DELETE /meetings/{meetingId}/open_apps: false;

DELETE /meetings/{meetingId}/polls/{pollId}¶

DELETE /meetings/{meetingId}/polls/{pollId}: false;

DELETE /meetings/{meetingId}/recordings¶

DELETE /meetings/{meetingId}/recordings: false;

DELETE /meetings/{meetingId}/recordings/{recordingId}¶

DELETE /meetings/{meetingId}/recordings/{recordingId}: false;

DELETE /meetings/{meetingId}/registrants/{registrantId}¶

DELETE /meetings/{meetingId}/registrants/{registrantId}: false;

DELETE /meetings/{meetingId}/survey¶

DELETE /meetings/{meetingId}/survey: false;

DELETE /meetings/{meetingId}/transcript¶

DELETE /meetings/{meetingId}/transcript: false;

DELETE /past_meetings/{meetingUUID}/archive_files¶

DELETE /past_meetings/{meetingUUID}/archive_files: false;

DELETE /sip_phones/phones/{phoneId}¶

DELETE /sip_phones/phones/{phoneId}: false;

DELETE /tracking_fields/{fieldId}¶

DELETE /tracking_fields/{fieldId}: false;

DELETE /users/{userId}/tsp/{tspId}¶

DELETE /users/{userId}/tsp/{tspId}: false;

DELETE /webinars/{webinarId}¶

DELETE /webinars/{webinarId}: false;

DELETE /webinars/{webinarId}/branding/name_tags¶

DELETE /webinars/{webinarId}/branding/name_tags: false;

DELETE /webinars/{webinarId}/branding/virtual_backgrounds¶

DELETE /webinars/{webinarId}/branding/virtual_backgrounds: false;

DELETE /webinars/{webinarId}/branding/wallpaper¶

DELETE /webinars/{webinarId}/branding/wallpaper: false;

DELETE /webinars/{webinarId}/panelists¶

DELETE /webinars/{webinarId}/panelists: false;

DELETE /webinars/{webinarId}/panelists/{panelistId}¶

DELETE /webinars/{webinarId}/panelists/{panelistId}: false;

DELETE /webinars/{webinarId}/polls/{pollId}¶

DELETE /webinars/{webinarId}/polls/{pollId}: false;

DELETE /webinars/{webinarId}/registrants/{registrantId}¶

DELETE /webinars/{webinarId}/registrants/{registrantId}: false;

DELETE /webinars/{webinarId}/survey¶

DELETE /webinars/{webinarId}/survey: false;

GET /archive_files¶

GET /archive_files: false;

GET /archive_files/statistics¶

GET /archive_files/statistics: false;

GET /devices¶

GET /devices: false;

GET /devices/{deviceId}¶

GET /devices/{deviceId}: false;

GET /devices/groups¶

GET /devices/groups: false;

GET /devices/zpa/settings¶

GET /devices/zpa/settings: false;

GET /devices/zpa/zdm_groups/{zdmGroupId}/versions¶

GET /devices/zpa/zdm_groups/{zdmGroupId}/versions: false;

GET /h323/devices¶

GET /h323/devices: false;

GET /meetings/{meetingId}¶

GET /meetings/{meetingId}: false;

GET /meetings/{meetingId}/invitation¶

GET /meetings/{meetingId}/invitation: false;

GET /meetings/{meetingId}/jointoken/live_streaming¶

GET /meetings/{meetingId}/jointoken/live_streaming: false;

GET /meetings/{meetingId}/jointoken/local_archiving¶

GET /meetings/{meetingId}/jointoken/local_archiving: false;

GET /meetings/{meetingId}/jointoken/local_recording¶

GET /meetings/{meetingId}/jointoken/local_recording: false;

GET /meetings/{meetingId}/livestream¶

GET /meetings/{meetingId}/livestream: false;

GET /meetings/{meetingId}/meeting_summary¶

GET /meetings/{meetingId}/meeting_summary: false;

GET /meetings/{meetingId}/polls¶

GET /meetings/{meetingId}/polls: false;

GET /meetings/{meetingId}/polls/{pollId}¶

GET /meetings/{meetingId}/polls/{pollId}: false;

GET /meetings/{meetingId}/recordings¶

GET /meetings/{meetingId}/recordings: false;

GET /meetings/{meetingId}/recordings/analytics_details¶

GET /meetings/{meetingId}/recordings/analytics_details: false;

GET /meetings/{meetingId}/recordings/analytics_summary¶

GET /meetings/{meetingId}/recordings/analytics_summary: false;

GET /meetings/{meetingId}/recordings/registrants¶

GET /meetings/{meetingId}/recordings/registrants: false;

GET /meetings/{meetingId}/recordings/registrants/questions¶

GET /meetings/{meetingId}/recordings/registrants/questions: false;

GET /meetings/{meetingId}/recordings/settings¶

GET /meetings/{meetingId}/recordings/settings: false;

GET /meetings/{meetingId}/registrants¶

GET /meetings/{meetingId}/registrants: false;

GET /meetings/{meetingId}/registrants/{registrantId}¶

GET /meetings/{meetingId}/registrants/{registrantId}: false;

GET /meetings/{meetingId}/registrants/questions¶

GET /meetings/{meetingId}/registrants/questions: false;

GET /meetings/{meetingId}/survey¶

GET /meetings/{meetingId}/survey: false;

GET /meetings/{meetingId}/token¶

GET /meetings/{meetingId}/token: false;

GET /meetings/{meetingId}/transcript¶

GET /meetings/{meetingId}/transcript: false;

GET /meetings/meeting_summaries¶

GET /meetings/meeting_summaries: false;

GET /past_meetings/{meetingId}¶

GET /past_meetings/{meetingId}: false;

GET /past_meetings/{meetingId}/instances¶

GET /past_meetings/{meetingId}/instances: false;

GET /past_meetings/{meetingId}/participants¶

GET /past_meetings/{meetingId}/participants: false;

GET /past_meetings/{meetingId}/polls¶

GET /past_meetings/{meetingId}/polls: false;

GET /past_meetings/{meetingId}/qa¶

GET /past_meetings/{meetingId}/qa: false;

GET /past_meetings/{meetingUUID}/archive_files¶

GET /past_meetings/{meetingUUID}/archive_files: false;

GET /past_webinars/{webinarId}/absentees¶

GET /past_webinars/{webinarId}/absentees: false;

GET /past_webinars/{webinarId}/instances¶

GET /past_webinars/{webinarId}/instances: false;

GET /past_webinars/{webinarId}/participants¶

GET /past_webinars/{webinarId}/participants: false;

GET /past_webinars/{webinarId}/polls¶

GET /past_webinars/{webinarId}/polls: false;

GET /past_webinars/{webinarId}/qa¶

GET /past_webinars/{webinarId}/qa: false;

GET /report/activities¶

GET /report/activities: false;

GET /report/billing¶

GET /report/billing: false;

GET /report/billing/invoices¶

GET /report/billing/invoices: false;

GET /report/cloud_recording¶

GET /report/cloud_recording: false;

GET /report/daily¶

GET /report/daily: false;

GET /report/disclaimer¶

GET /report/disclaimer: false;

GET /report/history_meetings¶

GET /report/history_meetings: false;

GET /report/meeting_activities¶

GET /report/meeting_activities: false;

GET /report/meetings/{meetingId}¶

GET /report/meetings/{meetingId}: false;

GET /report/meetings/{meetingId}/participants¶

GET /report/meetings/{meetingId}/participants: false;

GET /report/meetings/{meetingId}/polls¶

GET /report/meetings/{meetingId}/polls: false;

GET /report/meetings/{meetingId}/qa¶

GET /report/meetings/{meetingId}/qa: false;

GET /report/meetings/{meetingId}/survey¶

GET /report/meetings/{meetingId}/survey: false;

GET /report/operationlogs¶

GET /report/operationlogs: false;

GET /report/remote_support¶

GET /report/remote_support: false;

GET /report/telephone¶

GET /report/telephone: false;

GET /report/upcoming_events¶

GET /report/upcoming_events: false;

GET /report/users¶

GET /report/users: false;

GET /report/users/{userId}/meetings¶

GET /report/users/{userId}/meetings: false;

GET /report/webinars/{webinarId}¶

GET /report/webinars/{webinarId}: false;

GET /report/webinars/{webinarId}/participants¶

GET /report/webinars/{webinarId}/participants: false;

GET /report/webinars/{webinarId}/polls¶

GET /report/webinars/{webinarId}/polls: false;

GET /report/webinars/{webinarId}/qa¶

GET /report/webinars/{webinarId}/qa: false;

GET /report/webinars/{webinarId}/survey¶

GET /report/webinars/{webinarId}/survey: false;

GET /sip_phones/phones¶

GET /sip_phones/phones: false;

GET /tracking_fields¶

GET /tracking_fields: false;

GET /tracking_fields/{fieldId}¶

GET /tracking_fields/{fieldId}: false;

GET /tsp¶

GET /tsp: false;

GET /users/{userId}/meeting_templates¶

GET /users/{userId}/meeting_templates: false;

GET /users/{userId}/meetings¶

GET /users/{userId}/meetings: false;

GET /users/{userId}/pac¶

GET /users/{userId}/pac: false;

GET /users/{userId}/recordings¶

GET /users/{userId}/recordings: false;

GET /users/{userId}/tsp¶

GET /users/{userId}/tsp: false;

GET /users/{userId}/tsp/{tspId}¶

GET /users/{userId}/tsp/{tspId}: false;

GET /users/{userId}/upcoming_meetings¶

GET /users/{userId}/upcoming_meetings: false;

GET /users/{userId}/webinar_templates¶

GET /users/{userId}/webinar_templates: false;

GET /users/{userId}/webinars¶

GET /users/{userId}/webinars: false;

GET /webinars/{webinarId}¶

GET /webinars/{webinarId}: false;

GET /webinars/{webinarId}/branding¶

GET /webinars/{webinarId}/branding: false;

GET /webinars/{webinarId}/jointoken/live_streaming¶

GET /webinars/{webinarId}/jointoken/live_streaming: false;

GET /webinars/{webinarId}/jointoken/local_archiving¶

GET /webinars/{webinarId}/jointoken/local_archiving: false;

GET /webinars/{webinarId}/jointoken/local_recording¶

GET /webinars/{webinarId}/jointoken/local_recording: false;

GET /webinars/{webinarId}/livestream¶

GET /webinars/{webinarId}/livestream: false;

GET /webinars/{webinarId}/panelists¶

GET /webinars/{webinarId}/panelists: false;

GET /webinars/{webinarId}/polls¶

GET /webinars/{webinarId}/polls: false;

GET /webinars/{webinarId}/polls/{pollId}¶

GET /webinars/{webinarId}/polls/{pollId}: false;

GET /webinars/{webinarId}/registrants¶

GET /webinars/{webinarId}/registrants: false;

GET /webinars/{webinarId}/registrants/{registrantId}¶

GET /webinars/{webinarId}/registrants/{registrantId}: false;

GET /webinars/{webinarId}/registrants/questions¶

GET /webinars/{webinarId}/registrants/questions: false;

GET /webinars/{webinarId}/survey¶

GET /webinars/{webinarId}/survey: false;

GET /webinars/{webinarId}/token¶

GET /webinars/{webinarId}/token: false;

GET /webinars/{webinarId}/tracking_sources¶

GET /webinars/{webinarId}/tracking_sources: false;

PATCH /archive_files/{fileId}¶

PATCH /archive_files/{fileId}: false;

PATCH /devices/{deviceId}¶

PATCH /devices/{deviceId}: false;

PATCH /devices/{deviceId}/assign_group¶

PATCH /devices/{deviceId}/assign_group: false;

PATCH /devices/{deviceId}/assignment¶

PATCH /devices/{deviceId}/assignment: false;

PATCH /h323/devices/{deviceId}¶

PATCH /h323/devices/{deviceId}: false;

PATCH /live_meetings/{meetingId}/chat/messages/{messageId}¶

PATCH /live_meetings/{meetingId}/chat/messages/{messageId}: false;

PATCH /live_meetings/{meetingId}/events¶

PATCH /live_meetings/{meetingId}/events: false;

PATCH /live_meetings/{meetingId}/rtms_app/status¶

PATCH /live_meetings/{meetingId}/rtms_app/status: false;

PATCH /meetings/{meetingId}¶

PATCH /meetings/{meetingId}: false;

PATCH /meetings/{meetingId}/livestream¶

PATCH /meetings/{meetingId}/livestream: false;

PATCH /meetings/{meetingId}/livestream/status¶

PATCH /meetings/{meetingId}/livestream/status: false;

PATCH /meetings/{meetingId}/recordings/registrants/questions¶

PATCH /meetings/{meetingId}/recordings/registrants/questions: false;

PATCH /meetings/{meetingId}/recordings/settings¶

PATCH /meetings/{meetingId}/recordings/settings: false;

PATCH /meetings/{meetingId}/registrants/questions¶

PATCH /meetings/{meetingId}/registrants/questions: false;

PATCH /meetings/{meetingId}/survey¶

PATCH /meetings/{meetingId}/survey: false;

PATCH /sip_phones/phones/{phoneId}¶

PATCH /sip_phones/phones/{phoneId}: false;

PATCH /tracking_fields/{fieldId}¶

PATCH /tracking_fields/{fieldId}: false;

PATCH /tsp¶

PATCH /tsp: false;

PATCH /users/{userId}/tsp/{tspId}¶

PATCH /users/{userId}/tsp/{tspId}: false;

PATCH /users/{userId}/tsp/settings¶

PATCH /users/{userId}/tsp/settings: false;

PATCH /webinars/{webinarId}¶

PATCH /webinars/{webinarId}: false;

PATCH /webinars/{webinarId}/branding/name_tags/{nameTagId}¶

PATCH /webinars/{webinarId}/branding/name_tags/{nameTagId}: false;

PATCH /webinars/{webinarId}/branding/virtual_backgrounds¶

PATCH /webinars/{webinarId}/branding/virtual_backgrounds: false;

PATCH /webinars/{webinarId}/livestream¶

PATCH /webinars/{webinarId}/livestream: false;

PATCH /webinars/{webinarId}/livestream/status¶

PATCH /webinars/{webinarId}/livestream/status: false;

PATCH /webinars/{webinarId}/registrants/questions¶

PATCH /webinars/{webinarId}/registrants/questions: false;

PATCH /webinars/{webinarId}/survey¶

PATCH /webinars/{webinarId}/survey: false;

POST /devices¶

POST /devices: false;

POST /devices/zpa/assignment¶

POST /devices/zpa/assignment: false;

POST /devices/zpa/upgrade¶

POST /devices/zpa/upgrade: false;

POST /h323/devices¶

POST /h323/devices: false;

POST /meetings/{meetingId}/batch_polls¶

POST /meetings/{meetingId}/batch_polls: false;

POST /meetings/{meetingId}/batch_registrants¶

POST /meetings/{meetingId}/batch_registrants: false;

POST /meetings/{meetingId}/invite_links¶

POST /meetings/{meetingId}/invite_links: false;

POST /meetings/{meetingId}/open_apps¶

POST /meetings/{meetingId}/open_apps: false;

POST /meetings/{meetingId}/polls¶

POST /meetings/{meetingId}/polls: false;

POST /meetings/{meetingId}/recordings/registrants¶

POST /meetings/{meetingId}/recordings/registrants: false;

POST /meetings/{meetingId}/registrants¶

POST /meetings/{meetingId}/registrants: false;

POST /meetings/{meetingId}/sip_dialing¶

POST /meetings/{meetingId}/sip_dialing: false;

POST /sip_phones/phones¶

POST /sip_phones/phones: false;

POST /tracking_fields¶

POST /tracking_fields: false;

POST /users/{userId}/meeting_templates¶

POST /users/{userId}/meeting_templates: false;

POST /users/{userId}/meetings¶

POST /users/{userId}/meetings: false;

POST /users/{userId}/tsp¶

POST /users/{userId}/tsp: false;

POST /users/{userId}/webinar_templates¶

POST /users/{userId}/webinar_templates: false;

POST /users/{userId}/webinars¶

POST /users/{userId}/webinars: false;

POST /webinars/{webinarId}/batch_registrants¶

POST /webinars/{webinarId}/batch_registrants: false;

POST /webinars/{webinarId}/branding/name_tags¶

POST /webinars/{webinarId}/branding/name_tags: false;

POST /webinars/{webinarId}/branding/virtual_backgrounds¶

POST /webinars/{webinarId}/branding/virtual_backgrounds: false;

POST /webinars/{webinarId}/branding/wallpaper¶

POST /webinars/{webinarId}/branding/wallpaper: false;

POST /webinars/{webinarId}/invite_links¶

POST /webinars/{webinarId}/invite_links: false;

POST /webinars/{webinarId}/panelists¶

POST /webinars/{webinarId}/panelists: false;

POST /webinars/{webinarId}/polls¶

POST /webinars/{webinarId}/polls: false;

POST /webinars/{webinarId}/registrants¶

POST /webinars/{webinarId}/registrants: false;

POST /webinars/{webinarId}/sip_dialing¶

POST /webinars/{webinarId}/sip_dialing: false;

PUT /meetings/{meetingId}/polls/{pollId}¶

PUT /meetings/{meetingId}/polls/{pollId}: false;

PUT /meetings/{meetingId}/recordings/{recordingId}/status¶

PUT /meetings/{meetingId}/recordings/{recordingId}/status: false;

PUT /meetings/{meetingId}/recordings/registrants/status¶

PUT /meetings/{meetingId}/recordings/registrants/status: false;

PUT /meetings/{meetingId}/registrants/status¶

PUT /meetings/{meetingId}/registrants/status: false;

PUT /meetings/{meetingId}/status¶

PUT /meetings/{meetingId}/status: false;

PUT /meetings/{meetingUUID}/recordings/status¶

PUT /meetings/{meetingUUID}/recordings/status: false;

PUT /webinars/{webinarId}/polls/{pollId}¶

PUT /webinars/{webinarId}/polls/{pollId}: false;

PUT /webinars/{webinarId}/registrants/status¶

PUT /webinars/{webinarId}/registrants/status: false;

PUT /webinars/{webinarId}/status¶

PUT /webinars/{webinarId}/status: false;

ZoomMeetingsApiOperationResponseMap¶

Properties¶

DELETE /devices/{deviceId}¶

DELETE /devices/{deviceId}: void;

DELETE /devices/zpa/vendors/{vendor}/mac_addresses/{macAddress}¶

DELETE /devices/zpa/vendors/{vendor}/mac_addresses/{macAddress}: void;

DELETE /h323/devices/{deviceId}¶

DELETE /h323/devices/{deviceId}: void;

DELETE /live_meetings/{meetingId}/chat/messages/{messageId}¶

DELETE /live_meetings/{meetingId}/chat/messages/{messageId}: void;

DELETE /live_webinars/{webinarId}/chat/messages/{messageId}¶

DELETE /live_webinars/{webinarId}/chat/messages/{messageId}: void;

DELETE /meetings/{meetingId}¶

DELETE /meetings/{meetingId}: void;

DELETE /meetings/{meetingId}/meeting_summary¶

DELETE /meetings/{meetingId}/meeting_summary: void;

DELETE /meetings/{meetingId}/open_apps¶

DELETE /meetings/{meetingId}/open_apps: void;

DELETE /meetings/{meetingId}/polls/{pollId}¶

DELETE /meetings/{meetingId}/polls/{pollId}: void;

DELETE /meetings/{meetingId}/recordings¶

DELETE /meetings/{meetingId}/recordings: void;

DELETE /meetings/{meetingId}/recordings/{recordingId}¶

DELETE /meetings/{meetingId}/recordings/{recordingId}: void;

DELETE /meetings/{meetingId}/registrants/{registrantId}¶

DELETE /meetings/{meetingId}/registrants/{registrantId}: void;

DELETE /meetings/{meetingId}/survey¶

DELETE /meetings/{meetingId}/survey: void;

DELETE /meetings/{meetingId}/transcript¶

DELETE /meetings/{meetingId}/transcript: void;

DELETE /past_meetings/{meetingUUID}/archive_files¶

DELETE /past_meetings/{meetingUUID}/archive_files: void;

DELETE /sip_phones/phones/{phoneId}¶

DELETE /sip_phones/phones/{phoneId}: void;

DELETE /tracking_fields/{fieldId}¶

DELETE /tracking_fields/{fieldId}: void;

DELETE /users/{userId}/tsp/{tspId}¶

DELETE /users/{userId}/tsp/{tspId}: void;

DELETE /webinars/{webinarId}¶

DELETE /webinars/{webinarId}: void;

DELETE /webinars/{webinarId}/branding/name_tags¶

DELETE /webinars/{webinarId}/branding/name_tags: void;

DELETE /webinars/{webinarId}/branding/virtual_backgrounds¶

DELETE /webinars/{webinarId}/branding/virtual_backgrounds: void;

DELETE /webinars/{webinarId}/branding/wallpaper¶

DELETE /webinars/{webinarId}/branding/wallpaper: void;

DELETE /webinars/{webinarId}/panelists¶

DELETE /webinars/{webinarId}/panelists: void;

DELETE /webinars/{webinarId}/panelists/{panelistId}¶

DELETE /webinars/{webinarId}/panelists/{panelistId}: void;

DELETE /webinars/{webinarId}/polls/{pollId}¶

DELETE /webinars/{webinarId}/polls/{pollId}: void;

DELETE /webinars/{webinarId}/registrants/{registrantId}¶

DELETE /webinars/{webinarId}/registrants/{registrantId}: void;

DELETE /webinars/{webinarId}/survey¶

DELETE /webinars/{webinarId}/survey: void;

GET /archive_files¶

GET /archive_files: {
  from?: string;
  meetings?: readonly {
     account_name: string;
     archive_files: readonly {
        auto_delete?: boolean;
        download_url: string;
        encryption_fingerprint: string;
        file_extension: string;
        file_path?: string;
        file_size: number;
        file_type:   | "MP4"
           | "M4A"
           | "CHAT"
           | "CC"
           | "CHAT_MESSAGE"
           | "TRANSCRIPT"
           | "SUB_GROUP_MEMBER_LOG"
           | "AIC_COVERSATION";
        id: string;
        individual: boolean;
        number_of_messages?: number;
        participant_email?: string;
        participant_join_time: string;
        participant_leave_time: string;
        recording_type:   | "shared_screen_with_speaker_view"
           | "audio_only"
           | "chat_file"
           | "closed_caption"
           | "chat_message"
           | "audio_transcript"
           | "aic_conversation";
        status: "failed" | "completed" | "processing";
        storage_location?: "US" | "AU" | "BR" | "CA" | "EU" | "IN" | "JP" | "SG" | "CH";
     }[];
     complete_time:   | {
      }
        | "";
     duration: number;
     duration_in_second: number;
     group_id?: string;
     host_id: string;
     id: number;
     is_breakout_room: boolean;
     meeting_type: "internal" | "external";
     parent_meeting_id?: string;
     physical_files?: readonly {
        download_url?: string;
        file_id?: string;
        file_name?: string;
        file_size?: number;
     }[];
     recording_count: number;
     start_time: string;
     status: "completed" | "processing";
     timezone: string;
     topic: string;
     total_size: number;
     type: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 100;
     uuid: string;
  }[];
  next_page_token?: string;
  page_size?: number;
  to?: string;
  total_records?: number;
};

from?¶

optional from?: string;

meetings?¶

optional meetings?: readonly {
  account_name: string;
  archive_files: readonly {
     auto_delete?: boolean;
     download_url: string;
     encryption_fingerprint: string;
     file_extension: string;
     file_path?: string;
     file_size: number;
     file_type:   | "MP4"
        | "M4A"
        | "CHAT"
        | "CC"
        | "CHAT_MESSAGE"
        | "TRANSCRIPT"
        | "SUB_GROUP_MEMBER_LOG"
        | "AIC_COVERSATION";
     id: string;
     individual: boolean;
     number_of_messages?: number;
     participant_email?: string;
     participant_join_time: string;
     participant_leave_time: string;
     recording_type:   | "shared_screen_with_speaker_view"
        | "audio_only"
        | "chat_file"
        | "closed_caption"
        | "chat_message"
        | "audio_transcript"
        | "aic_conversation";
     status: "failed" | "completed" | "processing";
     storage_location?: "US" | "AU" | "BR" | "CA" | "EU" | "IN" | "JP" | "SG" | "CH";
  }[];
  complete_time:   | {
   }
     | "";
  duration: number;
  duration_in_second: number;
  group_id?: string;
  host_id: string;
  id: number;
  is_breakout_room: boolean;
  meeting_type: "internal" | "external";
  parent_meeting_id?: string;
  physical_files?: readonly {
     download_url?: string;
     file_id?: string;
     file_name?: string;
     file_size?: number;
  }[];
  recording_count: number;
  start_time: string;
  status: "completed" | "processing";
  timezone: string;
  topic: string;
  total_size: number;
  type: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 100;
  uuid: string;
}[];

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

to?¶

optional to?: string;

total_records?¶

optional total_records?: number;

GET /archive_files/statistics¶

GET /archive_files/statistics: {
  from?: string;
  statistic_by_file_extension?: {
     json_file_count?: number;
     m4a_file_count?: number;
     mp4_file_count?: number;
     txt_file_count?: number;
     vtt_file_count?: number;
  };
  statistic_by_file_status?: {
     completed_file_count?: number;
     failed_file_count?: number;
     processing_file_count?: number;
  };
  to?: string;
  total_records?: number;
};

from?¶

optional from?: string;

statistic_by_file_extension?¶

optional statistic_by_file_extension?: {
  json_file_count?: number;
  m4a_file_count?: number;
  mp4_file_count?: number;
  txt_file_count?: number;
  vtt_file_count?: number;
};

statistic_by_file_extension.json_file_count?¶

optional json_file_count?: number;

statistic_by_file_extension.m4a_file_count?¶

optional m4a_file_count?: number;

statistic_by_file_extension.mp4_file_count?¶

optional mp4_file_count?: number;

statistic_by_file_extension.txt_file_count?¶

optional txt_file_count?: number;

statistic_by_file_extension.vtt_file_count?¶

optional vtt_file_count?: number;

statistic_by_file_status?¶

optional statistic_by_file_status?: {
  completed_file_count?: number;
  failed_file_count?: number;
  processing_file_count?: number;
};

statistic_by_file_status.completed_file_count?¶

optional completed_file_count?: number;

statistic_by_file_status.failed_file_count?¶

optional failed_file_count?: number;

statistic_by_file_status.processing_file_count?¶

optional processing_file_count?: number;

to?¶

optional to?: string;

total_records?¶

optional total_records?: number;

GET /devices¶

GET /devices: {
  devices?: readonly {
     app_version?: string;
     connected_to_zdm?: boolean;
     device_id?: string;
     device_name?: string;
     device_status?: -1 | 0 | 1;
     device_type?: 0 | 1 | 2 | 3 | 4 | 5 | 6;
     enrolled_in_zdm?: boolean;
     last_online?: string;
     mac_address?: string;
     model?: string;
     platform_os?: string;
     room_id?: string;
     room_name?: string;
     serial_number?: string;
     skd_version?: string;
     tag?: string;
     user_email?: string;
     vendor?: string;
  }[];
  next_page_token?: string;
  page_size?: number;
};

devices?¶

optional devices?: readonly {
  app_version?: string;
  connected_to_zdm?: boolean;
  device_id?: string;
  device_name?: string;
  device_status?: -1 | 0 | 1;
  device_type?: 0 | 1 | 2 | 3 | 4 | 5 | 6;
  enrolled_in_zdm?: boolean;
  last_online?: string;
  mac_address?: string;
  model?: string;
  platform_os?: string;
  room_id?: string;
  room_name?: string;
  serial_number?: string;
  skd_version?: string;
  tag?: string;
  user_email?: string;
  vendor?: string;
}[];

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

GET /devices/{deviceId}¶

GET /devices/{deviceId}: {
  app_version?: string;
  connected_to_zdm?: boolean;
  device_id?: string;
  device_name?: string;
  device_status?: -1 | 0 | 1;
  device_type?: 0 | 1 | 2 | 3 | 4 | 5 | 6;
  enrolled_in_zdm?: boolean;
  last_online?: string;
  mac_address?: string;
  model?: string;
  platform_os?: string;
  room_id?: string;
  room_name?: string;
  sdk_version?: string;
  serial_number?: string;
  tag?: string;
  user_email?: string;
  vendor?: string;
};

app_version?¶

optional app_version?: string;

connected_to_zdm?¶

optional connected_to_zdm?: boolean;

device_id?¶

optional device_id?: string;

device_name?¶

optional device_name?: string;

device_status?¶

optional device_status?: -1 | 0 | 1;

device_type?¶

optional device_type?: 0 | 1 | 2 | 3 | 4 | 5 | 6;

enrolled_in_zdm?¶

optional enrolled_in_zdm?: boolean;

last_online?¶

optional last_online?: string;

mac_address?¶

optional mac_address?: string;

model?¶

optional model?: string;

platform_os?¶

optional platform_os?: string;

room_id?¶

optional room_id?: string;

room_name?¶

optional room_name?: string;

sdk_version?¶

optional sdk_version?: string;

serial_number?¶

optional serial_number?: string;

tag?¶

optional tag?: string;

user_email?¶

optional user_email?: string;

vendor?¶

optional vendor?: string;

GET /devices/groups¶

GET /devices/groups: {
  groups?: readonly {
     description?: string;
     name?: string;
     zdm_group_id?: string;
  }[];
  next_page_token?: string;
  page_size?: number;
};

groups?¶

optional groups?: readonly {
  description?: string;
  name?: string;
  zdm_group_id?: string;
}[];

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

GET /devices/zpa/settings¶

GET /devices/zpa/settings: {
  device_infos?: readonly {
     device_id?: string;
     device_type?: string;
     model?: string;
     policy?: {
        call_control?: {
           status?: "unsupported" | "on" | "off";
        };
        hot_desking?: {
           status?: "online" | "offline";
        };
     };
     status?: "online" | "offline";
     vendor?: string;
  }[];
  language?: string;
  timezone?: string;
};

device_infos?¶

optional device_infos?: readonly {
  device_id?: string;
  device_type?: string;
  model?: string;
  policy?: {
     call_control?: {
        status?: "unsupported" | "on" | "off";
     };
     hot_desking?: {
        status?: "online" | "offline";
     };
  };
  status?: "online" | "offline";
  vendor?: string;
}[];

language?¶

optional language?: string;

timezone?¶

optional timezone?: string;

GET /devices/zpa/zdm_groups/{zdmGroupId}/versions¶

GET /devices/zpa/zdm_groups/{zdmGroupId}/versions: {
  app_versions?: readonly string[];
  firmware_versions?: readonly {
     model?: string;
     vendor?: string;
     version?: string;
     warn_info?: string;
  }[];
};

app_versions?¶

optional app_versions?: readonly string[];

firmware_versions?¶

optional firmware_versions?: readonly {
  model?: string;
  vendor?: string;
  version?: string;
  warn_info?: string;
}[];

GET /h323/devices¶

GET /h323/devices: {
  next_page_token?: string;
  page_count?: number;
  page_number?: number;
  page_size?: number;
  total_records?: number;
} & {
  devices?: readonly {
     id?: string;
   } & {
     encryption: "auto" | "yes" | "no";
     ip: string;
     name: string;
     protocol: "H.323" | "SIP";
  }[];
};

Type Declaration¶

next_page_token?¶

optional next_page_token?: string;

page_count?¶

optional page_count?: number;

page_number?¶

optional page_number?: number;

page_size?¶

optional page_size?: number;

total_records?¶

optional total_records?: number;

Type Declaration¶

devices?¶

optional devices?: readonly {
  id?: string;
} & {
  encryption: "auto" | "yes" | "no";
  ip: string;
  name: string;
  protocol: "H.323" | "SIP";
}[];

GET /meetings/{meetingId}¶

GET /meetings/{meetingId}: {
  agenda?: string;
  assistant_id?: string;
  chat_join_url?: string;
  created_at?: string;
  creation_source?: "other" | "open_api" | "web_portal";
  duration?: number;
  dynamic_host_key?: string;
  encrypted_password?: string;
  h323_password?: string;
  host_email?: string;
  host_id?: string;
  id?: number;
  join_url?: string;
  occurrences?: readonly {
     duration?: number;
     occurrence_id?: string;
     start_time?: string;
     status?: "available" | "deleted";
  }[];
  password?: string;
  pmi?: string;
  pre_schedule?: boolean;
  pstn_password?: string;
  recurrence?: {
     end_date_time?: string;
     end_times?: number;
     monthly_day?: number;
     monthly_week?: -1 | 1 | 2 | 3 | 4;
     monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
     repeat_interval?: number;
     type: 1 | 2 | 3;
     weekly_days?: "2" | "1" | "3" | "4" | "5" | "6" | "7";
  };
  registration_url?: string;
  settings?: {
     additional_data_center_regions?: readonly string[];
     allow_host_control_participant_mute_state?: boolean;
     allow_multiple_devices?: boolean;
     alternative_host_manage_cloud_recording?: boolean;
     alternative_host_manage_meeting_summary?: boolean;
     alternative_host_update_polls?: boolean;
     alternative_hosts?: string;
     alternative_hosts_email_notification?: boolean;
     approval_type?: 0 | 1 | 2;
     approved_or_denied_countries_or_regions?: {
        approved_list?: readonly string[];
        denied_list?: readonly string[];
        enable?: boolean;
        method?: "approve" | "deny";
     };
     audio?: "both" | "telephony" | "voip" | "thirdParty";
     audio_conference_info?: string;
     authentication_domains?: string;
     authentication_exception?: readonly {
        email?: string;
        join_url?: string;
        name?: string;
     }[];
     authentication_name?: string;
     authentication_option?: string;
     auto_add_recording_to_video_management?: {
        channels?: readonly {
           channel_id: string;
           name?: string;
        }[];
        enable: boolean;
     };
     auto_recording?: "none" | "local" | "cloud";
     auto_start_ai_companion_questions?: boolean;
     auto_start_meeting_summary?: boolean;
     breakout_room?: {
        enable?: boolean;
        rooms?: readonly {
           name?: string;
           participants?: readonly string[];
        }[];
     };
     calendar_type?: 1 | 2;
     close_registration?: boolean;
     cn_meeting?: boolean;
     contact_email?: string;
     contact_name?: string;
     continuous_meeting_chat?: {
        auto_add_invited_external_users?: boolean;
        auto_add_meeting_participants?: boolean;
        channel_id?: string;
        enable?: boolean;
     };
     custom_keys?: readonly {
        key?: string;
        value?: string;
     }[];
     device_testing?: boolean;
     disable_participant_video?: boolean;
     email_in_attendee_report?: boolean;
     email_notification?: boolean;
     encryption_type?: "enhanced_encryption" | "e2ee";
     enforce_login?: boolean;
     enforce_login_domains?: string;
     focus_mode?: boolean;
     global_dial_in_countries?: readonly string[];
     global_dial_in_numbers?: readonly {
        city?: string;
        country?: string;
        country_name?: string;
        number?: string;
        type?: "toll" | "tollfree";
     }[];
     host_save_video_order?: boolean;
     host_video?: boolean;
     in_meeting?: boolean;
     internal_meeting?: boolean;
     jbh_time?: 0 | 5 | 10 | 15;
     join_before_host?: boolean;
     language_interpretation?: {
        enable?: boolean;
        interpreters?: readonly {
           email?: string;
           interpreter_languages?: string;
           languages?: string;
        }[];
     };
     meeting_authentication?: boolean;
     meeting_invitees?: readonly {
        email?: string;
        internal_user?: boolean;
     }[];
     mute_upon_entry?: boolean;
     participant_focused_meeting?: boolean;
     participant_video?: boolean;
     private_meeting?: boolean;
     push_change_to_calendar?: boolean;
     question_and_answer?: {
        allow_anonymous_questions?: boolean;
        allow_submit_questions?: boolean;
        attendees_can_comment?: boolean;
        attendees_can_upvote?: boolean;
        enable?: boolean;
        question_visibility?: "all" | "answered";
     };
     registrants_confirmation_email?: boolean;
     registrants_email_notification?: boolean;
     registration_type?: 1 | 2 | 3;
     request_permission_to_unmute_participants?: boolean;
     resources?: readonly {
        permission_level?: "editor" | "commenter" | "viewer";
        resource_id?: string;
        resource_type?: "whiteboard";
     }[];
     show_join_info?: boolean;
     show_share_button?: boolean;
     sign_language_interpretation?: {
        enable?: boolean;
        interpreters?: readonly {
           email?: string;
           sign_language?: string;
        }[];
     };
     summary_template_id?: string;
     use_pmi?: boolean;
     waiting_room?: boolean;
     waiting_room_options?: {
        mode: "custom" | "follow_setting";
        who_goes_to_waiting_room?:   | "everyone"
           | "users_not_in_account"
           | "users_not_in_account_or_whitelisted_domains"
           | "users_not_on_invite"
           | "users_not_in_org";
     };
     watermark?: boolean;
     who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;
     who_will_receive_summary?: 1 | 2 | 3 | 4;
  };
  start_time?: string;
  start_url?: string;
  status?: "started" | "waiting";
  template_id?: string;
  timezone?: string;
  topic?: string;
  tracking_fields?: readonly {
     field?: string;
     value?: string;
     visible?: boolean;
  }[];
  type?: 1 | 2 | 3 | 4 | 8 | 10;
  uuid?: string;
};

agenda?¶

optional agenda?: string;

assistant_id?¶

optional assistant_id?: string;

chat_join_url?¶

optional chat_join_url?: string;

created_at?¶

optional created_at?: string;

creation_source?¶

optional creation_source?: "other" | "open_api" | "web_portal";

duration?¶

optional duration?: number;

dynamic_host_key?¶

optional dynamic_host_key?: string;

encrypted_password?¶

optional encrypted_password?: string;

h323_password?¶

optional h323_password?: string;

host_email?¶

optional host_email?: string;

host_id?¶

optional host_id?: string;

id?¶

optional id?: number;

join_url?¶

optional join_url?: string;

occurrences?¶

optional occurrences?: readonly {
  duration?: number;
  occurrence_id?: string;
  start_time?: string;
  status?: "available" | "deleted";
}[];

password?¶

optional password?: string;

pmi?¶

optional pmi?: string;

pre_schedule?¶

optional pre_schedule?: boolean;

pstn_password?¶

optional pstn_password?: string;

recurrence?¶

optional recurrence?: {
  end_date_time?: string;
  end_times?: number;
  monthly_day?: number;
  monthly_week?: -1 | 1 | 2 | 3 | 4;
  monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
  repeat_interval?: number;
  type: 1 | 2 | 3;
  weekly_days?: "2" | "1" | "3" | "4" | "5" | "6" | "7";
};

recurrence.end_date_time?¶

optional end_date_time?: string;

recurrence.end_times?¶

optional end_times?: number;

recurrence.monthly_day?¶

optional monthly_day?: number;

recurrence.monthly_week?¶

optional monthly_week?: -1 | 1 | 2 | 3 | 4;

recurrence.monthly_week_day?¶

optional monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;

recurrence.repeat_interval?¶

optional repeat_interval?: number;

recurrence.type¶

type: 1 | 2 | 3;

recurrence.weekly_days?¶

optional weekly_days?: "2" | "1" | "3" | "4" | "5" | "6" | "7";

registration_url?¶

optional registration_url?: string;

settings?¶

optional settings?: {
  additional_data_center_regions?: readonly string[];
  allow_host_control_participant_mute_state?: boolean;
  allow_multiple_devices?: boolean;
  alternative_host_manage_cloud_recording?: boolean;
  alternative_host_manage_meeting_summary?: boolean;
  alternative_host_update_polls?: boolean;
  alternative_hosts?: string;
  alternative_hosts_email_notification?: boolean;
  approval_type?: 0 | 1 | 2;
  approved_or_denied_countries_or_regions?: {
     approved_list?: readonly string[];
     denied_list?: readonly string[];
     enable?: boolean;
     method?: "approve" | "deny";
  };
  audio?: "both" | "telephony" | "voip" | "thirdParty";
  audio_conference_info?: string;
  authentication_domains?: string;
  authentication_exception?: readonly {
     email?: string;
     join_url?: string;
     name?: string;
  }[];
  authentication_name?: string;
  authentication_option?: string;
  auto_add_recording_to_video_management?: {
     channels?: readonly {
        channel_id: string;
        name?: string;
     }[];
     enable: boolean;
  };
  auto_recording?: "none" | "local" | "cloud";
  auto_start_ai_companion_questions?: boolean;
  auto_start_meeting_summary?: boolean;
  breakout_room?: {
     enable?: boolean;
     rooms?: readonly {
        name?: string;
        participants?: readonly string[];
     }[];
  };
  calendar_type?: 1 | 2;
  close_registration?: boolean;
  cn_meeting?: boolean;
  contact_email?: string;
  contact_name?: string;
  continuous_meeting_chat?: {
     auto_add_invited_external_users?: boolean;
     auto_add_meeting_participants?: boolean;
     channel_id?: string;
     enable?: boolean;
  };
  custom_keys?: readonly {
     key?: string;
     value?: string;
  }[];
  device_testing?: boolean;
  disable_participant_video?: boolean;
  email_in_attendee_report?: boolean;
  email_notification?: boolean;
  encryption_type?: "enhanced_encryption" | "e2ee";
  enforce_login?: boolean;
  enforce_login_domains?: string;
  focus_mode?: boolean;
  global_dial_in_countries?: readonly string[];
  global_dial_in_numbers?: readonly {
     city?: string;
     country?: string;
     country_name?: string;
     number?: string;
     type?: "toll" | "tollfree";
  }[];
  host_save_video_order?: boolean;
  host_video?: boolean;
  in_meeting?: boolean;
  internal_meeting?: boolean;
  jbh_time?: 0 | 5 | 10 | 15;
  join_before_host?: boolean;
  language_interpretation?: {
     enable?: boolean;
     interpreters?: readonly {
        email?: string;
        interpreter_languages?: string;
        languages?: string;
     }[];
  };
  meeting_authentication?: boolean;
  meeting_invitees?: readonly {
     email?: string;
     internal_user?: boolean;
  }[];
  mute_upon_entry?: boolean;
  participant_focused_meeting?: boolean;
  participant_video?: boolean;
  private_meeting?: boolean;
  push_change_to_calendar?: boolean;
  question_and_answer?: {
     allow_anonymous_questions?: boolean;
     allow_submit_questions?: boolean;
     attendees_can_comment?: boolean;
     attendees_can_upvote?: boolean;
     enable?: boolean;
     question_visibility?: "all" | "answered";
  };
  registrants_confirmation_email?: boolean;
  registrants_email_notification?: boolean;
  registration_type?: 1 | 2 | 3;
  request_permission_to_unmute_participants?: boolean;
  resources?: readonly {
     permission_level?: "editor" | "commenter" | "viewer";
     resource_id?: string;
     resource_type?: "whiteboard";
  }[];
  show_join_info?: boolean;
  show_share_button?: boolean;
  sign_language_interpretation?: {
     enable?: boolean;
     interpreters?: readonly {
        email?: string;
        sign_language?: string;
     }[];
  };
  summary_template_id?: string;
  use_pmi?: boolean;
  waiting_room?: boolean;
  waiting_room_options?: {
     mode: "custom" | "follow_setting";
     who_goes_to_waiting_room?:   | "everyone"
        | "users_not_in_account"
        | "users_not_in_account_or_whitelisted_domains"
        | "users_not_on_invite"
        | "users_not_in_org";
  };
  watermark?: boolean;
  who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;
  who_will_receive_summary?: 1 | 2 | 3 | 4;
};

settings.additional_data_center_regions?¶

optional additional_data_center_regions?: readonly string[];

settings.allow_host_control_participant_mute_state?¶

optional allow_host_control_participant_mute_state?: boolean;

settings.allow_multiple_devices?¶

optional allow_multiple_devices?: boolean;

settings.alternative_host_manage_cloud_recording?¶

optional alternative_host_manage_cloud_recording?: boolean;

settings.alternative_host_manage_meeting_summary?¶

optional alternative_host_manage_meeting_summary?: boolean;

settings.alternative_host_update_polls?¶

optional alternative_host_update_polls?: boolean;

settings.alternative_hosts?¶

optional alternative_hosts?: string;

settings.alternative_hosts_email_notification?¶

optional alternative_hosts_email_notification?: boolean;

settings.approval_type?¶

optional approval_type?: 0 | 1 | 2;

settings.approved_or_denied_countries_or_regions?¶

optional approved_or_denied_countries_or_regions?: {
  approved_list?: readonly string[];
  denied_list?: readonly string[];
  enable?: boolean;
  method?: "approve" | "deny";
};

settings.approved_or_denied_countries_or_regions.approved_list?¶

optional approved_list?: readonly string[];

settings.approved_or_denied_countries_or_regions.denied_list?¶

optional denied_list?: readonly string[];

settings.approved_or_denied_countries_or_regions.enable?¶

optional enable?: boolean;

settings.approved_or_denied_countries_or_regions.method?¶

optional method?: "approve" | "deny";

settings.audio?¶

optional audio?: "both" | "telephony" | "voip" | "thirdParty";

settings.audio_conference_info?¶

optional audio_conference_info?: string;

settings.authentication_domains?¶

optional authentication_domains?: string;

settings.authentication_exception?¶

optional authentication_exception?: readonly {
  email?: string;
  join_url?: string;
  name?: string;
}[];

settings.authentication_name?¶

optional authentication_name?: string;

settings.authentication_option?¶

optional authentication_option?: string;

settings.auto_add_recording_to_video_management?¶

optional auto_add_recording_to_video_management?: {
  channels?: readonly {
     channel_id: string;
     name?: string;
  }[];
  enable: boolean;
};

settings.auto_add_recording_to_video_management.channels?¶

optional channels?: readonly {
  channel_id: string;
  name?: string;
}[];

settings.auto_add_recording_to_video_management.enable¶

enable: boolean;

settings.auto_recording?¶

optional auto_recording?: "none" | "local" | "cloud";

settings.auto_start_ai_companion_questions?¶

optional auto_start_ai_companion_questions?: boolean;

settings.auto_start_meeting_summary?¶

optional auto_start_meeting_summary?: boolean;

settings.breakout_room?¶

optional breakout_room?: {
  enable?: boolean;
  rooms?: readonly {
     name?: string;
     participants?: readonly string[];
  }[];
};

settings.breakout_room.enable?¶

optional enable?: boolean;

settings.breakout_room.rooms?¶

optional rooms?: readonly {
  name?: string;
  participants?: readonly string[];
}[];

settings.calendar_type?¶

optional calendar_type?: 1 | 2;

settings.close_registration?¶

optional close_registration?: boolean;

settings.cn_meeting?¶

optional cn_meeting?: boolean;

settings.contact_email?¶

optional contact_email?: string;

settings.contact_name?¶

optional contact_name?: string;

settings.continuous_meeting_chat?¶

optional continuous_meeting_chat?: {
  auto_add_invited_external_users?: boolean;
  auto_add_meeting_participants?: boolean;
  channel_id?: string;
  enable?: boolean;
};

settings.continuous_meeting_chat.auto_add_invited_external_users?¶

optional auto_add_invited_external_users?: boolean;

settings.continuous_meeting_chat.auto_add_meeting_participants?¶

optional auto_add_meeting_participants?: boolean;

settings.continuous_meeting_chat.channel_id?¶

optional channel_id?: string;

settings.continuous_meeting_chat.enable?¶

optional enable?: boolean;

settings.custom_keys?¶

optional custom_keys?: readonly {
  key?: string;
  value?: string;
}[];

settings.device_testing?¶

optional device_testing?: boolean;

settings.disable_participant_video?¶

optional disable_participant_video?: boolean;

settings.email_in_attendee_report?¶

optional email_in_attendee_report?: boolean;

settings.email_notification?¶

optional email_notification?: boolean;

settings.encryption_type?¶

optional encryption_type?: "enhanced_encryption" | "e2ee";

settings.enforce_login?¶

optional enforce_login?: boolean;

settings.enforce_login_domains?¶

optional enforce_login_domains?: string;

settings.focus_mode?¶

optional focus_mode?: boolean;

settings.global_dial_in_countries?¶

optional global_dial_in_countries?: readonly string[];

settings.global_dial_in_numbers?¶

optional global_dial_in_numbers?: readonly {
  city?: string;
  country?: string;
  country_name?: string;
  number?: string;
  type?: "toll" | "tollfree";
}[];

settings.host_save_video_order?¶

optional host_save_video_order?: boolean;

settings.host_video?¶

optional host_video?: boolean;

settings.in_meeting?¶

optional in_meeting?: boolean;

settings.internal_meeting?¶

optional internal_meeting?: boolean;

settings.jbh_time?¶

optional jbh_time?: 0 | 5 | 10 | 15;

settings.join_before_host?¶

optional join_before_host?: boolean;

settings.language_interpretation?¶

optional language_interpretation?: {
  enable?: boolean;
  interpreters?: readonly {
     email?: string;
     interpreter_languages?: string;
     languages?: string;
  }[];
};

settings.language_interpretation.enable?¶

optional enable?: boolean;

settings.language_interpretation.interpreters?¶

optional interpreters?: readonly {
  email?: string;
  interpreter_languages?: string;
  languages?: string;
}[];

settings.meeting_authentication?¶

optional meeting_authentication?: boolean;

settings.meeting_invitees?¶

optional meeting_invitees?: readonly {
  email?: string;
  internal_user?: boolean;
}[];

settings.mute_upon_entry?¶

optional mute_upon_entry?: boolean;

settings.participant_focused_meeting?¶

optional participant_focused_meeting?: boolean;

settings.participant_video?¶

optional participant_video?: boolean;

settings.private_meeting?¶

optional private_meeting?: boolean;

settings.push_change_to_calendar?¶

optional push_change_to_calendar?: boolean;

settings.question_and_answer?¶

optional question_and_answer?: {
  allow_anonymous_questions?: boolean;
  allow_submit_questions?: boolean;
  attendees_can_comment?: boolean;
  attendees_can_upvote?: boolean;
  enable?: boolean;
  question_visibility?: "all" | "answered";
};

settings.question_and_answer.allow_anonymous_questions?¶

optional allow_anonymous_questions?: boolean;

settings.question_and_answer.allow_submit_questions?¶

optional allow_submit_questions?: boolean;

settings.question_and_answer.attendees_can_comment?¶

optional attendees_can_comment?: boolean;

settings.question_and_answer.attendees_can_upvote?¶

optional attendees_can_upvote?: boolean;

settings.question_and_answer.enable?¶

optional enable?: boolean;

settings.question_and_answer.question_visibility?¶

optional question_visibility?: "all" | "answered";

settings.registrants_confirmation_email?¶

optional registrants_confirmation_email?: boolean;

settings.registrants_email_notification?¶

optional registrants_email_notification?: boolean;

settings.registration_type?¶

optional registration_type?: 1 | 2 | 3;

settings.request_permission_to_unmute_participants?¶

optional request_permission_to_unmute_participants?: boolean;

settings.resources?¶

optional resources?: readonly {
  permission_level?: "editor" | "commenter" | "viewer";
  resource_id?: string;
  resource_type?: "whiteboard";
}[];

settings.show_join_info?¶

optional show_join_info?: boolean;

settings.show_share_button?¶

optional show_share_button?: boolean;

settings.sign_language_interpretation?¶

optional sign_language_interpretation?: {
  enable?: boolean;
  interpreters?: readonly {
     email?: string;
     sign_language?: string;
  }[];
};

settings.sign_language_interpretation.enable?¶

optional enable?: boolean;

settings.sign_language_interpretation.interpreters?¶

optional interpreters?: readonly {
  email?: string;
  sign_language?: string;
}[];

settings.summary_template_id?¶

optional summary_template_id?: string;

settings.use_pmi?¶

optional use_pmi?: boolean;

settings.waiting_room?¶

optional waiting_room?: boolean;

settings.waiting_room_options?¶

optional waiting_room_options?: {
  mode: "custom" | "follow_setting";
  who_goes_to_waiting_room?:   | "everyone"
     | "users_not_in_account"
     | "users_not_in_account_or_whitelisted_domains"
     | "users_not_on_invite"
     | "users_not_in_org";
};

settings.waiting_room_options.mode¶

mode: "custom" | "follow_setting";

settings.waiting_room_options.who_goes_to_waiting_room?¶

optional who_goes_to_waiting_room?:
  | "everyone"
  | "users_not_in_account"
  | "users_not_in_account_or_whitelisted_domains"
  | "users_not_on_invite"
  | "users_not_in_org";

settings.watermark?¶

optional watermark?: boolean;

settings.who_can_ask_questions?¶

optional who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;

settings.who_will_receive_summary?¶

optional who_will_receive_summary?: 1 | 2 | 3 | 4;

start_time?¶

optional start_time?: string;

start_url?¶

optional start_url?: string;

status?¶

optional status?: "started" | "waiting";

template_id?¶

optional template_id?: string;

timezone?¶

optional timezone?: string;

topic?¶

optional topic?: string;

tracking_fields?¶

optional tracking_fields?: readonly {
  field?: string;
  value?: string;
  visible?: boolean;
}[];

type?¶

optional type?: 1 | 2 | 3 | 4 | 8 | 10;

uuid?¶

optional uuid?: string;

GET /meetings/{meetingId}/invitation¶

GET /meetings/{meetingId}/invitation: {
  invitation?: string;
  sip_links?: readonly string[];
};

invitation?¶

optional invitation?: string;

sip_links?¶

optional sip_links?: readonly string[];

GET /meetings/{meetingId}/jointoken/live_streaming¶

GET /meetings/{meetingId}/jointoken/live_streaming: {
  expire_in?: 120;
  token?: string;
};

expire_in?¶

optional expire_in?: 120;

token?¶

optional token?: string;

GET /meetings/{meetingId}/jointoken/local_archiving¶

GET /meetings/{meetingId}/jointoken/local_archiving: {
  expire_in?: 120;
  token?: string;
};

expire_in?¶

optional expire_in?: 120;

token?¶

optional token?: string;

GET /meetings/{meetingId}/jointoken/local_recording¶

GET /meetings/{meetingId}/jointoken/local_recording: {
  expire_in?: 120;
  token?: string;
};

expire_in?¶

optional expire_in?: 120;

token?¶

optional token?: string;

GET /meetings/{meetingId}/livestream¶

GET /meetings/{meetingId}/livestream: {
  page_url?: string;
  resolution?: string;
  stream_key?: string;
  stream_url?: string;
};

page_url?¶

optional page_url?: string;

resolution?¶

optional resolution?: string;

stream_key?¶

optional stream_key?: string;

stream_url?¶

optional stream_url?: string;

GET /meetings/{meetingId}/meeting_summary¶

GET /meetings/{meetingId}/meeting_summary: {
  edited_summary?: {
     next_steps?: readonly string[];
     summary_details?: string;
     summary_overview?: string;
  };
  meeting_end_time?: string;
  meeting_host_email?: string;
  meeting_host_id?: string;
  meeting_id?: number;
  meeting_start_time?: string;
  meeting_topic?: string;
  meeting_uuid?: string;
  next_steps?: readonly string[];
  summary_content?: string;
  summary_created_time?: string;
  summary_details?: readonly {
     label?: string;
     summary?: string;
  }[];
  summary_doc_url?: string;
  summary_end_time?: string;
  summary_last_modified_time?: string;
  summary_last_modified_user_email?: string;
  summary_last_modified_user_id?: string;
  summary_overview?: string;
  summary_start_time?: string;
  summary_title?: string;
};

edited_summary?¶

optional edited_summary?: {
  next_steps?: readonly string[];
  summary_details?: string;
  summary_overview?: string;
};

edited_summary.next_steps?¶

optional next_steps?: readonly string[];

edited_summary.summary_details?¶

optional summary_details?: string;

edited_summary.summary_overview?¶

optional summary_overview?: string;

meeting_end_time?¶

optional meeting_end_time?: string;

meeting_host_email?¶

optional meeting_host_email?: string;

meeting_host_id?¶

optional meeting_host_id?: string;

meeting_id?¶

optional meeting_id?: number;

meeting_start_time?¶

optional meeting_start_time?: string;

meeting_topic?¶

optional meeting_topic?: string;

meeting_uuid?¶

optional meeting_uuid?: string;

next_steps?¶

optional next_steps?: readonly string[];

summary_content?¶

optional summary_content?: string;

summary_created_time?¶

optional summary_created_time?: string;

summary_details?¶

optional summary_details?: readonly {
  label?: string;
  summary?: string;
}[];

summary_doc_url?¶

optional summary_doc_url?: string;

summary_end_time?¶

optional summary_end_time?: string;

summary_last_modified_time?¶

optional summary_last_modified_time?: string;

summary_last_modified_user_email?¶

optional summary_last_modified_user_email?: string;

summary_last_modified_user_id?¶

optional summary_last_modified_user_id?: string;

summary_overview?¶

optional summary_overview?: string;

summary_start_time?¶

optional summary_start_time?: string;

summary_title?¶

optional summary_title?: string;

GET /meetings/{meetingId}/polls¶

GET /meetings/{meetingId}/polls: {
  polls?: readonly {
     id?: string;
     status?: "started" | "ended" | "notstart" | "sharing" | "deactivated";
   } & {
     anonymous?: boolean;
     poll_type?: 1 | 2 | 3;
     questions?: readonly {
        answer_max_character?: number;
        answer_min_character?: number;
        answer_required?: boolean;
        answers?: readonly string[];
        case_sensitive?: boolean;
        name?: string;
        prompts?: readonly {
           prompt_question?: string;
           prompt_right_answers?: readonly string[];
        }[];
        rating_max_label?: string;
        rating_max_value?: number;
        rating_min_label?: string;
        rating_min_value?: number;
        right_answers?: readonly string[];
        show_as_dropdown?: boolean;
        type?:   | "single"
           | "multiple"
           | "matching"
           | "rank_order"
           | "short_answer"
           | "long_answer"
           | "fill_in_the_blank"
           | "rating_scale";
     }[];
     title?: string;
  }[];
  total_records?: number;
};

polls?¶

optional polls?: readonly {
  id?: string;
  status?: "started" | "ended" | "notstart" | "sharing" | "deactivated";
} & {
  anonymous?: boolean;
  poll_type?: 1 | 2 | 3;
  questions?: readonly {
     answer_max_character?: number;
     answer_min_character?: number;
     answer_required?: boolean;
     answers?: readonly string[];
     case_sensitive?: boolean;
     name?: string;
     prompts?: readonly {
        prompt_question?: string;
        prompt_right_answers?: readonly string[];
     }[];
     rating_max_label?: string;
     rating_max_value?: number;
     rating_min_label?: string;
     rating_min_value?: number;
     right_answers?: readonly string[];
     show_as_dropdown?: boolean;
     type?:   | "single"
        | "multiple"
        | "matching"
        | "rank_order"
        | "short_answer"
        | "long_answer"
        | "fill_in_the_blank"
        | "rating_scale";
  }[];
  title?: string;
}[];

total_records?¶

optional total_records?: number;

GET /meetings/{meetingId}/polls/{pollId}¶

GET /meetings/{meetingId}/polls/{pollId}: {
  id?: string;
  status?: "started" | "ended" | "notstart" | "sharing" | "deactivated";
} & {
  anonymous?: boolean;
  poll_type?: 1 | 2 | 3;
  questions?: readonly {
     answer_max_character?: number;
     answer_min_character?: number;
     answer_required?: boolean;
     answers?: readonly string[];
     case_sensitive?: boolean;
     name?: string;
     prompts?: readonly {
        prompt_question?: string;
        prompt_right_answers?: readonly string[];
     }[];
     rating_max_label?: string;
     rating_max_value?: number;
     rating_min_label?: string;
     rating_min_value?: number;
     right_answers?: readonly string[];
     show_as_dropdown?: boolean;
     type?:   | "single"
        | "multiple"
        | "matching"
        | "rank_order"
        | "short_answer"
        | "long_answer"
        | "fill_in_the_blank"
        | "rating_scale";
  }[];
  title?: string;
};

Type Declaration¶

id?¶

optional id?: string;

status?¶

optional status?: "started" | "ended" | "notstart" | "sharing" | "deactivated";

Type Declaration¶

anonymous?¶

optional anonymous?: boolean;

poll_type?¶

optional poll_type?: 1 | 2 | 3;

questions?¶

optional questions?: readonly {
  answer_max_character?: number;
  answer_min_character?: number;
  answer_required?: boolean;
  answers?: readonly string[];
  case_sensitive?: boolean;
  name?: string;
  prompts?: readonly {
     prompt_question?: string;
     prompt_right_answers?: readonly string[];
  }[];
  rating_max_label?: string;
  rating_max_value?: number;
  rating_min_label?: string;
  rating_min_value?: number;
  right_answers?: readonly string[];
  show_as_dropdown?: boolean;
  type?:   | "single"
     | "multiple"
     | "matching"
     | "rank_order"
     | "short_answer"
     | "long_answer"
     | "fill_in_the_blank"
     | "rating_scale";
}[];

title?¶

optional title?: string;

GET /meetings/{meetingId}/recordings¶

GET /meetings/{meetingId}/recordings: {
  account_id?: string;
  auto_delete?: boolean;
  auto_delete_date?: string;
  duration?: number;
  external_storage_addr?: string;
  host_id?: string;
  id?: number;
  instance_id?: string;
  rc_meeting_zone_name?: string;
  rc_zone?: string;
  recording_count?: number;
  recording_play_passcode?: string;
  service_name?: string;
  start_time?: string;
  topic?: string;
  total_size?: number;
  type?: "2" | "1" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "99";
  uuid?: string;
  zone_instance_id?: string;
} & {
  recording_files?: readonly {
     deleted_time?: string;
     download_url?: string;
     file_extension?: "JSON" | "MP4" | "M4A" | "CSV" | "TXT" | "VTT" | "JPG";
     file_path?: string;
     file_size?: number;
     file_type?:   | "MP4"
        | "M4A"
        | "CHAT"
        | "CC"
        | "CHAT_MESSAGE"
        | "TRANSCRIPT"
        | "CSV"
        | "TB"
        | "SUMMARY";
     id?: string;
     meeting_id?: string;
     play_url?: string;
     recording_end?: string;
     recording_start?: string;
     recording_type?:   | "summary"
        | "shared_screen_with_speaker_view"
        | "audio_only"
        | "chat_file"
        | "closed_caption"
        | "audio_transcript"
        | "shared_screen_with_speaker_view(CC)"
        | "shared_screen_with_gallery_view"
        | "active_speaker"
        | "gallery_view"
        | "shared_screen"
        | "poll"
        | "host_video"
        | "timeline"
        | "thumbnail"
        | "audio_interpretation"
        | "summary_next_steps"
        | "summary_smart_chapters"
        | "sign_interpretation"
        | "production_studio";
     status?: "completed";
  }[];
} & {
  download_access_token?: string;
  password?: string;
  recording_play_passcode?: string;
} & {
  participant_audio_files?: readonly {
     download_url?: string;
     file_name?: string;
     file_path?: string;
     file_size?: number;
     file_type?: string;
     id?: string;
     play_url?: string;
     recording_end?: string;
     recording_start?: string;
     status?: "completed";
  }[];
};

Type Declaration¶

account_id?¶

optional account_id?: string;

auto_delete?¶

optional auto_delete?: boolean;

auto_delete_date?¶

optional auto_delete_date?: string;

duration?¶

optional duration?: number;

external_storage_addr?¶

optional external_storage_addr?: string;

host_id?¶

optional host_id?: string;

id?¶

optional id?: number;

instance_id?¶

optional instance_id?: string;

rc_meeting_zone_name?¶

optional rc_meeting_zone_name?: string;

rc_zone?¶

optional rc_zone?: string;

recording_count?¶

optional recording_count?: number;

recording_play_passcode?¶

optional recording_play_passcode?: string;

service_name?¶

optional service_name?: string;

start_time?¶

optional start_time?: string;

topic?¶

optional topic?: string;

total_size?¶

optional total_size?: number;

type?¶

optional type?: "2" | "1" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "99";

uuid?¶

optional uuid?: string;

zone_instance_id?¶

optional zone_instance_id?: string;

Type Declaration¶

recording_files?¶

optional recording_files?: readonly {
  deleted_time?: string;
  download_url?: string;
  file_extension?: "JSON" | "MP4" | "M4A" | "CSV" | "TXT" | "VTT" | "JPG";
  file_path?: string;
  file_size?: number;
  file_type?:   | "MP4"
     | "M4A"
     | "CHAT"
     | "CC"
     | "CHAT_MESSAGE"
     | "TRANSCRIPT"
     | "CSV"
     | "TB"
     | "SUMMARY";
  id?: string;
  meeting_id?: string;
  play_url?: string;
  recording_end?: string;
  recording_start?: string;
  recording_type?:   | "summary"
     | "shared_screen_with_speaker_view"
     | "audio_only"
     | "chat_file"
     | "closed_caption"
     | "audio_transcript"
     | "shared_screen_with_speaker_view(CC)"
     | "shared_screen_with_gallery_view"
     | "active_speaker"
     | "gallery_view"
     | "shared_screen"
     | "poll"
     | "host_video"
     | "timeline"
     | "thumbnail"
     | "audio_interpretation"
     | "summary_next_steps"
     | "summary_smart_chapters"
     | "sign_interpretation"
     | "production_studio";
  status?: "completed";
}[];

Type Declaration¶

download_access_token?¶

optional download_access_token?: string;

password?¶

optional password?: string;

recording_play_passcode?¶

optional recording_play_passcode?: string;

Type Declaration¶

participant_audio_files?¶

optional participant_audio_files?: readonly {
  download_url?: string;
  file_name?: string;
  file_path?: string;
  file_size?: number;
  file_type?: string;
  id?: string;
  play_url?: string;
  recording_end?: string;
  recording_start?: string;
  status?: "completed";
}[];

GET /meetings/{meetingId}/recordings/analytics_details¶

GET /meetings/{meetingId}/recordings/analytics_details: {
  analytics_details?: readonly {
     date_time?: string;
     duration?: number;
     email?: string;
     name?: string;
  }[];
  from?: string;
  next_page_token?: string;
  page_size?: number;
  to?: string;
  total_records?: number;
};

analytics_details?¶

optional analytics_details?: readonly {
  date_time?: string;
  duration?: number;
  email?: string;
  name?: string;
}[];

from?¶

optional from?: string;

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

to?¶

optional to?: string;

total_records?¶

optional total_records?: number;

GET /meetings/{meetingId}/recordings/analytics_summary¶

GET /meetings/{meetingId}/recordings/analytics_summary: {
  analytics_summary?: readonly {
     date?: string;
     downloads_total_count?: number;
     views_total_count?: number;
  }[];
  from?: string;
  to?: string;
};

analytics_summary?¶

optional analytics_summary?: readonly {
  date?: string;
  downloads_total_count?: number;
  views_total_count?: number;
}[];

from?¶

optional from?: string;

to?¶

optional to?: string;

GET /meetings/{meetingId}/recordings/registrants¶

GET /meetings/{meetingId}/recordings/registrants: {
  next_page_token?: string;
  page_count?: number;
  page_number?: number;
  page_size?: number;
  total_records?: number;
} & {
  registrants?: readonly {
     id?: string;
   } & {
     address?: string;
     city?: string;
     comments?: string;
     country?: string;
     custom_questions?: readonly {
        title?: string;
        value?: string;
     }[];
     email: string;
     first_name: string;
     industry?: string;
     job_title?: string;
     last_name?: string;
     no_of_employees?:   | ""
        | "1-20"
        | "21-50"
        | "51-100"
        | "101-250"
        | "251-500"
        | "501-1,000"
        | "1,001-5,000"
        | "5,001-10,000"
        | "More than 10,000";
     org?: string;
     phone?: string;
     purchasing_time_frame?:   | ""
        | "Within a month"
        | "1-3 months"
        | "4-6 months"
        | "More than 6 months"
        | "No timeframe";
     role_in_purchase_process?:   | ""
        | "Decision Maker"
        | "Evaluator/Recommender"
        | "Influencer"
        | "Not involved";
     state?: string;
     status?: "pending" | "approved" | "denied";
     zip?: string;
  }[];
};

Type Declaration¶

next_page_token?¶

optional next_page_token?: string;

page_count?¶

optional page_count?: number;

page_number?¶

optional page_number?: number;

page_size?¶

optional page_size?: number;

total_records?¶

optional total_records?: number;

Type Declaration¶

registrants?¶

optional registrants?: readonly {
  id?: string;
} & {
  address?: string;
  city?: string;
  comments?: string;
  country?: string;
  custom_questions?: readonly {
     title?: string;
     value?: string;
  }[];
  email: string;
  first_name: string;
  industry?: string;
  job_title?: string;
  last_name?: string;
  no_of_employees?:   | ""
     | "1-20"
     | "21-50"
     | "51-100"
     | "101-250"
     | "251-500"
     | "501-1,000"
     | "1,001-5,000"
     | "5,001-10,000"
     | "More than 10,000";
  org?: string;
  phone?: string;
  purchasing_time_frame?:   | ""
     | "Within a month"
     | "1-3 months"
     | "4-6 months"
     | "More than 6 months"
     | "No timeframe";
  role_in_purchase_process?:   | ""
     | "Decision Maker"
     | "Evaluator/Recommender"
     | "Influencer"
     | "Not involved";
  state?: string;
  status?: "pending" | "approved" | "denied";
  zip?: string;
}[];

GET /meetings/{meetingId}/recordings/registrants/questions¶

GET /meetings/{meetingId}/recordings/registrants/questions: {
  custom_questions?: readonly {
     answers?: readonly string[];
     required?: boolean;
     title?: string;
     type?: "short" | "single" | "multiple";
  }[];
  questions?: readonly {
     field_name?:   | "state"
        | "phone"
        | "last_name"
        | "address"
        | "city"
        | "country"
        | "zip"
        | "industry"
        | "org"
        | "job_title"
        | "purchasing_time_frame"
        | "role_in_purchase_process"
        | "no_of_employees"
        | "comments";
     required?: boolean;
  }[];
};

custom_questions?¶

optional custom_questions?: readonly {
  answers?: readonly string[];
  required?: boolean;
  title?: string;
  type?: "short" | "single" | "multiple";
}[];

questions?¶

optional questions?: readonly {
  field_name?:   | "state"
     | "phone"
     | "last_name"
     | "address"
     | "city"
     | "country"
     | "zip"
     | "industry"
     | "org"
     | "job_title"
     | "purchasing_time_frame"
     | "role_in_purchase_process"
     | "no_of_employees"
     | "comments";
  required?: boolean;
}[];

GET /meetings/{meetingId}/recordings/settings¶

GET /meetings/{meetingId}/recordings/settings: {
  approval_type?: 0 | 1 | 2;
  authentication_domains?: string;
  authentication_name?: string;
  authentication_option?: string;
  auto_delete?: boolean;
  auto_delete_date?: string;
  on_demand?: boolean;
  password?: string;
  recording_authentication?: boolean;
  send_email_to_host?: boolean;
  share_recording?: "none" | "publicly" | "internally";
  show_social_share_buttons?: boolean;
  topic?: string;
  viewer_download?: boolean;
};

approval_type?¶

optional approval_type?: 0 | 1 | 2;

authentication_domains?¶

optional authentication_domains?: string;

authentication_name?¶

optional authentication_name?: string;

authentication_option?¶

optional authentication_option?: string;

auto_delete?¶

optional auto_delete?: boolean;

auto_delete_date?¶

optional auto_delete_date?: string;

on_demand?¶

optional on_demand?: boolean;

password?¶

optional password?: string;

recording_authentication?¶

optional recording_authentication?: boolean;

send_email_to_host?¶

optional send_email_to_host?: boolean;

share_recording?¶

optional share_recording?: "none" | "publicly" | "internally";

show_social_share_buttons?¶

optional show_social_share_buttons?: boolean;

topic?¶

optional topic?: string;

viewer_download?¶

optional viewer_download?: boolean;

GET /meetings/{meetingId}/registrants¶

GET /meetings/{meetingId}/registrants: {
  next_page_token?: string;
  page_count?: number;
  page_number?: number;
  page_size?: number;
  total_records?: number;
} & {
  registrants?: readonly {
     id?: string;
   } & {
     address?: string;
     city?: string;
     comments?: string;
     country?: string;
     custom_questions?: readonly {
        title?: string;
        value?: string;
     }[];
     email: string;
     first_name: string;
     industry?: string;
     job_title?: string;
     last_name?: string;
     no_of_employees?:   | ""
        | "1-20"
        | "21-50"
        | "51-100"
        | "101-250"
        | "251-500"
        | "501-1,000"
        | "1,001-5,000"
        | "5,001-10,000"
        | "More than 10,000";
     org?: string;
     phone?: string;
     purchasing_time_frame?:   | ""
        | "Within a month"
        | "1-3 months"
        | "4-6 months"
        | "More than 6 months"
        | "No timeframe";
     role_in_purchase_process?:   | ""
        | "Decision Maker"
        | "Evaluator/Recommender"
        | "Influencer"
        | "Not involved";
     state?: string;
     status?: "pending" | "approved" | "denied";
     zip?: string;
   } & {
     create_time?: string;
     join_url?: string;
     participant_pin_code?: number;
     status?: string;
  }[];
};

Type Declaration¶

next_page_token?¶

optional next_page_token?: string;

page_count?¶

optional page_count?: number;

page_number?¶

optional page_number?: number;

page_size?¶

optional page_size?: number;

total_records?¶

optional total_records?: number;

Type Declaration¶

registrants?¶

optional registrants?: readonly {
  id?: string;
} & {
  address?: string;
  city?: string;
  comments?: string;
  country?: string;
  custom_questions?: readonly {
     title?: string;
     value?: string;
  }[];
  email: string;
  first_name: string;
  industry?: string;
  job_title?: string;
  last_name?: string;
  no_of_employees?:   | ""
     | "1-20"
     | "21-50"
     | "51-100"
     | "101-250"
     | "251-500"
     | "501-1,000"
     | "1,001-5,000"
     | "5,001-10,000"
     | "More than 10,000";
  org?: string;
  phone?: string;
  purchasing_time_frame?:   | ""
     | "Within a month"
     | "1-3 months"
     | "4-6 months"
     | "More than 6 months"
     | "No timeframe";
  role_in_purchase_process?:   | ""
     | "Decision Maker"
     | "Evaluator/Recommender"
     | "Influencer"
     | "Not involved";
  state?: string;
  status?: "pending" | "approved" | "denied";
  zip?: string;
} & {
  create_time?: string;
  join_url?: string;
  participant_pin_code?: number;
  status?: string;
}[];

GET /meetings/{meetingId}/registrants/{registrantId}¶

GET /meetings/{meetingId}/registrants/{registrantId}: {
  id?: string;
} & {
  address?: string;
  city?: string;
  comments?: string;
  country?: string;
  custom_questions?: readonly {
     title?: string;
     value?: string;
  }[];
  email: string;
  first_name: string;
  industry?: string;
  job_title?: string;
  last_name?: string;
  no_of_employees?:   | ""
     | "1-20"
     | "21-50"
     | "51-100"
     | "101-250"
     | "251-500"
     | "501-1,000"
     | "1,001-5,000"
     | "5,001-10,000"
     | "More than 10,000";
  org?: string;
  phone?: string;
  purchasing_time_frame?:   | ""
     | "Within a month"
     | "1-3 months"
     | "4-6 months"
     | "More than 6 months"
     | "No timeframe";
  role_in_purchase_process?:   | ""
     | "Decision Maker"
     | "Evaluator/Recommender"
     | "Influencer"
     | "Not involved";
  state?: string;
  status?: "pending" | "approved" | "denied";
  zip?: string;
} & {
  create_time?: string;
  join_url?: string;
  participant_pin_code?: number;
  status?: "pending" | "approved" | "denied";
};

Type Declaration¶

id?¶

optional id?: string;

Type Declaration¶

address?¶

optional address?: string;

city?¶

optional city?: string;

comments?¶

optional comments?: string;

country?¶

optional country?: string;

custom_questions?¶

optional custom_questions?: readonly {
  title?: string;
  value?: string;
}[];

email¶

email: string;

first_name¶

first_name: string;

industry?¶

optional industry?: string;

job_title?¶

optional job_title?: string;

last_name?¶

optional last_name?: string;

no_of_employees?¶

optional no_of_employees?:
  | ""
  | "1-20"
  | "21-50"
  | "51-100"
  | "101-250"
  | "251-500"
  | "501-1,000"
  | "1,001-5,000"
  | "5,001-10,000"
  | "More than 10,000";

org?¶

optional org?: string;

phone?¶

optional phone?: string;

purchasing_time_frame?¶

optional purchasing_time_frame?:
  | ""
  | "Within a month"
  | "1-3 months"
  | "4-6 months"
  | "More than 6 months"
  | "No timeframe";

role_in_purchase_process?¶

optional role_in_purchase_process?:
  | ""
  | "Decision Maker"
  | "Evaluator/Recommender"
  | "Influencer"
  | "Not involved";

state?¶

optional state?: string;

status?¶

optional status?: "pending" | "approved" | "denied";

zip?¶

optional zip?: string;

Type Declaration¶

create_time?¶

optional create_time?: string;

join_url?¶

optional join_url?: string;

participant_pin_code?¶

optional participant_pin_code?: number;

status?¶

optional status?: "pending" | "approved" | "denied";

GET /meetings/{meetingId}/registrants/questions¶

GET /meetings/{meetingId}/registrants/questions: {
  custom_questions?: readonly {
     answers?: readonly string[];
     required?: boolean;
     title?: string;
     type?: "short" | "single";
  }[];
  questions?: readonly {
     field_name?:   | "state"
        | "phone"
        | "last_name"
        | "address"
        | "city"
        | "country"
        | "zip"
        | "industry"
        | "org"
        | "job_title"
        | "purchasing_time_frame"
        | "role_in_purchase_process"
        | "no_of_employees"
        | "comments";
     required?: boolean;
  }[];
};

custom_questions?¶

optional custom_questions?: readonly {
  answers?: readonly string[];
  required?: boolean;
  title?: string;
  type?: "short" | "single";
}[];

questions?¶

optional questions?: readonly {
  field_name?:   | "state"
     | "phone"
     | "last_name"
     | "address"
     | "city"
     | "country"
     | "zip"
     | "industry"
     | "org"
     | "job_title"
     | "purchasing_time_frame"
     | "role_in_purchase_process"
     | "no_of_employees"
     | "comments";
  required?: boolean;
}[];

GET /meetings/{meetingId}/survey¶

GET /meetings/{meetingId}/survey: {
  custom_survey?: {
     anonymous?: boolean;
     feedback?: string;
     numbered_questions?: boolean;
     questions?: readonly {
        answer_max_character?: number;
        answer_min_character?: number;
        answer_required?: boolean;
        answers?: readonly string[];
        name?: string;
        prompts?: readonly {
           prompt_question?: string;
        }[];
        rating_max_label?: string;
        rating_max_value?: number;
        rating_min_label?: string;
        rating_min_value?: number;
        show_as_dropdown?: boolean;
        type?:   | "single"
           | "multiple"
           | "matching"
           | "rank_order"
           | "short_answer"
           | "long_answer"
           | "fill_in_the_blank"
           | "rating_scale";
     }[];
     show_question_type?: boolean;
     title?: string;
  };
  show_in_the_browser?: boolean;
  third_party_survey?: string;
};

custom_survey?¶

optional custom_survey?: {
  anonymous?: boolean;
  feedback?: string;
  numbered_questions?: boolean;
  questions?: readonly {
     answer_max_character?: number;
     answer_min_character?: number;
     answer_required?: boolean;
     answers?: readonly string[];
     name?: string;
     prompts?: readonly {
        prompt_question?: string;
     }[];
     rating_max_label?: string;
     rating_max_value?: number;
     rating_min_label?: string;
     rating_min_value?: number;
     show_as_dropdown?: boolean;
     type?:   | "single"
        | "multiple"
        | "matching"
        | "rank_order"
        | "short_answer"
        | "long_answer"
        | "fill_in_the_blank"
        | "rating_scale";
  }[];
  show_question_type?: boolean;
  title?: string;
};

custom_survey.anonymous?¶

optional anonymous?: boolean;

custom_survey.feedback?¶

optional feedback?: string;

custom_survey.numbered_questions?¶

optional numbered_questions?: boolean;

custom_survey.questions?¶

optional questions?: readonly {
  answer_max_character?: number;
  answer_min_character?: number;
  answer_required?: boolean;
  answers?: readonly string[];
  name?: string;
  prompts?: readonly {
     prompt_question?: string;
  }[];
  rating_max_label?: string;
  rating_max_value?: number;
  rating_min_label?: string;
  rating_min_value?: number;
  show_as_dropdown?: boolean;
  type?:   | "single"
     | "multiple"
     | "matching"
     | "rank_order"
     | "short_answer"
     | "long_answer"
     | "fill_in_the_blank"
     | "rating_scale";
}[];

custom_survey.show_question_type?¶

optional show_question_type?: boolean;

custom_survey.title?¶

optional title?: string;

show_in_the_browser?¶

optional show_in_the_browser?: boolean;

third_party_survey?¶

optional third_party_survey?: string;

GET /meetings/{meetingId}/token¶

GET /meetings/{meetingId}/token: {
  token?: string;
};

token?¶

optional token?: string;

GET /meetings/{meetingId}/transcript¶

GET /meetings/{meetingId}/transcript: {
  account_id?: string;
  auto_delete?: boolean;
  auto_delete_date?: string;
  can_download?: boolean;
  download_restriction_reason?:   | "DELETED_OR_TRASHED"
     | "UNSUPPORTED"
     | "NO_TRANSCRIPT_DATA"
     | "NOT_READY";
  download_url?: string;
  host_id?: string;
  meeting_id?: string;
  meeting_topic?: string;
  transcript_created_time?: string;
};

account_id?¶

optional account_id?: string;

auto_delete?¶

optional auto_delete?: boolean;

auto_delete_date?¶

optional auto_delete_date?: string;

can_download?¶

optional can_download?: boolean;

download_restriction_reason?¶

optional download_restriction_reason?:
  | "DELETED_OR_TRASHED"
  | "UNSUPPORTED"
  | "NO_TRANSCRIPT_DATA"
  | "NOT_READY";

download_url?¶

optional download_url?: string;

host_id?¶

optional host_id?: string;

meeting_id?¶

optional meeting_id?: string;

meeting_topic?¶

optional meeting_topic?: string;

transcript_created_time?¶

optional transcript_created_time?: string;

GET /meetings/meeting_summaries¶

GET /meetings/meeting_summaries: {
  from?: string;
  next_page_token?: string;
  page_size?: number;
  summaries?: readonly {
     meeting_end_time?: string;
     meeting_host_email?: string;
     meeting_host_id?: string;
     meeting_id?: number;
     meeting_start_time?: string;
     meeting_topic?: string;
     meeting_uuid?: string;
     summary_created_time?: string;
     summary_end_time?: string;
     summary_last_modified_time?: string;
     summary_start_time?: string;
  }[];
  to?: string;
};

from?¶

optional from?: string;

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

summaries?¶

optional summaries?: readonly {
  meeting_end_time?: string;
  meeting_host_email?: string;
  meeting_host_id?: string;
  meeting_id?: number;
  meeting_start_time?: string;
  meeting_topic?: string;
  meeting_uuid?: string;
  summary_created_time?: string;
  summary_end_time?: string;
  summary_last_modified_time?: string;
  summary_start_time?: string;
}[];

to?¶

optional to?: string;

GET /past_meetings/{meetingId}¶

GET /past_meetings/{meetingId}: {
  dept?: string;
  duration?: number;
  end_time?: string;
  has_meeting_summary?: boolean;
  host_id?: string;
  id?: number;
  participants_count?: number;
  source?: string;
  start_time?: string;
  topic?: string;
  total_minutes?: number;
  type?: 0 | 1 | 2 | 3 | 4 | 7 | 8;
  user_email?: string;
  user_name?: string;
  uuid?: string;
};

dept?¶

optional dept?: string;

duration?¶

optional duration?: number;

end_time?¶

optional end_time?: string;

has_meeting_summary?¶

optional has_meeting_summary?: boolean;

host_id?¶

optional host_id?: string;

id?¶

optional id?: number;

participants_count?¶

optional participants_count?: number;

source?¶

optional source?: string;

start_time?¶

optional start_time?: string;

topic?¶

optional topic?: string;

total_minutes?¶

optional total_minutes?: number;

type?¶

optional type?: 0 | 1 | 2 | 3 | 4 | 7 | 8;

user_email?¶

optional user_email?: string;

user_name?¶

optional user_name?: string;

uuid?¶

optional uuid?: string;

GET /past_meetings/{meetingId}/instances¶

GET /past_meetings/{meetingId}/instances: {
  meetings?: readonly {
     start_time?: string;
     uuid?: string;
  }[];
};

meetings?¶

optional meetings?: readonly {
  start_time?: string;
  uuid?: string;
}[];

GET /past_meetings/{meetingId}/participants¶

GET /past_meetings/{meetingId}/participants: {
  next_page_token?: string;
  page_count?: number;
  page_size?: number;
  participants?: readonly {
     duration?: number;
     failover?: boolean;
     id?: string;
     internal_user?: boolean;
     join_time?: string;
     leave_time?: string;
     name?: string;
     registrant_id?: string;
     status?: "in_meeting" | "in_waiting_room";
     user_email?: string;
     user_id?: string;
  }[];
  total_records?: number;
};

next_page_token?¶

optional next_page_token?: string;

page_count?¶

optional page_count?: number;

page_size?¶

optional page_size?: number;

participants?¶

optional participants?: readonly {
  duration?: number;
  failover?: boolean;
  id?: string;
  internal_user?: boolean;
  join_time?: string;
  leave_time?: string;
  name?: string;
  registrant_id?: string;
  status?: "in_meeting" | "in_waiting_room";
  user_email?: string;
  user_id?: string;
}[];

total_records?¶

optional total_records?: number;

GET /past_meetings/{meetingId}/polls¶

GET /past_meetings/{meetingId}/polls: {
  id?: number;
  questions?: readonly {
     email?: string;
     name?: string;
     question_details?: readonly {
        answer?: string;
        date_time?: string;
        polling_id?: string;
        question?: string;
     }[];
  }[];
  start_time?: string;
  uuid?: string;
};

id?¶

optional id?: number;

questions?¶

optional questions?: readonly {
  email?: string;
  name?: string;
  question_details?: readonly {
     answer?: string;
     date_time?: string;
     polling_id?: string;
     question?: string;
  }[];
}[];

start_time?¶

optional start_time?: string;

uuid?¶

optional uuid?: string;

GET /past_meetings/{meetingId}/qa¶

GET /past_meetings/{meetingId}/qa: {
  id?: number;
  questions?: readonly {
     email?: string;
     name?: string;
     question_details?: readonly {
        answer?: string;
        question?: string;
     }[];
  }[];
  start_time?: string;
  uuid?: string;
};

id?¶

optional id?: number;

questions?¶

optional questions?: readonly {
  email?: string;
  name?: string;
  question_details?: readonly {
     answer?: string;
     question?: string;
  }[];
}[];

start_time?¶

optional start_time?: string;

uuid?¶

optional uuid?: string;

GET /past_meetings/{meetingUUID}/archive_files¶

GET /past_meetings/{meetingUUID}/archive_files: {
  account_name: string;
  archive_files: readonly {
     auto_delete?: boolean;
     download_url: string;
     encryption_fingerprint: string;
     file_extension: string;
     file_path?: string;
     file_size: number;
     file_type:   | "MP4"
        | "M4A"
        | "CHAT"
        | "CC"
        | "CHAT_MESSAGE"
        | "TRANSCRIPT"
        | "SUB_GROUP_MEMBER_LOG"
        | "AIC_COVERSATION";
     id: string;
     individual: boolean;
     number_of_messages?: number;
     participant_email?: string;
     participant_join_time: string;
     participant_leave_time: string;
     recording_type:   | "shared_screen_with_speaker_view"
        | "audio_only"
        | "chat_file"
        | "closed_caption"
        | "chat_message"
        | "audio_transcript"
        | "aic_conversation";
     status: "failed" | "completed" | "processing";
     storage_location?: "US" | "AU" | "BR" | "CA" | "EU" | "IN" | "JP" | "SG" | "CH";
  }[];
  complete_time:   | {
   }
     | "";
  duration: number;
  duration_in_second: number;
  group_id?: string;
  host_id: string;
  id: number;
  is_breakout_room: boolean;
  meeting_type: "internal" | "external";
  parent_meeting_id?: string;
  physical_files?: readonly {
     download_url?: string;
     file_id?: string;
     file_name?: string;
     file_size?: number;
  }[];
  recording_count: number;
  start_time: string;
  status: "completed" | "processing";
  timezone: string;
  topic: string;
  total_size: number;
  type: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 100;
  uuid: string;
};

account_name¶

account_name: string;

archive_files¶

archive_files: readonly {
  auto_delete?: boolean;
  download_url: string;
  encryption_fingerprint: string;
  file_extension: string;
  file_path?: string;
  file_size: number;
  file_type:   | "MP4"
     | "M4A"
     | "CHAT"
     | "CC"
     | "CHAT_MESSAGE"
     | "TRANSCRIPT"
     | "SUB_GROUP_MEMBER_LOG"
     | "AIC_COVERSATION";
  id: string;
  individual: boolean;
  number_of_messages?: number;
  participant_email?: string;
  participant_join_time: string;
  participant_leave_time: string;
  recording_type:   | "shared_screen_with_speaker_view"
     | "audio_only"
     | "chat_file"
     | "closed_caption"
     | "chat_message"
     | "audio_transcript"
     | "aic_conversation";
  status: "failed" | "completed" | "processing";
  storage_location?: "US" | "AU" | "BR" | "CA" | "EU" | "IN" | "JP" | "SG" | "CH";
}[];

complete_time¶

complete_time:
  | {
}
  | "";

duration¶

duration: number;

duration_in_second¶

duration_in_second: number;

group_id?¶

optional group_id?: string;

host_id¶

host_id: string;

id¶

id: number;

is_breakout_room¶

is_breakout_room: boolean;

meeting_type¶

meeting_type: "internal" | "external";

parent_meeting_id?¶

optional parent_meeting_id?: string;

physical_files?¶

optional physical_files?: readonly {
  download_url?: string;
  file_id?: string;
  file_name?: string;
  file_size?: number;
}[];

recording_count¶

recording_count: number;

start_time¶

start_time: string;

status¶

status: "completed" | "processing";

timezone¶

timezone: string;

topic¶

topic: string;

total_size¶

total_size: number;

type¶

type: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 100;

uuid¶

uuid: string;

GET /past_webinars/{webinarId}/absentees¶

GET /past_webinars/{webinarId}/absentees: {
  next_page_token?: string;
  page_count?: number;
  page_number?: number;
  page_size?: number;
  total_records?: number;
} & {
  registrants?: readonly {
     id?: string;
   } & {
     address?: string;
     city?: string;
     comments?: string;
     country?: string;
     custom_questions?: readonly {
        title?: string;
        value?: string;
     }[];
     email: string;
     first_name: string;
     industry?: string;
     job_title?: string;
     last_name?: string;
     no_of_employees?:   | ""
        | "1-20"
        | "21-50"
        | "51-100"
        | "101-250"
        | "251-500"
        | "501-1,000"
        | "1,001-5,000"
        | "5,001-10,000"
        | "More than 10,000";
     org?: string;
     phone?: string;
     purchasing_time_frame?:   | ""
        | "Within a month"
        | "1-3 months"
        | "4-6 months"
        | "More than 6 months"
        | "No timeframe";
     role_in_purchase_process?:   | ""
        | "Decision Maker"
        | "Evaluator/Recommender"
        | "Influencer"
        | "Not involved";
     state?: string;
     status?: "pending" | "approved" | "denied";
     zip?: string;
   } & {
     create_time?: string;
     join_url?: string;
     status?: string;
  }[];
};

Type Declaration¶

next_page_token?¶

optional next_page_token?: string;

page_count?¶

optional page_count?: number;

page_number?¶

optional page_number?: number;

page_size?¶

optional page_size?: number;

total_records?¶

optional total_records?: number;

Type Declaration¶

registrants?¶

optional registrants?: readonly {
  id?: string;
} & {
  address?: string;
  city?: string;
  comments?: string;
  country?: string;
  custom_questions?: readonly {
     title?: string;
     value?: string;
  }[];
  email: string;
  first_name: string;
  industry?: string;
  job_title?: string;
  last_name?: string;
  no_of_employees?:   | ""
     | "1-20"
     | "21-50"
     | "51-100"
     | "101-250"
     | "251-500"
     | "501-1,000"
     | "1,001-5,000"
     | "5,001-10,000"
     | "More than 10,000";
  org?: string;
  phone?: string;
  purchasing_time_frame?:   | ""
     | "Within a month"
     | "1-3 months"
     | "4-6 months"
     | "More than 6 months"
     | "No timeframe";
  role_in_purchase_process?:   | ""
     | "Decision Maker"
     | "Evaluator/Recommender"
     | "Influencer"
     | "Not involved";
  state?: string;
  status?: "pending" | "approved" | "denied";
  zip?: string;
} & {
  create_time?: string;
  join_url?: string;
  status?: string;
}[];

GET /past_webinars/{webinarId}/instances¶

GET /past_webinars/{webinarId}/instances: {
  webinars?: readonly {
     start_time?: string;
     uuid?: string;
  }[];
};

webinars?¶

optional webinars?: readonly {
  start_time?: string;
  uuid?: string;
}[];

GET /past_webinars/{webinarId}/participants¶

GET /past_webinars/{webinarId}/participants: {
  next_page_token?: string;
  page_count?: number;
  page_size?: number;
  participants?: readonly {
     duration?: number;
     failover?: boolean;
     id?: string;
     internal_user?: boolean;
     join_time?: string;
     leave_time?: string;
     name?: string;
     registrant_id?: string;
     status?: "in_meeting" | "in_waiting_room";
     user_email?: string;
     user_id?: string;
  }[];
  total_records?: number;
};

next_page_token?¶

optional next_page_token?: string;

page_count?¶

optional page_count?: number;

page_size?¶

optional page_size?: number;

participants?¶

optional participants?: readonly {
  duration?: number;
  failover?: boolean;
  id?: string;
  internal_user?: boolean;
  join_time?: string;
  leave_time?: string;
  name?: string;
  registrant_id?: string;
  status?: "in_meeting" | "in_waiting_room";
  user_email?: string;
  user_id?: string;
}[];

total_records?¶

optional total_records?: number;

GET /past_webinars/{webinarId}/polls¶

GET /past_webinars/{webinarId}/polls: {
  id?: number;
  questions?: readonly {
     email?: string;
     name?: string;
     question_details?: readonly {
        answer?: string;
        date_time?: string;
        polling_id?: string;
        question?: string;
     }[];
  }[];
  start_time?: string;
  uuid?: string;
};

id?¶

optional id?: number;

questions?¶

optional questions?: readonly {
  email?: string;
  name?: string;
  question_details?: readonly {
     answer?: string;
     date_time?: string;
     polling_id?: string;
     question?: string;
  }[];
}[];

start_time?¶

optional start_time?: string;

uuid?¶

optional uuid?: string;

GET /past_webinars/{webinarId}/qa¶

GET /past_webinars/{webinarId}/qa: {
  id?: number;
  questions?: readonly {
     email?: string;
     name?: string;
     question_details?: readonly {
        answer?: string;
        question?: string;
     }[];
  }[];
  start_time?: string;
  uuid?: string;
};

id?¶

optional id?: number;

questions?¶

optional questions?: readonly {
  email?: string;
  name?: string;
  question_details?: readonly {
     answer?: string;
     question?: string;
  }[];
}[];

start_time?¶

optional start_time?: string;

uuid?¶

optional uuid?: string;

GET /report/activities¶

GET /report/activities: {
  activity_logs?: readonly {
     client_type?: string;
     email?: string;
     ip_address?: string;
     time?: string;
     type?: "Sign in" | "Sign out";
     version?: string;
  }[];
  from?: string;
  next_page_token?: string;
  page_size?: number;
  to?: string;
};

activity_logs?¶

optional activity_logs?: readonly {
  client_type?: string;
  email?: string;
  ip_address?: string;
  time?: string;
  type?: "Sign in" | "Sign out";
  version?: string;
}[];

from?¶

optional from?: string;

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

to?¶

optional to?: string;

GET /report/billing¶

GET /report/billing: {
  billing_reports?: readonly {
     end_date?: string;
     id?: string;
     start_date?: string;
     tax_amount?: string;
     total_amount?: string;
     type?: 0 | 1;
  }[];
  currency?: string;
};

billing_reports?¶

optional billing_reports?: readonly {
  end_date?: string;
  id?: string;
  start_date?: string;
  tax_amount?: string;
  total_amount?: string;
  type?: 0 | 1;
}[];

currency?¶

optional currency?: string;

GET /report/billing/invoices¶

GET /report/billing/invoices: {
  currency?: string;
  invoices?: readonly {
     end_date?: string;
     invoice_charge_name?: string;
     invoice_number?: string;
     quantity?: number;
     start_date?: string;
     tax_amount?: string;
     total_amount?: string;
  }[];
};

currency?¶

optional currency?: string;

invoices?¶

optional invoices?: readonly {
  end_date?: string;
  invoice_charge_name?: string;
  invoice_number?: string;
  quantity?: number;
  start_date?: string;
  tax_amount?: string;
  total_amount?: string;
}[];

GET /report/cloud_recording¶

GET /report/cloud_recording: {
  from?: string;
  to?: string;
} & {
  cloud_recording_storage?: readonly {
     date?: string;
     free_usage?: string;
     plan_usage?: string;
     usage?: string;
  }[];
};

Type Declaration¶

from?¶

optional from?: string;

to?¶

optional to?: string;

Type Declaration¶

cloud_recording_storage?¶

optional cloud_recording_storage?: readonly {
  date?: string;
  free_usage?: string;
  plan_usage?: string;
  usage?: string;
}[];

GET /report/daily¶

GET /report/daily: {
  dates?: readonly {
     date?: string;
     meeting_minutes?: number;
     meetings?: number;
     new_users?: number;
     participants?: number;
  }[];
  month?: number;
  year?: number;
};

dates?¶

optional dates?: readonly {
  date?: string;
  meeting_minutes?: number;
  meetings?: number;
  new_users?: number;
  participants?: number;
}[];

month?¶

optional month?: number;

year?¶

optional year?: number;

GET /report/disclaimer¶

GET /report/disclaimer: {
  disclaimer_records?: readonly {
     client_type?: string;
     disclaimer_status?: "Agree" | "Cancel" | "Passive Agree" | "Decline Attend";
     disclaimer_type?: string;
     display_name?: string;
     group_ids?: readonly string[];
     is_guest?: boolean;
     is_zoom_event?: boolean;
     meeting_id?: string;
     meeting_number?: number;
     time?: string;
     user_email?: string;
  }[];
  next_page_token?: string;
  page_size?: number;
};

disclaimer_records?¶

optional disclaimer_records?: readonly {
  client_type?: string;
  disclaimer_status?: "Agree" | "Cancel" | "Passive Agree" | "Decline Attend";
  disclaimer_type?: string;
  display_name?: string;
  group_ids?: readonly string[];
  is_guest?: boolean;
  is_zoom_event?: boolean;
  meeting_id?: string;
  meeting_number?: number;
  time?: string;
  user_email?: string;
}[];

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

GET /report/history_meetings¶

GET /report/history_meetings: {
  history_meetings?: readonly {
     create_time?: string;
     custom_fields?: readonly {
        key?: string;
        value?: string;
     }[];
     department?: string;
     duration?: number;
     end_time?: string;
     feature_used?: {
        annotation?: boolean;
        avatar?: boolean;
        breakout_room?: boolean;
        closed_caption?: boolean;
        color_themes?: boolean;
        document_collaboration?: boolean;
        file_sharing?: boolean;
        gen_ai_virtual_background?: boolean;
        immersive_scene?: boolean;
        in_meeting_chat?: boolean;
        join_by_room?: boolean;
        language_interpretation?: boolean;
        live_transcription?: boolean;
        live_translation?: boolean;
        meeting_questions?: boolean;
        meeting_summary?: boolean;
        meeting_wallpaper?: boolean;
        multi_share?: boolean;
        multi_speaker?: boolean;
        personalized_audio_isolation?: boolean;
        poll?: boolean;
        portrait_lighting?: boolean;
        raise_hand?: boolean;
        reaction?: boolean;
        record_to_cloud?: boolean;
        record_to_computer?: boolean;
        registration?: boolean;
        remote_control?: boolean;
        screen_sharing?: boolean;
        smart_recording?: boolean;
        switch_to_mobile?: boolean;
        telephone_usage?: boolean;
        video_on?: boolean;
        virtual_background?: boolean;
        waiting_room?: boolean;
        whiteboard?: boolean;
        zoom_apps?: boolean;
     };
     group?: readonly string[];
     host_display_name?: string;
     host_email?: string;
     max_concurrent_views?: number;
     meeting_id?: number;
     meeting_uuid?: string;
     participants?: number;
     source?: string;
     start_time?: string;
     topic?: string;
     total_participant_minutes?: number;
     tracking_fields?: readonly {
        field?: string;
        value?: string;
     }[];
     type?: "Meeting" | "Webinar";
     unique_viewers?: number;
  }[];
  next_page_token?: string;
  page_size?: number;
};

history_meetings?¶

optional history_meetings?: readonly {
  create_time?: string;
  custom_fields?: readonly {
     key?: string;
     value?: string;
  }[];
  department?: string;
  duration?: number;
  end_time?: string;
  feature_used?: {
     annotation?: boolean;
     avatar?: boolean;
     breakout_room?: boolean;
     closed_caption?: boolean;
     color_themes?: boolean;
     document_collaboration?: boolean;
     file_sharing?: boolean;
     gen_ai_virtual_background?: boolean;
     immersive_scene?: boolean;
     in_meeting_chat?: boolean;
     join_by_room?: boolean;
     language_interpretation?: boolean;
     live_transcription?: boolean;
     live_translation?: boolean;
     meeting_questions?: boolean;
     meeting_summary?: boolean;
     meeting_wallpaper?: boolean;
     multi_share?: boolean;
     multi_speaker?: boolean;
     personalized_audio_isolation?: boolean;
     poll?: boolean;
     portrait_lighting?: boolean;
     raise_hand?: boolean;
     reaction?: boolean;
     record_to_cloud?: boolean;
     record_to_computer?: boolean;
     registration?: boolean;
     remote_control?: boolean;
     screen_sharing?: boolean;
     smart_recording?: boolean;
     switch_to_mobile?: boolean;
     telephone_usage?: boolean;
     video_on?: boolean;
     virtual_background?: boolean;
     waiting_room?: boolean;
     whiteboard?: boolean;
     zoom_apps?: boolean;
  };
  group?: readonly string[];
  host_display_name?: string;
  host_email?: string;
  max_concurrent_views?: number;
  meeting_id?: number;
  meeting_uuid?: string;
  participants?: number;
  source?: string;
  start_time?: string;
  topic?: string;
  total_participant_minutes?: number;
  tracking_fields?: readonly {
     field?: string;
     value?: string;
  }[];
  type?: "Meeting" | "Webinar";
  unique_viewers?: number;
}[];

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

GET /report/meeting_activities¶

GET /report/meeting_activities: {
  meeting_activity_logs?: readonly {
     activity_category: string;
     activity_detail: string;
     activity_time: string;
     meeting_number: string;
     operator: string;
     operator_email: string;
  }[];
  next_page_token?: string;
  page_size?: number;
};

meeting_activity_logs?¶

optional meeting_activity_logs?: readonly {
  activity_category: string;
  activity_detail: string;
  activity_time: string;
  meeting_number: string;
  operator: string;
  operator_email: string;
}[];

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

GET /report/meetings/{meetingId}¶

GET /report/meetings/{meetingId}: {
  custom_keys?: readonly {
     key?: string;
     value?: string;
  }[];
  dept?: string;
  duration?: number;
  end_time?: string;
  id?: number;
  participants_count?: number;
  start_time?: string;
  topic?: string;
  total_minutes?: number;
  tracking_fields?: readonly {
     field?: string;
     value?: string;
  }[];
  type?: number;
  user_email?: string;
  user_name?: string;
  uuid?: string;
};

custom_keys?¶

optional custom_keys?: readonly {
  key?: string;
  value?: string;
}[];

dept?¶

optional dept?: string;

duration?¶

optional duration?: number;

end_time?¶

optional end_time?: string;

id?¶

optional id?: number;

participants_count?¶

optional participants_count?: number;

start_time?¶

optional start_time?: string;

topic?¶

optional topic?: string;

total_minutes?¶

optional total_minutes?: number;

tracking_fields?¶

optional tracking_fields?: readonly {
  field?: string;
  value?: string;
}[];

type?¶

optional type?: number;

user_email?¶

optional user_email?: string;

user_name?¶

optional user_name?: string;

uuid?¶

optional uuid?: string;

GET /report/meetings/{meetingId}/participants¶

GET /report/meetings/{meetingId}/participants: {
  next_page_token?: string;
  page_count?: number;
  page_size?: number;
  total_records?: number;
} & {
  participants?: readonly {
     bo_mtg_id?: string;
     customer_key?: string;
     duration?: number;
     failover?: boolean;
     id?: string;
     join_time?: string;
     leave_time?: string;
     name?: string;
     participant_user_id?: string;
     registrant_id?: string;
     status?: "in_meeting" | "in_waiting_room";
     user_email?: string;
     user_id?: string;
  }[];
};

Type Declaration¶

next_page_token?¶

optional next_page_token?: string;

page_count?¶

optional page_count?: number;

page_size?¶

optional page_size?: number;

total_records?¶

optional total_records?: number;

Type Declaration¶

participants?¶

optional participants?: readonly {
  bo_mtg_id?: string;
  customer_key?: string;
  duration?: number;
  failover?: boolean;
  id?: string;
  join_time?: string;
  leave_time?: string;
  name?: string;
  participant_user_id?: string;
  registrant_id?: string;
  status?: "in_meeting" | "in_waiting_room";
  user_email?: string;
  user_id?: string;
}[];

GET /report/meetings/{meetingId}/polls¶

GET /report/meetings/{meetingId}/polls: {
  id?: number;
  questions?: readonly {
     email?: string;
     first_name?: string;
     last_name?: string;
     name?: string;
     question_details?: readonly {
        answer?: string;
        date_time?: string;
        polling_id?: string;
        question?: string;
     }[];
  }[];
  start_time?: string;
  uuid?: string;
};

id?¶

optional id?: number;

questions?¶

optional questions?: readonly {
  email?: string;
  first_name?: string;
  last_name?: string;
  name?: string;
  question_details?: readonly {
     answer?: string;
     date_time?: string;
     polling_id?: string;
     question?: string;
  }[];
}[];

start_time?¶

optional start_time?: string;

uuid?¶

optional uuid?: string;

GET /report/meetings/{meetingId}/qa¶

GET /report/meetings/{meetingId}/qa: {
  id?: number;
  questions?: readonly {
     email?: string;
     name?: string;
     question_details?: readonly {
        answer?: string;
        answer_details?: readonly {
           content?: string;
           create_time?: string;
           email?: string;
           name?: string;
           type?:   | "default"
              | "host_answered_publicly"
              | "host_answered_privately"
              | "participant_commented"
              | "host_answered";
           user_id?: string;
        }[];
        create_time?: string;
        question?: string;
        question_id?: string;
        question_status?: "open" | "answered" | "default" | "deleted" | "dismissed";
     }[];
     user_id?: string;
  }[];
  start_time?: string;
  uuid?: string;
};

id?¶

optional id?: number;

questions?¶

optional questions?: readonly {
  email?: string;
  name?: string;
  question_details?: readonly {
     answer?: string;
     answer_details?: readonly {
        content?: string;
        create_time?: string;
        email?: string;
        name?: string;
        type?:   | "default"
           | "host_answered_publicly"
           | "host_answered_privately"
           | "participant_commented"
           | "host_answered";
        user_id?: string;
     }[];
     create_time?: string;
     question?: string;
     question_id?: string;
     question_status?: "open" | "answered" | "default" | "deleted" | "dismissed";
  }[];
  user_id?: string;
}[];

start_time?¶

optional start_time?: string;

uuid?¶

optional uuid?: string;

GET /report/meetings/{meetingId}/survey¶

GET /report/meetings/{meetingId}/survey: {
  meeting_id?: number;
  meeting_uuid?: string;
  start_time?: string;
  survey_answers?: readonly {
     answer_details?: readonly {
        answer?: string;
        date_time?: string;
        question?: string;
        question_id?: string;
     }[];
     email?: string;
     first_name?: string;
     last_name?: string;
     name?: string;
  }[];
  survey_id?: string;
  survey_name?: string;
};

meeting_id?¶

optional meeting_id?: number;

meeting_uuid?¶

optional meeting_uuid?: string;

start_time?¶

optional start_time?: string;

survey_answers?¶

optional survey_answers?: readonly {
  answer_details?: readonly {
     answer?: string;
     date_time?: string;
     question?: string;
     question_id?: string;
  }[];
  email?: string;
  first_name?: string;
  last_name?: string;
  name?: string;
}[];

survey_id?¶

optional survey_id?: string;

survey_name?¶

optional survey_name?: string;

GET /report/operationlogs¶

GET /report/operationlogs: {
  next_page_token?: string;
  page_size?: number;
} & {
  operation_logs?: readonly {
     action?: string;
     category_type?: string;
     operation_detail?: string;
     operator?: string;
     time?: string;
  }[];
};

Type Declaration¶

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

Type Declaration¶

operation_logs?¶

optional operation_logs?: readonly {
  action?: string;
  category_type?: string;
  operation_detail?: string;
  operator?: string;
  time?: string;
}[];

GET /report/remote_support¶

GET /report/remote_support: {
  next_page_token?: string;
  page_size?: number;
  remote_support_logs?: readonly {
     duration?: string;
     end_time?: string;
     meeting_host_id?: string;
     meeting_number?: number;
     meeting_start_time?: string;
     meeting_uuid?: string;
     request_time?: string;
     start_time?: string;
     supportee_email?: string;
     supportee_name?: string;
     supporter_email?: string;
     supporter_name?: string;
     topic?: string;
     wait_time?: string;
  }[];
};

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

remote_support_logs?¶

optional remote_support_logs?: readonly {
  duration?: string;
  end_time?: string;
  meeting_host_id?: string;
  meeting_number?: number;
  meeting_start_time?: string;
  meeting_uuid?: string;
  request_time?: string;
  start_time?: string;
  supportee_email?: string;
  supportee_name?: string;
  supporter_email?: string;
  supporter_name?: string;
  topic?: string;
  wait_time?: string;
}[];

GET /report/telephone¶

GET /report/telephone: {
  from?: string;
  next_page_token?: string;
  page_count?: number;
  page_size?: number;
  to?: string;
  total_records?: number;
} & {
  telephony_usage?: readonly {
     call_in_number?: string;
     country_name?: string;
     dept?: string;
     duration?: number;
     end_time?: string;
     host_email?: string;
     host_id?: string;
     host_name?: string;
     meeting_id?: number;
     meeting_type?: string;
     phone_number?: string;
     rate?: number;
     signaled_number?: string;
     start_time?: string;
     total?: number;
     type?:   | "toll-free"
        | "call-out"
        | "call-in"
        | "US toll-number"
        | "global toll-number"
        | "premium"
        | "premium call-in"
        | "Toll";
     uuid?: string;
  }[];
};

Type Declaration¶

from?¶

optional from?: string;

next_page_token?¶

optional next_page_token?: string;

page_count?¶

optional page_count?: number;

page_size?¶

optional page_size?: number;

to?¶

optional to?: string;

total_records?¶

optional total_records?: number;

Type Declaration¶

telephony_usage?¶

optional telephony_usage?: readonly {
  call_in_number?: string;
  country_name?: string;
  dept?: string;
  duration?: number;
  end_time?: string;
  host_email?: string;
  host_id?: string;
  host_name?: string;
  meeting_id?: number;
  meeting_type?: string;
  phone_number?: string;
  rate?: number;
  signaled_number?: string;
  start_time?: string;
  total?: number;
  type?:   | "toll-free"
     | "call-out"
     | "call-in"
     | "US toll-number"
     | "global toll-number"
     | "premium"
     | "premium call-in"
     | "Toll";
  uuid?: string;
}[];

GET /report/upcoming_events¶

GET /report/upcoming_events: {
  from?: string;
  next_page_token?: string;
  page_size?: number;
  to?: string;
  upcoming_events?: readonly {
     dept?: string;
     host_id?: string;
     host_name?: string;
     id?: string;
     start_time?: string;
     topic?: string;
  }[];
};

from?¶

optional from?: string;

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

to?¶

optional to?: string;

upcoming_events?¶

optional upcoming_events?: readonly {
  dept?: string;
  host_id?: string;
  host_name?: string;
  id?: string;
  start_time?: string;
  topic?: string;
}[];

GET /report/users¶

GET /report/users: {
  from?: string;
  next_page_token?: string;
  page_count?: number;
  page_number?: number;
  page_size?: number;
  to?: string;
  total_records?: number;
} & {
  total_meeting_minutes?: number;
  total_meetings?: number;
  total_participants?: number;
  users?: readonly {
     custom_attributes?: readonly {
        key?: string;
        name?: string;
        value?: string;
     }[];
     dept?: string;
     email?: string;
     id?: string;
     meeting_minutes?: number;
     meetings?: number;
     participants?: number;
     type?: number;
     user_name?: string;
  }[];
};

Type Declaration¶

from?¶

optional from?: string;

next_page_token?¶

optional next_page_token?: string;

page_count?¶

optional page_count?: number;

page_number?¶

optional page_number?: number;

page_size?¶

optional page_size?: number;

to?¶

optional to?: string;

total_records?¶

optional total_records?: number;

Type Declaration¶

total_meeting_minutes?¶

optional total_meeting_minutes?: number;

total_meetings?¶

optional total_meetings?: number;

total_participants?¶

optional total_participants?: number;

users?¶

optional users?: readonly {
  custom_attributes?: readonly {
     key?: string;
     name?: string;
     value?: string;
  }[];
  dept?: string;
  email?: string;
  id?: string;
  meeting_minutes?: number;
  meetings?: number;
  participants?: number;
  type?: number;
  user_name?: string;
}[];

GET /report/users/{userId}/meetings¶

GET /report/users/{userId}/meetings: {
  next_page_token?: string;
  page_count?: number;
  page_number?: number;
  page_size?: number;
  total_records?: number;
} & {
  from?: string;
  meetings?: readonly {
     custom_keys?: readonly {
        key?: string;
        value?: string;
     }[];
     duration?: number;
     end_time?: string;
     has_chat?: boolean;
     has_recording?: boolean;
     has_screen_share?: boolean;
     host_name?: string;
     host_organization?: string;
     id?: number;
     join_time?: string;
     join_waiting_room_time?: string;
     leave_time?: string;
     meeting_encryption_status?: 1 | 2;
     participants_count?: number;
     participants_count_my_account?: number;
     schedule_time?: string;
     session_key?: string;
     source?: string;
     start_time?: string;
     topic?: string;
     total_minutes?: number;
     type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
     user_email?: string;
     user_name?: string;
     uuid?: string;
  }[];
  next_page_token?: string;
  to?: string;
};

Type Declaration¶

next_page_token?¶

optional next_page_token?: string;

page_count?¶

optional page_count?: number;

page_number?¶

optional page_number?: number;

page_size?¶

optional page_size?: number;

total_records?¶

optional total_records?: number;

Type Declaration¶

from?¶

optional from?: string;

meetings?¶

optional meetings?: readonly {
  custom_keys?: readonly {
     key?: string;
     value?: string;
  }[];
  duration?: number;
  end_time?: string;
  has_chat?: boolean;
  has_recording?: boolean;
  has_screen_share?: boolean;
  host_name?: string;
  host_organization?: string;
  id?: number;
  join_time?: string;
  join_waiting_room_time?: string;
  leave_time?: string;
  meeting_encryption_status?: 1 | 2;
  participants_count?: number;
  participants_count_my_account?: number;
  schedule_time?: string;
  session_key?: string;
  source?: string;
  start_time?: string;
  topic?: string;
  total_minutes?: number;
  type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
  user_email?: string;
  user_name?: string;
  uuid?: string;
}[];

next_page_token?¶

optional next_page_token?: string;

to?¶

optional to?: string;

GET /report/webinars/{webinarId}¶

GET /report/webinars/{webinarId}: {
  custom_keys?: readonly {
     key?: string;
     value?: string;
  }[];
  dept?: string;
  duration?: number;
  end_time?: string;
  id?: number;
  participants_count?: number;
  start_time?: string;
  topic?: string;
  total_minutes?: number;
  tracking_fields?: readonly {
     field?: string;
     value?: string;
  }[];
  type?: number;
  user_email?: string;
  user_name?: string;
  uuid?: string;
};

custom_keys?¶

optional custom_keys?: readonly {
  key?: string;
  value?: string;
}[];

dept?¶

optional dept?: string;

duration?¶

optional duration?: number;

end_time?¶

optional end_time?: string;

id?¶

optional id?: number;

participants_count?¶

optional participants_count?: number;

start_time?¶

optional start_time?: string;

topic?¶

optional topic?: string;

total_minutes?¶

optional total_minutes?: number;

tracking_fields?¶

optional tracking_fields?: readonly {
  field?: string;
  value?: string;
}[];

type?¶

optional type?: number;

user_email?¶

optional user_email?: string;

user_name?¶

optional user_name?: string;

uuid?¶

optional uuid?: string;

GET /report/webinars/{webinarId}/participants¶

GET /report/webinars/{webinarId}/participants: {
  next_page_token?: string;
  page_count?: number;
  page_size?: number;
  total_records?: number;
} & {
  participants?: readonly {
     bo_mtg_id?: string;
     customer_key?: string;
     duration?: number;
     failover?: boolean;
     id?: string;
     join_time?: string;
     leave_time?: string;
     name?: string;
     participant_user_id?: string;
     registrant_id?: string;
     status?: "in_meeting" | "in_waiting_room";
     user_email?: string;
     user_id?: string;
  }[];
};

Type Declaration¶

next_page_token?¶

optional next_page_token?: string;

page_count?¶

optional page_count?: number;

page_size?¶

optional page_size?: number;

total_records?¶

optional total_records?: number;

Type Declaration¶

participants?¶

optional participants?: readonly {
  bo_mtg_id?: string;
  customer_key?: string;
  duration?: number;
  failover?: boolean;
  id?: string;
  join_time?: string;
  leave_time?: string;
  name?: string;
  participant_user_id?: string;
  registrant_id?: string;
  status?: "in_meeting" | "in_waiting_room";
  user_email?: string;
  user_id?: string;
}[];

GET /report/webinars/{webinarId}/polls¶

GET /report/webinars/{webinarId}/polls: {
  id?: number;
  questions?: readonly {
     email?: string;
     first_name?: string;
     last_name?: string;
     name?: string;
     question_details?: readonly {
        answer?: string;
        date_time?: string;
        polling_id?: string;
        question?: string;
     }[];
  }[];
  start_time?: string;
  uuid?: string;
};

id?¶

optional id?: number;

questions?¶

optional questions?: readonly {
  email?: string;
  first_name?: string;
  last_name?: string;
  name?: string;
  question_details?: readonly {
     answer?: string;
     date_time?: string;
     polling_id?: string;
     question?: string;
  }[];
}[];

start_time?¶

optional start_time?: string;

uuid?¶

optional uuid?: string;

GET /report/webinars/{webinarId}/qa¶

GET /report/webinars/{webinarId}/qa: {
  id?: number;
  questions?: readonly {
     email?: string;
     name?: string;
     question_details?: readonly {
        answer?: string;
        answer_details?: readonly {
           content?: string;
           create_time?: string;
           email?: string;
           name?: string;
           type?:   | "default"
              | "host_answered_publicly"
              | "host_answered_privately"
              | "participant_commented"
              | "host_answered";
           user_id?: string;
        }[];
        create_time?: string;
        question?: string;
        question_id?: string;
        question_status?: "open" | "answered" | "default" | "deleted" | "dismissed";
     }[];
     user_id?: string;
  }[];
  start_time?: string;
  uuid?: string;
};

id?¶

optional id?: number;

questions?¶

optional questions?: readonly {
  email?: string;
  name?: string;
  question_details?: readonly {
     answer?: string;
     answer_details?: readonly {
        content?: string;
        create_time?: string;
        email?: string;
        name?: string;
        type?:   | "default"
           | "host_answered_publicly"
           | "host_answered_privately"
           | "participant_commented"
           | "host_answered";
        user_id?: string;
     }[];
     create_time?: string;
     question?: string;
     question_id?: string;
     question_status?: "open" | "answered" | "default" | "deleted" | "dismissed";
  }[];
  user_id?: string;
}[];

start_time?¶

optional start_time?: string;

uuid?¶

optional uuid?: string;

GET /report/webinars/{webinarId}/survey¶

GET /report/webinars/{webinarId}/survey: {
  start_time?: string;
  survey_answers?: readonly {
     answer_details?: readonly {
        answer?: string;
        date_time?: string;
        question?: string;
        question_id?: string;
     }[];
     email?: string;
     first_name?: string;
     last_name?: string;
     name?: string;
  }[];
  survey_id?: string;
  survey_name?: string;
  webinar_id?: number;
  webinar_uuid?: string;
};

start_time?¶

optional start_time?: string;

survey_answers?¶

optional survey_answers?: readonly {
  answer_details?: readonly {
     answer?: string;
     date_time?: string;
     question?: string;
     question_id?: string;
  }[];
  email?: string;
  first_name?: string;
  last_name?: string;
  name?: string;
}[];

survey_id?¶

optional survey_id?: string;

survey_name?¶

optional survey_name?: string;

webinar_id?¶

optional webinar_id?: number;

webinar_uuid?¶

optional webinar_uuid?: string;

GET /sip_phones/phones¶

GET /sip_phones/phones: {
  next_page_token?: string;
  page_size?: number;
  phones?: readonly {
     authorization_name?: string;
     display_number?: string;
     domain?: string;
     password?: string;
     phone_id?: string;
     registration_expire_time?: number;
     server?: {
        proxy_server?: string;
        register_server?: string;
        transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
     };
     server_2?: {
        proxy_server?: string;
        register_server?: string;
        transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
     };
     server_3?: {
        proxy_server?: string;
        register_server?: string;
        transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
     };
     user_email?: string;
     user_name?: string;
     voice_mail?: string;
  }[];
};

next_page_token?¶

optional next_page_token?: string;

page_size?¶

optional page_size?: number;

phones?¶

optional phones?: readonly {
  authorization_name?: string;
  display_number?: string;
  domain?: string;
  password?: string;
  phone_id?: string;
  registration_expire_time?: number;
  server?: {
     proxy_server?: string;
     register_server?: string;
     transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
  };
  server_2?: {
     proxy_server?: string;
     register_server?: string;
     transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
  };
  server_3?: {
     proxy_server?: string;
     register_server?: string;
     transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
  };
  user_email?: string;
  user_name?: string;
  voice_mail?: string;
}[];

GET /tracking_fields¶

GET /tracking_fields: {
  total_records?: number;
  tracking_fields?: readonly {
     field?: string;
     id?: string;
     recommended_values?: readonly string[];
     required?: boolean;
     visible?: boolean;
  }[];
};

total_records?¶

optional total_records?: number;

tracking_fields?¶

optional tracking_fields?: readonly {
  field?: string;
  id?: string;
  recommended_values?: readonly string[];
  required?: boolean;
  visible?: boolean;
}[];

GET /tracking_fields/{fieldId}¶

GET /tracking_fields/{fieldId}: {
  field?: string;
  id?: string;
  recommended_values?: readonly string[];
  required?: boolean;
  visible?: boolean;
};

field?¶

optional field?: string;

id?¶

optional id?: string;

recommended_values?¶

optional recommended_values?: readonly string[];

required?¶

optional required?: boolean;

visible?¶

optional visible?: boolean;

GET /tsp¶

GET /tsp: {
  dial_in_number_unrestricted?: boolean;
  dial_in_numbers?: readonly {
     code?: string;
     number?: string;
     type?: string;
  }[];
  enable?: boolean;
  master_account_setting_extended?: boolean;
  modify_credential_forbidden?: boolean;
  tsp_bridge?: "US_TSP_TB" | "EU_TSP_TB";
  tsp_enabled?: boolean;
  tsp_provider?: string;
};

dial_in_number_unrestricted?¶

optional dial_in_number_unrestricted?: boolean;

dial_in_numbers?¶

optional dial_in_numbers?: readonly {
  code?: string;
  number?: string;
  type?: string;
}[];

enable?¶

optional enable?: boolean;

master_account_setting_extended?¶

optional master_account_setting_extended?: boolean;

modify_credential_forbidden?¶

optional modify_credential_forbidden?: boolean;

tsp_bridge?¶

optional tsp_bridge?: "US_TSP_TB" | "EU_TSP_TB";

tsp_enabled?¶

optional tsp_enabled?: boolean;

tsp_provider?¶

optional tsp_provider?: string;

GET /users/{userId}/meeting_templates¶

GET /users/{userId}/meeting_templates: {
  templates?: readonly {
     id?: string;
     name?: string;
     type?: number;
  }[];
  total_records?: number;
};

templates?¶

optional templates?: readonly {
  id?: string;
  name?: string;
  type?: number;
}[];

total_records?¶

optional total_records?: number;

GET /users/{userId}/meetings¶

GET /users/{userId}/meetings: {
  next_page_token?: string;
  page_count?: number;
  page_number?: number;
  page_size?: number;
  total_records?: number;
} & {
  meetings?: readonly {
     agenda?: string;
     created_at?: string;
     duration?: number;
     host_id?: string;
     id?: number;
     join_url?: string;
     pmi?: string;
     start_time?: string;
     timezone?: string;
     topic?: string;
     type?: 1 | 2 | 3 | 8;
     uuid?: string;
  }[];
};

Type Declaration¶

next_page_token?¶

optional next_page_token?: string;

page_count?¶

optional page_count?: number;

page_number?¶

optional page_number?: number;

page_size?¶

optional page_size?: number;

total_records?¶

optional total_records?: number;

Type Declaration¶

meetings?¶

optional meetings?: readonly {
  agenda?: string;
  created_at?: string;
  duration?: number;
  host_id?: string;
  id?: number;
  join_url?: string;
  pmi?: string;
  start_time?: string;
  timezone?: string;
  topic?: string;
  type?: 1 | 2 | 3 | 8;
  uuid?: string;
}[];

GET /users/{userId}/pac¶

GET /users/{userId}/pac: {
  pac_accounts?: readonly {
     conference_id?: number;
     dedicated_dial_in_number?: readonly {
        country?: string;
        number?: string;
     }[];
     global_dial_in_numbers?: readonly {
        country?: string;
        number?: string;
     }[];
     listen_only_password?: string;
     participant_password?: string;
  }[];
};

pac_accounts?¶

optional pac_accounts?: readonly {
  conference_id?: number;
  dedicated_dial_in_number?: readonly {
     country?: string;
     number?: string;
  }[];
  global_dial_in_numbers?: readonly {
     country?: string;
     number?: string;
  }[];
  listen_only_password?: string;
  participant_password?: string;
}[];

GET /users/{userId}/recordings¶

GET /users/{userId}/recordings: {
  from?: string;
  to?: string;
} & {
  next_page_token?: string;
  page_count?: number;
  page_size?: number;
  total_records?: number;
} & {
  meetings?: readonly {
     account_id?: string;
     auto_delete?: boolean;
     auto_delete_date?: string;
     duration?: number;
     host_id?: string;
     id?: number;
     recording_count?: number;
     recording_play_passcode?: string;
     start_time?: string;
     topic?: string;
     total_size?: number;
     type?: "2" | "1" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "99";
     uuid?: string;
   } & {
     recording_files?: readonly {
        deleted_time?: string;
        download_url?: string;
        file_extension?: "JSON" | "MP4" | "M4A" | "CSV" | "TXT" | "VTT" | "JPG";
        file_path?: string;
        file_size?: number;
        file_type?:   | "MP4"
           | "M4A"
           | "CHAT"
           | "CC"
           | "CHAT_MESSAGE"
           | "TRANSCRIPT"
           | "CSV"
           | "TB"
           | "SUMMARY";
        id?: string;
        meeting_id?: string;
        play_url?: string;
        recording_end?: string;
        recording_start?: string;
        recording_type?:   | "summary"
           | "shared_screen_with_speaker_view"
           | "audio_only"
           | "chat_file"
           | "closed_caption"
           | "audio_transcript"
           | "shared_screen_with_speaker_view(CC)"
           | "shared_screen_with_gallery_view"
           | "active_speaker"
           | "gallery_view"
           | "shared_screen"
           | "poll"
           | "host_video"
           | "timeline"
           | "thumbnail"
           | "audio_interpretation"
           | "summary_next_steps"
           | "summary_smart_chapters"
           | "sign_interpretation"
           | "production_studio";
        status?: "completed";
     }[];
  }[];
};

Type Declaration¶

from?¶

optional from?: string;

to?¶

optional to?: string;

Type Declaration¶

next_page_token?¶

optional next_page_token?: string;

page_count?¶

optional page_count?: number;

page_size?¶

optional page_size?: number;

total_records?¶

optional total_records?: number;

Type Declaration¶

meetings?¶

optional meetings?: readonly {
  account_id?: string;
  auto_delete?: boolean;
  auto_delete_date?: string;
  duration?: number;
  host_id?: string;
  id?: number;
  recording_count?: number;
  recording_play_passcode?: string;
  start_time?: string;
  topic?: string;
  total_size?: number;
  type?: "2" | "1" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "99";
  uuid?: string;
} & {
  recording_files?: readonly {
     deleted_time?: string;
     download_url?: string;
     file_extension?: "JSON" | "MP4" | "M4A" | "CSV" | "TXT" | "VTT" | "JPG";
     file_path?: string;
     file_size?: number;
     file_type?:   | "MP4"
        | "M4A"
        | "CHAT"
        | "CC"
        | "CHAT_MESSAGE"
        | "TRANSCRIPT"
        | "CSV"
        | "TB"
        | "SUMMARY";
     id?: string;
     meeting_id?: string;
     play_url?: string;
     recording_end?: string;
     recording_start?: string;
     recording_type?:   | "summary"
        | "shared_screen_with_speaker_view"
        | "audio_only"
        | "chat_file"
        | "closed_caption"
        | "audio_transcript"
        | "shared_screen_with_speaker_view(CC)"
        | "shared_screen_with_gallery_view"
        | "active_speaker"
        | "gallery_view"
        | "shared_screen"
        | "poll"
        | "host_video"
        | "timeline"
        | "thumbnail"
        | "audio_interpretation"
        | "summary_next_steps"
        | "summary_smart_chapters"
        | "sign_interpretation"
        | "production_studio";
     status?: "completed";
  }[];
}[];

GET /users/{userId}/tsp¶

GET /users/{userId}/tsp: {
  tsp_accounts?: readonly {
     conference_code: string;
     dial_in_numbers?: readonly {
        code?: string;
        country_label?: string;
        number?: string;
        type?: "toll" | "tollfree" | "media_link";
     }[];
     id?: "2" | "1";
     leader_pin: string;
     tsp_bridge?: "US_TSP_TB" | "EU_TSP_TB";
  }[];
};

tsp_accounts?¶

optional tsp_accounts?: readonly {
  conference_code: string;
  dial_in_numbers?: readonly {
     code?: string;
     country_label?: string;
     number?: string;
     type?: "toll" | "tollfree" | "media_link";
  }[];
  id?: "2" | "1";
  leader_pin: string;
  tsp_bridge?: "US_TSP_TB" | "EU_TSP_TB";
}[];

GET /users/{userId}/tsp/{tspId}¶

GET /users/{userId}/tsp/{tspId}: {
  conference_code: string;
  dial_in_numbers?: readonly {
     code?: string;
     country_label?: string;
     number?: string;
     type?: "toll" | "tollfree" | "media_link";
  }[];
  id?: string;
  leader_pin: string;
  tsp_bridge?: "US_TSP_TB" | "EU_TSP_TB";
};

conference_code¶

conference_code: string;

dial_in_numbers?¶

optional dial_in_numbers?: readonly {
  code?: string;
  country_label?: string;
  number?: string;
  type?: "toll" | "tollfree" | "media_link";
}[];

id?¶

optional id?: string;

leader_pin¶

leader_pin: string;

tsp_bridge?¶

optional tsp_bridge?: "US_TSP_TB" | "EU_TSP_TB";

GET /users/{userId}/upcoming_meetings¶

GET /users/{userId}/upcoming_meetings: {
  meetings?: readonly {
     created_at?: string;
     duration?: number;
     id?: number;
     is_all_day?: boolean;
     is_host?: boolean;
     join_url?: string;
     passcode?: string;
     start_time?: string;
     timezone?: string;
     topic?: string;
     type?: 1 | 2 | 3 | 8;
     use_pmi?: boolean;
  }[];
  total_records?: number;
};

meetings?¶

optional meetings?: readonly {
  created_at?: string;
  duration?: number;
  id?: number;
  is_all_day?: boolean;
  is_host?: boolean;
  join_url?: string;
  passcode?: string;
  start_time?: string;
  timezone?: string;
  topic?: string;
  type?: 1 | 2 | 3 | 8;
  use_pmi?: boolean;
}[];

total_records?¶

optional total_records?: number;

GET /users/{userId}/webinar_templates¶

GET /users/{userId}/webinar_templates: {
  templates?: readonly {
     id?: string;
     name?: string;
     type?: number;
  }[];
  total_records?: number;
};

templates?¶

optional templates?: readonly {
  id?: string;
  name?: string;
  type?: number;
}[];

total_records?¶

optional total_records?: number;

GET /users/{userId}/webinars¶

GET /users/{userId}/webinars: {
  next_page_token?: string;
  page_count?: number;
  page_number?: number;
  page_size?: number;
  total_records?: number;
} & {
  webinars?: readonly {
     agenda?: string;
     created_at?: string;
     duration?: number;
     host_id?: string;
     id?: number;
     is_events_webinar?: boolean;
     is_simulive?: boolean;
     join_url?: string;
     start_time?: string;
     timezone?: string;
     topic?: string;
     type?: 5 | 6 | 9;
     uuid?: string;
  }[];
};

Type Declaration¶

next_page_token?¶

optional next_page_token?: string;

page_count?¶

optional page_count?: number;

page_number?¶

optional page_number?: number;

page_size?¶

optional page_size?: number;

total_records?¶

optional total_records?: number;

Type Declaration¶

webinars?¶

optional webinars?: readonly {
  agenda?: string;
  created_at?: string;
  duration?: number;
  host_id?: string;
  id?: number;
  is_events_webinar?: boolean;
  is_simulive?: boolean;
  join_url?: string;
  start_time?: string;
  timezone?: string;
  topic?: string;
  type?: 5 | 6 | 9;
  uuid?: string;
}[];

GET /webinars/{webinarId}¶

GET /webinars/{webinarId}: {
  agenda?: string;
  created_at?: string;
  creation_source?: "other" | "open_api" | "web_portal";
  duration?: number;
  encrypted_passcode?: string;
  h323_passcode?: string;
  host_email?: string;
  host_id?: string;
  id?: number;
  is_simulive?: boolean;
  join_url?: string;
  occurrences?: readonly {
     duration?: number;
     occurrence_id?: string;
     start_time?: string;
     status?: "available" | "deleted";
  }[];
  password?: string;
  record_file_id?: string;
  recurrence?: {
     end_date_time?: string;
     end_times?: number;
     monthly_day?: number;
     monthly_week?: -1 | 1 | 2 | 3 | 4;
     monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
     repeat_interval?: number;
     type: 1 | 2 | 3;
     weekly_days?: string;
  };
  registration_url?: string;
  settings?: {
     add_audio_watermark?: boolean;
     add_watermark?: boolean;
     additional_data_center_regions?: readonly string[];
     allow_host_control_participant_mute_state?: boolean;
     allow_multiple_devices?: boolean;
     alternative_host_update_polls?: boolean;
     alternative_hosts?: string;
     approval_type?: 0 | 1 | 2;
     attendees_and_panelists_reminder_email_notification?: {
        enable?: boolean;
        type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
     };
     audio?: "both" | "telephony" | "voip" | "thirdParty";
     audio_conference_info?: string;
     authentication_domains?: string;
     authentication_name?: string;
     authentication_option?: string;
     auto_recording?: "none" | "local" | "cloud";
     close_registration?: boolean;
     contact_email?: string;
     contact_name?: string;
     email_in_attendee_report?: boolean;
     email_language?: string;
     enable_session_branding?: boolean;
     enforce_login?: boolean;
     enforce_login_domains?: string;
     follow_up_absentees_email_notification?: {
        enable?: boolean;
        type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
     };
     follow_up_attendees_email_notification?: {
        enable?: boolean;
        type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
     };
     global_dial_in_countries?: readonly string[];
     global_dial_in_numbers?: readonly {
        city?: string;
        country?: string;
        country_name?: string;
        number?: string;
        type?: "toll" | "tollfree" | "premium";
     }[];
     hd_video?: boolean;
     hd_video_for_attendees?: boolean;
     host_video?: boolean;
     language_interpretation?: {
        enable?: boolean;
        interpreters?: readonly {
           email?: string;
           interpreter_languages?: string;
           languages?: string;
        }[];
     };
     meeting_authentication?: boolean;
     on_demand?: boolean;
     panelist_authentication?: boolean;
     panelists_invitation_email_notification?: boolean;
     panelists_video?: boolean;
     post_webinar_survey?: boolean;
     practice_session?: boolean;
     question_and_answer?: {
        allow_anonymous_questions?: boolean;
        allow_auto_reply?: boolean;
        allow_submit_questions?: boolean;
        answer_questions?: "all" | "only";
        attendees_can_comment?: boolean;
        attendees_can_upvote?: boolean;
        auto_reply_text?: string;
        enable?: boolean;
     };
     registrants_confirmation_email?: boolean;
     registrants_email_notification?: boolean;
     registrants_restrict_number?: number;
     registration_type?: 1 | 2 | 3;
     request_permission_to_unmute_participants?: boolean;
     send_1080p_video_to_attendees?: boolean;
     show_join_info?: boolean;
     show_share_button?: boolean;
     sign_language_interpretation?: {
        enable?: boolean;
        interpreters?: readonly {
           email?: string;
           sign_language?: string;
        }[];
     };
     survey_url?: string;
  };
  simulive_delay_start?: {
     enable?: boolean;
     time?: number;
     timeunit?: "second" | "minute";
  };
  start_time?: string;
  start_url?: string;
  template_id?: string;
  timezone?: string;
  topic?: string;
  tracking_fields?: readonly {
     field?: string;
     value?: string;
     visible?: boolean;
  }[];
  transition_to_live?: boolean;
  type?: 5 | 6 | 9;
  uuid?: string;
};

agenda?¶

optional agenda?: string;

created_at?¶

optional created_at?: string;

creation_source?¶

optional creation_source?: "other" | "open_api" | "web_portal";

duration?¶

optional duration?: number;

encrypted_passcode?¶

optional encrypted_passcode?: string;

h323_passcode?¶

optional h323_passcode?: string;

host_email?¶

optional host_email?: string;

host_id?¶

optional host_id?: string;

id?¶

optional id?: number;

is_simulive?¶

optional is_simulive?: boolean;

join_url?¶

optional join_url?: string;

occurrences?¶

optional occurrences?: readonly {
  duration?: number;
  occurrence_id?: string;
  start_time?: string;
  status?: "available" | "deleted";
}[];

password?¶

optional password?: string;

record_file_id?¶

optional record_file_id?: string;

recurrence?¶

optional recurrence?: {
  end_date_time?: string;
  end_times?: number;
  monthly_day?: number;
  monthly_week?: -1 | 1 | 2 | 3 | 4;
  monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
  repeat_interval?: number;
  type: 1 | 2 | 3;
  weekly_days?: string;
};

recurrence.end_date_time?¶

optional end_date_time?: string;

recurrence.end_times?¶

optional end_times?: number;

recurrence.monthly_day?¶

optional monthly_day?: number;

recurrence.monthly_week?¶

optional monthly_week?: -1 | 1 | 2 | 3 | 4;

recurrence.monthly_week_day?¶

optional monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;

recurrence.repeat_interval?¶

optional repeat_interval?: number;

recurrence.type¶

type: 1 | 2 | 3;

recurrence.weekly_days?¶

optional weekly_days?: string;

registration_url?¶

optional registration_url?: string;

settings?¶

optional settings?: {
  add_audio_watermark?: boolean;
  add_watermark?: boolean;
  additional_data_center_regions?: readonly string[];
  allow_host_control_participant_mute_state?: boolean;
  allow_multiple_devices?: boolean;
  alternative_host_update_polls?: boolean;
  alternative_hosts?: string;
  approval_type?: 0 | 1 | 2;
  attendees_and_panelists_reminder_email_notification?: {
     enable?: boolean;
     type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
  };
  audio?: "both" | "telephony" | "voip" | "thirdParty";
  audio_conference_info?: string;
  authentication_domains?: string;
  authentication_name?: string;
  authentication_option?: string;
  auto_recording?: "none" | "local" | "cloud";
  close_registration?: boolean;
  contact_email?: string;
  contact_name?: string;
  email_in_attendee_report?: boolean;
  email_language?: string;
  enable_session_branding?: boolean;
  enforce_login?: boolean;
  enforce_login_domains?: string;
  follow_up_absentees_email_notification?: {
     enable?: boolean;
     type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
  };
  follow_up_attendees_email_notification?: {
     enable?: boolean;
     type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
  };
  global_dial_in_countries?: readonly string[];
  global_dial_in_numbers?: readonly {
     city?: string;
     country?: string;
     country_name?: string;
     number?: string;
     type?: "toll" | "tollfree" | "premium";
  }[];
  hd_video?: boolean;
  hd_video_for_attendees?: boolean;
  host_video?: boolean;
  language_interpretation?: {
     enable?: boolean;
     interpreters?: readonly {
        email?: string;
        interpreter_languages?: string;
        languages?: string;
     }[];
  };
  meeting_authentication?: boolean;
  on_demand?: boolean;
  panelist_authentication?: boolean;
  panelists_invitation_email_notification?: boolean;
  panelists_video?: boolean;
  post_webinar_survey?: boolean;
  practice_session?: boolean;
  question_and_answer?: {
     allow_anonymous_questions?: boolean;
     allow_auto_reply?: boolean;
     allow_submit_questions?: boolean;
     answer_questions?: "all" | "only";
     attendees_can_comment?: boolean;
     attendees_can_upvote?: boolean;
     auto_reply_text?: string;
     enable?: boolean;
  };
  registrants_confirmation_email?: boolean;
  registrants_email_notification?: boolean;
  registrants_restrict_number?: number;
  registration_type?: 1 | 2 | 3;
  request_permission_to_unmute_participants?: boolean;
  send_1080p_video_to_attendees?: boolean;
  show_join_info?: boolean;
  show_share_button?: boolean;
  sign_language_interpretation?: {
     enable?: boolean;
     interpreters?: readonly {
        email?: string;
        sign_language?: string;
     }[];
  };
  survey_url?: string;
};

settings.add_audio_watermark?¶

optional add_audio_watermark?: boolean;

settings.add_watermark?¶

optional add_watermark?: boolean;

settings.additional_data_center_regions?¶

optional additional_data_center_regions?: readonly string[];

settings.allow_host_control_participant_mute_state?¶

optional allow_host_control_participant_mute_state?: boolean;

settings.allow_multiple_devices?¶

optional allow_multiple_devices?: boolean;

settings.alternative_host_update_polls?¶

optional alternative_host_update_polls?: boolean;

settings.alternative_hosts?¶

optional alternative_hosts?: string;

settings.approval_type?¶

optional approval_type?: 0 | 1 | 2;

settings.attendees_and_panelists_reminder_email_notification?¶

optional attendees_and_panelists_reminder_email_notification?: {
  enable?: boolean;
  type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
};

settings.attendees_and_panelists_reminder_email_notification.enable?¶

optional enable?: boolean;

settings.attendees_and_panelists_reminder_email_notification.type?¶

optional type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;

settings.audio?¶

optional audio?: "both" | "telephony" | "voip" | "thirdParty";

settings.audio_conference_info?¶

optional audio_conference_info?: string;

settings.authentication_domains?¶

optional authentication_domains?: string;

settings.authentication_name?¶

optional authentication_name?: string;

settings.authentication_option?¶

optional authentication_option?: string;

settings.auto_recording?¶

optional auto_recording?: "none" | "local" | "cloud";

settings.close_registration?¶

optional close_registration?: boolean;

settings.contact_email?¶

optional contact_email?: string;

settings.contact_name?¶

optional contact_name?: string;

settings.email_in_attendee_report?¶

optional email_in_attendee_report?: boolean;

settings.email_language?¶

optional email_language?: string;

settings.enable_session_branding?¶

optional enable_session_branding?: boolean;

settings.enforce_login?¶

optional enforce_login?: boolean;

settings.enforce_login_domains?¶

optional enforce_login_domains?: string;

settings.follow_up_absentees_email_notification?¶

optional follow_up_absentees_email_notification?: {
  enable?: boolean;
  type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
};

settings.follow_up_absentees_email_notification.enable?¶

optional enable?: boolean;

settings.follow_up_absentees_email_notification.type?¶

optional type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;

settings.follow_up_attendees_email_notification?¶

optional follow_up_attendees_email_notification?: {
  enable?: boolean;
  type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
};

settings.follow_up_attendees_email_notification.enable?¶

optional enable?: boolean;

settings.follow_up_attendees_email_notification.type?¶

optional type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;

settings.global_dial_in_countries?¶

optional global_dial_in_countries?: readonly string[];

settings.global_dial_in_numbers?¶

optional global_dial_in_numbers?: readonly {
  city?: string;
  country?: string;
  country_name?: string;
  number?: string;
  type?: "toll" | "tollfree" | "premium";
}[];

settings.hd_video?¶

optional hd_video?: boolean;

settings.hd_video_for_attendees?¶

optional hd_video_for_attendees?: boolean;

settings.host_video?¶

optional host_video?: boolean;

settings.language_interpretation?¶

optional language_interpretation?: {
  enable?: boolean;
  interpreters?: readonly {
     email?: string;
     interpreter_languages?: string;
     languages?: string;
  }[];
};

settings.language_interpretation.enable?¶

optional enable?: boolean;

settings.language_interpretation.interpreters?¶

optional interpreters?: readonly {
  email?: string;
  interpreter_languages?: string;
  languages?: string;
}[];

settings.meeting_authentication?¶

optional meeting_authentication?: boolean;

settings.on_demand?¶

optional on_demand?: boolean;

settings.panelist_authentication?¶

optional panelist_authentication?: boolean;

settings.panelists_invitation_email_notification?¶

optional panelists_invitation_email_notification?: boolean;

settings.panelists_video?¶

optional panelists_video?: boolean;

settings.post_webinar_survey?¶

optional post_webinar_survey?: boolean;

settings.practice_session?¶

optional practice_session?: boolean;

settings.question_and_answer?¶

optional question_and_answer?: {
  allow_anonymous_questions?: boolean;
  allow_auto_reply?: boolean;
  allow_submit_questions?: boolean;
  answer_questions?: "all" | "only";
  attendees_can_comment?: boolean;
  attendees_can_upvote?: boolean;
  auto_reply_text?: string;
  enable?: boolean;
};

settings.question_and_answer.allow_anonymous_questions?¶

optional allow_anonymous_questions?: boolean;

settings.question_and_answer.allow_auto_reply?¶

optional allow_auto_reply?: boolean;

settings.question_and_answer.allow_submit_questions?¶

optional allow_submit_questions?: boolean;

settings.question_and_answer.answer_questions?¶

optional answer_questions?: "all" | "only";

settings.question_and_answer.attendees_can_comment?¶

optional attendees_can_comment?: boolean;

settings.question_and_answer.attendees_can_upvote?¶

optional attendees_can_upvote?: boolean;

settings.question_and_answer.auto_reply_text?¶

optional auto_reply_text?: string;

settings.question_and_answer.enable?¶

optional enable?: boolean;

settings.registrants_confirmation_email?¶

optional registrants_confirmation_email?: boolean;

settings.registrants_email_notification?¶

optional registrants_email_notification?: boolean;

settings.registrants_restrict_number?¶

optional registrants_restrict_number?: number;

settings.registration_type?¶

optional registration_type?: 1 | 2 | 3;

settings.request_permission_to_unmute_participants?¶

optional request_permission_to_unmute_participants?: boolean;

settings.send_1080p_video_to_attendees?¶

optional send_1080p_video_to_attendees?: boolean;

settings.show_join_info?¶

optional show_join_info?: boolean;

settings.show_share_button?¶

optional show_share_button?: boolean;

settings.sign_language_interpretation?¶

optional sign_language_interpretation?: {
  enable?: boolean;
  interpreters?: readonly {
     email?: string;
     sign_language?: string;
  }[];
};

settings.sign_language_interpretation.enable?¶

optional enable?: boolean;

settings.sign_language_interpretation.interpreters?¶

optional interpreters?: readonly {
  email?: string;
  sign_language?: string;
}[];

settings.survey_url?¶

optional survey_url?: string;

simulive_delay_start?¶

optional simulive_delay_start?: {
  enable?: boolean;
  time?: number;
  timeunit?: "second" | "minute";
};

simulive_delay_start.enable?¶

optional enable?: boolean;

simulive_delay_start.time?¶

optional time?: number;

simulive_delay_start.timeunit?¶

optional timeunit?: "second" | "minute";

start_time?¶

optional start_time?: string;

start_url?¶

optional start_url?: string;

template_id?¶

optional template_id?: string;

timezone?¶

optional timezone?: string;

topic?¶

optional topic?: string;

tracking_fields?¶

optional tracking_fields?: readonly {
  field?: string;
  value?: string;
  visible?: boolean;
}[];

transition_to_live?¶

optional transition_to_live?: boolean;

type?¶

optional type?: 5 | 6 | 9;

uuid?¶

optional uuid?: string;

GET /webinars/{webinarId}/branding¶

GET /webinars/{webinarId}/branding: {
  name_tags?: readonly {
     accent_color?: string;
     background_color?: string;
     id?: string;
     is_default?: boolean;
     name?: string;
     text_color?: string;
  }[];
  virtual_backgrounds?: readonly {
     id?: string;
     is_default?: boolean;
     name?: string;
  }[];
  wallpaper?: {
     id?: string;
  };
};

name_tags?¶

optional name_tags?: readonly {
  accent_color?: string;
  background_color?: string;
  id?: string;
  is_default?: boolean;
  name?: string;
  text_color?: string;
}[];

virtual_backgrounds?¶

optional virtual_backgrounds?: readonly {
  id?: string;
  is_default?: boolean;
  name?: string;
}[];

wallpaper?¶

optional wallpaper?: {
  id?: string;
};

wallpaper.id?¶

optional id?: string;

GET /webinars/{webinarId}/jointoken/live_streaming¶

GET /webinars/{webinarId}/jointoken/live_streaming: {
  expire_in?: 120;
  token?: string;
};

expire_in?¶

optional expire_in?: 120;

token?¶

optional token?: string;

GET /webinars/{webinarId}/jointoken/local_archiving¶

GET /webinars/{webinarId}/jointoken/local_archiving: {
  expire_in?: 120;
  token?: string;
};

expire_in?¶

optional expire_in?: 120;

token?¶

optional token?: string;

GET /webinars/{webinarId}/jointoken/local_recording¶

GET /webinars/{webinarId}/jointoken/local_recording: {
  expire_in?: 120;
  token?: string;
};

expire_in?¶

optional expire_in?: 120;

token?¶

optional token?: string;

GET /webinars/{webinarId}/livestream¶

GET /webinars/{webinarId}/livestream: {
  page_url?: string;
  resolution?: string;
  stream_key?: string;
  stream_url?: string;
};

page_url?¶

optional page_url?: string;

resolution?¶

optional resolution?: string;

stream_key?¶

optional stream_key?: string;

stream_url?¶

optional stream_url?: string;

GET /webinars/{webinarId}/panelists¶

GET /webinars/{webinarId}/panelists: {
  panelists?: readonly {
     id?: string;
   } & {
     email?: string;
     name?: string;
   } & {
     join_url?: string;
   } & {
     name_tag_description?: string;
     name_tag_id?: string;
     name_tag_name?: string;
     name_tag_pronouns?: string;
     virtual_background_id?: string;
  }[];
  total_records?: number;
};

panelists?¶

optional panelists?: readonly {
  id?: string;
} & {
  email?: string;
  name?: string;
} & {
  join_url?: string;
} & {
  name_tag_description?: string;
  name_tag_id?: string;
  name_tag_name?: string;
  name_tag_pronouns?: string;
  virtual_background_id?: string;
}[];

total_records?¶

optional total_records?: number;

GET /webinars/{webinarId}/polls¶

GET /webinars/{webinarId}/polls: {
  polls?: readonly {
     id?: string;
     status?: "started" | "ended" | "notstart" | "sharing" | "deactivated";
   } & {
     anonymous?: boolean;
     poll_type?: 1 | 2 | 3;
     questions?: readonly {
        answer_max_character?: number;
        answer_min_character?: number;
        answer_required?: boolean;
        answers?: readonly string[];
        case_sensitive?: boolean;
        name?: string;
        prompts?: readonly {
           prompt_question?: string;
           prompt_right_answers?: readonly string[];
        }[];
        rating_max_label?: string;
        rating_max_value?: number;
        rating_min_label?: string;
        rating_min_value?: number;
        right_answers?: readonly string[];
        show_as_dropdown?: boolean;
        type?:   | "single"
           | "multiple"
           | "matching"
           | "rank_order"
           | "short_answer"
           | "long_answer"
           | "fill_in_the_blank"
           | "rating_scale";
     }[];
     title?: string;
  }[];
  total_records?: number;
};

polls?¶

optional polls?: readonly {
  id?: string;
  status?: "started" | "ended" | "notstart" | "sharing" | "deactivated";
} & {
  anonymous?: boolean;
  poll_type?: 1 | 2 | 3;
  questions?: readonly {
     answer_max_character?: number;
     answer_min_character?: number;
     answer_required?: boolean;
     answers?: readonly string[];
     case_sensitive?: boolean;
     name?: string;
     prompts?: readonly {
        prompt_question?: string;
        prompt_right_answers?: readonly string[];
     }[];
     rating_max_label?: string;
     rating_max_value?: number;
     rating_min_label?: string;
     rating_min_value?: number;
     right_answers?: readonly string[];
     show_as_dropdown?: boolean;
     type?:   | "single"
        | "multiple"
        | "matching"
        | "rank_order"
        | "short_answer"
        | "long_answer"
        | "fill_in_the_blank"
        | "rating_scale";
  }[];
  title?: string;
}[];

total_records?¶

optional total_records?: number;

GET /webinars/{webinarId}/polls/{pollId}¶

GET /webinars/{webinarId}/polls/{pollId}: {
  id?: string;
  status?: "started" | "ended" | "notstart" | "sharing" | "deactivated";
} & {
  anonymous?: boolean;
  poll_type?: 1 | 2 | 3;
  questions?: readonly {
     answer_max_character?: number;
     answer_min_character?: number;
     answer_required?: boolean;
     answers?: readonly string[];
     case_sensitive?: boolean;
     name?: string;
     prompts?: readonly {
        prompt_question?: string;
        prompt_right_answers?: readonly string[];
     }[];
     rating_max_label?: string;
     rating_max_value?: number;
     rating_min_label?: string;
     rating_min_value?: number;
     right_answers?: readonly string[];
     show_as_dropdown?: boolean;
     type?:   | "single"
        | "multiple"
        | "matching"
        | "rank_order"
        | "short_answer"
        | "long_answer"
        | "fill_in_the_blank"
        | "rating_scale";
  }[];
  title?: string;
};

Type Declaration¶

id?¶

optional id?: string;

status?¶

optional status?: "started" | "ended" | "notstart" | "sharing" | "deactivated";

Type Declaration¶

anonymous?¶

optional anonymous?: boolean;

poll_type?¶

optional poll_type?: 1 | 2 | 3;

questions?¶

optional questions?: readonly {
  answer_max_character?: number;
  answer_min_character?: number;
  answer_required?: boolean;
  answers?: readonly string[];
  case_sensitive?: boolean;
  name?: string;
  prompts?: readonly {
     prompt_question?: string;
     prompt_right_answers?: readonly string[];
  }[];
  rating_max_label?: string;
  rating_max_value?: number;
  rating_min_label?: string;
  rating_min_value?: number;
  right_answers?: readonly string[];
  show_as_dropdown?: boolean;
  type?:   | "single"
     | "multiple"
     | "matching"
     | "rank_order"
     | "short_answer"
     | "long_answer"
     | "fill_in_the_blank"
     | "rating_scale";
}[];

title?¶

optional title?: string;

GET /webinars/{webinarId}/registrants¶

GET /webinars/{webinarId}/registrants: {
  next_page_token?: string;
  page_count?: number;
  page_number?: number;
  page_size?: number;
  total_records?: number;
} & {
  registrants?: readonly {
     id?: string;
   } & {
     address?: string;
     city?: string;
     comments?: string;
     country?: string;
     custom_questions?: readonly {
        title?: string;
        value?: string;
     }[];
     email: string;
     first_name: string;
     industry?: string;
     job_title?: string;
     last_name?: string;
     no_of_employees?:   | ""
        | "1-20"
        | "21-50"
        | "51-100"
        | "101-250"
        | "251-500"
        | "501-1,000"
        | "1,001-5,000"
        | "5,001-10,000"
        | "More than 10,000";
     org?: string;
     phone?: string;
     purchasing_time_frame?:   | ""
        | "Within a month"
        | "1-3 months"
        | "4-6 months"
        | "More than 6 months"
        | "No timeframe";
     role_in_purchase_process?:   | ""
        | "Decision Maker"
        | "Evaluator/Recommender"
        | "Influencer"
        | "Not involved";
     state?: string;
     status?: "pending" | "approved" | "denied";
     zip?: string;
   } & {
     create_time?: string;
     join_url?: string;
     status?: string;
  }[];
};

Type Declaration¶

next_page_token?¶

optional next_page_token?: string;

page_count?¶

optional page_count?: number;

page_number?¶

optional page_number?: number;

page_size?¶

optional page_size?: number;

total_records?¶

optional total_records?: number;

Type Declaration¶

registrants?¶

optional registrants?: readonly {
  id?: string;
} & {
  address?: string;
  city?: string;
  comments?: string;
  country?: string;
  custom_questions?: readonly {
     title?: string;
     value?: string;
  }[];
  email: string;
  first_name: string;
  industry?: string;
  job_title?: string;
  last_name?: string;
  no_of_employees?:   | ""
     | "1-20"
     | "21-50"
     | "51-100"
     | "101-250"
     | "251-500"
     | "501-1,000"
     | "1,001-5,000"
     | "5,001-10,000"
     | "More than 10,000";
  org?: string;
  phone?: string;
  purchasing_time_frame?:   | ""
     | "Within a month"
     | "1-3 months"
     | "4-6 months"
     | "More than 6 months"
     | "No timeframe";
  role_in_purchase_process?:   | ""
     | "Decision Maker"
     | "Evaluator/Recommender"
     | "Influencer"
     | "Not involved";
  state?: string;
  status?: "pending" | "approved" | "denied";
  zip?: string;
} & {
  create_time?: string;
  join_url?: string;
  status?: string;
}[];

GET /webinars/{webinarId}/registrants/{registrantId}¶

GET /webinars/{webinarId}/registrants/{registrantId}: {
  id?: string;
} & {
  address?: string;
  city?: string;
  comments?: string;
  country?: string;
  custom_questions?: readonly {
     title?: string;
     value?: string;
  }[];
  email: string;
  first_name: string;
  industry?: string;
  job_title?: string;
  last_name?: string;
  no_of_employees?:   | ""
     | "1-20"
     | "21-50"
     | "51-100"
     | "101-250"
     | "251-500"
     | "501-1,000"
     | "1,001-5,000"
     | "5,001-10,000"
     | "More than 10,000";
  org?: string;
  phone?: string;
  purchasing_time_frame?:   | ""
     | "Within a month"
     | "1-3 months"
     | "4-6 months"
     | "More than 6 months"
     | "No timeframe";
  role_in_purchase_process?:   | ""
     | "Decision Maker"
     | "Evaluator/Recommender"
     | "Influencer"
     | "Not involved";
  state?: string;
  status?: "pending" | "approved" | "denied";
  zip?: string;
} & {
  language?:   | "de-DE"
     | "en-US"
     | "es-ES"
     | "fr-FR"
     | "it-IT"
     | "pl-PL"
     | "pt-PT"
     | "ru-RU"
     | "vi-VN"
     | "zh-CN"
     | "zh-TW"
     | "jp-JP"
     | "ko-KO"
     | "Tr-TR";
} & {
  create_time?: string;
  join_url?: string;
  status?: string;
};

Type Declaration¶

id?¶

optional id?: string;

Type Declaration¶

address?¶

optional address?: string;

city?¶

optional city?: string;

comments?¶

optional comments?: string;

country?¶

optional country?: string;

custom_questions?¶

optional custom_questions?: readonly {
  title?: string;
  value?: string;
}[];

email¶

email: string;

first_name¶

first_name: string;

industry?¶

optional industry?: string;

job_title?¶

optional job_title?: string;

last_name?¶

optional last_name?: string;

no_of_employees?¶

optional no_of_employees?:
  | ""
  | "1-20"
  | "21-50"
  | "51-100"
  | "101-250"
  | "251-500"
  | "501-1,000"
  | "1,001-5,000"
  | "5,001-10,000"
  | "More than 10,000";

org?¶

optional org?: string;

phone?¶

optional phone?: string;

purchasing_time_frame?¶

optional purchasing_time_frame?:
  | ""
  | "Within a month"
  | "1-3 months"
  | "4-6 months"
  | "More than 6 months"
  | "No timeframe";

role_in_purchase_process?¶

optional role_in_purchase_process?:
  | ""
  | "Decision Maker"
  | "Evaluator/Recommender"
  | "Influencer"
  | "Not involved";

state?¶

optional state?: string;

status?¶

optional status?: "pending" | "approved" | "denied";

zip?¶

optional zip?: string;

Type Declaration¶

language?¶

optional language?:
  | "de-DE"
  | "en-US"
  | "es-ES"
  | "fr-FR"
  | "it-IT"
  | "pl-PL"
  | "pt-PT"
  | "ru-RU"
  | "vi-VN"
  | "zh-CN"
  | "zh-TW"
  | "jp-JP"
  | "ko-KO"
  | "Tr-TR";

Type Declaration¶

create_time?¶

optional create_time?: string;

join_url?¶

optional join_url?: string;

status?¶

optional status?: string;

GET /webinars/{webinarId}/registrants/questions¶

GET /webinars/{webinarId}/registrants/questions: {
  custom_questions?: readonly {
     answers?: readonly string[];
     required?: boolean;
     title?: string;
     type?: "short" | "multiple" | "single_radio" | "single_dropdown";
  }[];
  questions?: readonly {
     field_name?:   | "state"
        | "phone"
        | "last_name"
        | "address"
        | "city"
        | "country"
        | "zip"
        | "industry"
        | "org"
        | "job_title"
        | "purchasing_time_frame"
        | "role_in_purchase_process"
        | "no_of_employees"
        | "comments";
     required?: boolean;
  }[];
};

custom_questions?¶

optional custom_questions?: readonly {
  answers?: readonly string[];
  required?: boolean;
  title?: string;
  type?: "short" | "multiple" | "single_radio" | "single_dropdown";
}[];

questions?¶

optional questions?: readonly {
  field_name?:   | "state"
     | "phone"
     | "last_name"
     | "address"
     | "city"
     | "country"
     | "zip"
     | "industry"
     | "org"
     | "job_title"
     | "purchasing_time_frame"
     | "role_in_purchase_process"
     | "no_of_employees"
     | "comments";
  required?: boolean;
}[];

GET /webinars/{webinarId}/survey¶

GET /webinars/{webinarId}/survey: {
  custom_survey?: {
     anonymous?: boolean;
     feedback?: string;
     numbered_questions?: boolean;
     questions?: readonly {
        answer_max_character?: number;
        answer_min_character?: number;
        answer_required?: boolean;
        answers?: readonly string[];
        name?: string;
        prompts?: readonly {
           prompt_question?: string;
        }[];
        rating_max_label?: string;
        rating_max_value?: number;
        rating_min_label?: string;
        rating_min_value?: number;
        show_as_dropdown?: boolean;
        type?:   | "single"
           | "multiple"
           | "matching"
           | "rank_order"
           | "short_answer"
           | "long_answer"
           | "fill_in_the_blank"
           | "rating_scale";
     }[];
     show_question_type?: boolean;
     title?: string;
  };
  show_in_the_browser?: boolean;
  show_in_the_follow_up_email?: boolean;
  third_party_survey?: string;
};

custom_survey?¶

optional custom_survey?: {
  anonymous?: boolean;
  feedback?: string;
  numbered_questions?: boolean;
  questions?: readonly {
     answer_max_character?: number;
     answer_min_character?: number;
     answer_required?: boolean;
     answers?: readonly string[];
     name?: string;
     prompts?: readonly {
        prompt_question?: string;
     }[];
     rating_max_label?: string;
     rating_max_value?: number;
     rating_min_label?: string;
     rating_min_value?: number;
     show_as_dropdown?: boolean;
     type?:   | "single"
        | "multiple"
        | "matching"
        | "rank_order"
        | "short_answer"
        | "long_answer"
        | "fill_in_the_blank"
        | "rating_scale";
  }[];
  show_question_type?: boolean;
  title?: string;
};

custom_survey.anonymous?¶

optional anonymous?: boolean;

custom_survey.feedback?¶

optional feedback?: string;

custom_survey.numbered_questions?¶

optional numbered_questions?: boolean;

custom_survey.questions?¶

optional questions?: readonly {
  answer_max_character?: number;
  answer_min_character?: number;
  answer_required?: boolean;
  answers?: readonly string[];
  name?: string;
  prompts?: readonly {
     prompt_question?: string;
  }[];
  rating_max_label?: string;
  rating_max_value?: number;
  rating_min_label?: string;
  rating_min_value?: number;
  show_as_dropdown?: boolean;
  type?:   | "single"
     | "multiple"
     | "matching"
     | "rank_order"
     | "short_answer"
     | "long_answer"
     | "fill_in_the_blank"
     | "rating_scale";
}[];

custom_survey.show_question_type?¶

optional show_question_type?: boolean;

custom_survey.title?¶

optional title?: string;

show_in_the_browser?¶

optional show_in_the_browser?: boolean;

show_in_the_follow_up_email?¶

optional show_in_the_follow_up_email?: boolean;

third_party_survey?¶

optional third_party_survey?: string;

GET /webinars/{webinarId}/token¶

GET /webinars/{webinarId}/token: {
  token?: string;
};

token?¶

optional token?: string;

GET /webinars/{webinarId}/tracking_sources¶

GET /webinars/{webinarId}/tracking_sources: {
  total_records?: number;
  tracking_sources?: readonly {
     id?: string;
     registration_count?: number;
     source_name?: string;
     tracking_url?: string;
     visitor_count?: number;
  }[];
};

total_records?¶

optional total_records?: number;

tracking_sources?¶

optional tracking_sources?: readonly {
  id?: string;
  registration_count?: number;
  source_name?: string;
  tracking_url?: string;
  visitor_count?: number;
}[];

PATCH /archive_files/{fileId}¶

PATCH /archive_files/{fileId}: void;

PATCH /devices/{deviceId}¶

PATCH /devices/{deviceId}: void;

PATCH /devices/{deviceId}/assign_group¶

PATCH /devices/{deviceId}/assign_group: void;

PATCH /devices/{deviceId}/assignment¶

PATCH /devices/{deviceId}/assignment: void;

PATCH /h323/devices/{deviceId}¶

PATCH /h323/devices/{deviceId}: void;

PATCH /live_meetings/{meetingId}/chat/messages/{messageId}¶

PATCH /live_meetings/{meetingId}/chat/messages/{messageId}: void;

PATCH /live_meetings/{meetingId}/events¶

PATCH /live_meetings/{meetingId}/events: void;

PATCH /live_meetings/{meetingId}/rtms_app/status¶

PATCH /live_meetings/{meetingId}/rtms_app/status: void;

PATCH /meetings/{meetingId}¶

PATCH /meetings/{meetingId}: void;

PATCH /meetings/{meetingId}/livestream¶

PATCH /meetings/{meetingId}/livestream: void;

PATCH /meetings/{meetingId}/livestream/status¶

PATCH /meetings/{meetingId}/livestream/status: void;

PATCH /meetings/{meetingId}/recordings/registrants/questions¶

PATCH /meetings/{meetingId}/recordings/registrants/questions: void;

PATCH /meetings/{meetingId}/recordings/settings¶

PATCH /meetings/{meetingId}/recordings/settings: void;

PATCH /meetings/{meetingId}/registrants/questions¶

PATCH /meetings/{meetingId}/registrants/questions: void;

PATCH /meetings/{meetingId}/survey¶

PATCH /meetings/{meetingId}/survey: void;

PATCH /sip_phones/phones/{phoneId}¶

PATCH /sip_phones/phones/{phoneId}: void;

PATCH /tracking_fields/{fieldId}¶

PATCH /tracking_fields/{fieldId}: void;

PATCH /tsp¶

PATCH /tsp: void;

PATCH /users/{userId}/tsp/{tspId}¶

PATCH /users/{userId}/tsp/{tspId}: void;

PATCH /users/{userId}/tsp/settings¶

PATCH /users/{userId}/tsp/settings: void;

PATCH /webinars/{webinarId}¶

PATCH /webinars/{webinarId}: void;

PATCH /webinars/{webinarId}/branding/name_tags/{nameTagId}¶

PATCH /webinars/{webinarId}/branding/name_tags/{nameTagId}: void;

PATCH /webinars/{webinarId}/branding/virtual_backgrounds¶

PATCH /webinars/{webinarId}/branding/virtual_backgrounds: void;

PATCH /webinars/{webinarId}/livestream¶

PATCH /webinars/{webinarId}/livestream: void;

PATCH /webinars/{webinarId}/livestream/status¶

PATCH /webinars/{webinarId}/livestream/status: void;

PATCH /webinars/{webinarId}/registrants/questions¶

PATCH /webinars/{webinarId}/registrants/questions: void;

PATCH /webinars/{webinarId}/survey¶

PATCH /webinars/{webinarId}/survey: void;

POST /devices¶

POST /devices: void;

POST /devices/zpa/assignment¶

POST /devices/zpa/assignment: void;

POST /devices/zpa/upgrade¶

POST /devices/zpa/upgrade: void;

POST /h323/devices¶

POST /h323/devices: {
  id?: string;
} & {
  encryption: "auto" | "yes" | "no";
  ip: string;
  name: string;
  protocol: "H.323" | "SIP";
};

Type Declaration¶

id?¶

optional id?: string;

Type Declaration¶

encryption¶

encryption: "auto" | "yes" | "no";

ip¶

ip: string;

name¶

name: string;

protocol¶

protocol: "H.323" | "SIP";

POST /meetings/{meetingId}/batch_polls¶

POST /meetings/{meetingId}/batch_polls: {
  polls?: readonly {
     anonymous?: boolean;
     id?: string;
     poll_type?: 1 | 2 | 3;
     questions?: readonly {
        answer_max_character?: number;
        answer_min_character?: number;
        answer_required?: boolean;
        answers?: readonly string[];
        case_sensitive?: boolean;
        name?: string;
        prompts?: readonly {
           prompt_question?: string;
           prompt_right_answers?: readonly string[];
        }[];
        rating_max_label?: string;
        rating_max_value?: number;
        rating_min_label?: string;
        rating_min_value?: number;
        right_answers?: readonly string[];
        show_as_dropdown?: boolean;
        type?:   | "single"
           | "multiple"
           | "matching"
           | "rank_order"
           | "short_answer"
           | "long_answer"
           | "fill_in_the_blank"
           | "rating_scale";
     }[];
     status?: "started" | "ended" | "notstart" | "sharing";
     title?: string;
  }[];
};

polls?¶

optional polls?: readonly {
  anonymous?: boolean;
  id?: string;
  poll_type?: 1 | 2 | 3;
  questions?: readonly {
     answer_max_character?: number;
     answer_min_character?: number;
     answer_required?: boolean;
     answers?: readonly string[];
     case_sensitive?: boolean;
     name?: string;
     prompts?: readonly {
        prompt_question?: string;
        prompt_right_answers?: readonly string[];
     }[];
     rating_max_label?: string;
     rating_max_value?: number;
     rating_min_label?: string;
     rating_min_value?: number;
     right_answers?: readonly string[];
     show_as_dropdown?: boolean;
     type?:   | "single"
        | "multiple"
        | "matching"
        | "rank_order"
        | "short_answer"
        | "long_answer"
        | "fill_in_the_blank"
        | "rating_scale";
  }[];
  status?: "started" | "ended" | "notstart" | "sharing";
  title?: string;
}[];

POST /meetings/{meetingId}/batch_registrants¶

POST /meetings/{meetingId}/batch_registrants: {
  registrants?: readonly {
     email?: string;
     join_url?: string;
     participant_pin_code?: number;
     registrant_id?: string;
  }[];
};

registrants?¶

optional registrants?: readonly {
  email?: string;
  join_url?: string;
  participant_pin_code?: number;
  registrant_id?: string;
}[];

POST /meetings/{meetingId}/invite_links¶

POST /meetings/{meetingId}/invite_links: {
  attendees?: readonly {
     join_url?: string;
     name?: string;
  }[];
};

attendees?¶

optional attendees?: readonly {
  join_url?: string;
  name?: string;
}[];

POST /meetings/{meetingId}/open_apps¶

POST /meetings/{meetingId}/open_apps: {
  app_id?: string;
  id?: number;
  start_time?: string;
};

app_id?¶

optional app_id?: string;

id?¶

optional id?: number;

start_time?¶

optional start_time?: string;

POST /meetings/{meetingId}/polls¶

POST /meetings/{meetingId}/polls: {
  id?: string;
  status?: "started" | "ended" | "notstart" | "sharing";
} & {
  anonymous?: boolean;
  poll_type?: 1 | 2 | 3;
  questions?: readonly {
     answer_max_character?: number;
     answer_min_character?: number;
     answer_required?: boolean;
     answers?: readonly string[];
     case_sensitive?: boolean;
     name?: string;
     prompts?: readonly {
        prompt_question?: string;
        prompt_right_answers?: readonly string[];
     }[];
     rating_max_label?: string;
     rating_max_value?: number;
     rating_min_label?: string;
     rating_min_value?: number;
     right_answers?: readonly string[];
     show_as_dropdown?: boolean;
     type?:   | "single"
        | "multiple"
        | "matching"
        | "rank_order"
        | "short_answer"
        | "long_answer"
        | "fill_in_the_blank"
        | "rating_scale";
  }[];
  title?: string;
};

Type Declaration¶

id?¶

optional id?: string;

status?¶

optional status?: "started" | "ended" | "notstart" | "sharing";

Type Declaration¶

anonymous?¶

optional anonymous?: boolean;

poll_type?¶

optional poll_type?: 1 | 2 | 3;

questions?¶

optional questions?: readonly {
  answer_max_character?: number;
  answer_min_character?: number;
  answer_required?: boolean;
  answers?: readonly string[];
  case_sensitive?: boolean;
  name?: string;
  prompts?: readonly {
     prompt_question?: string;
     prompt_right_answers?: readonly string[];
  }[];
  rating_max_label?: string;
  rating_max_value?: number;
  rating_min_label?: string;
  rating_min_value?: number;
  right_answers?: readonly string[];
  show_as_dropdown?: boolean;
  type?:   | "single"
     | "multiple"
     | "matching"
     | "rank_order"
     | "short_answer"
     | "long_answer"
     | "fill_in_the_blank"
     | "rating_scale";
}[];

title?¶

optional title?: string;

POST /meetings/{meetingId}/recordings/registrants¶

POST /meetings/{meetingId}/recordings/registrants: {
  id?: number;
  registrant_id?: string;
  share_url?: string;
  topic?: string;
};

id?¶

optional id?: number;

registrant_id?¶

optional registrant_id?: string;

share_url?¶

optional share_url?: string;

topic?¶

optional topic?: string;

POST /meetings/{meetingId}/registrants¶

POST /meetings/{meetingId}/registrants: {
  id?: number;
  join_url?: string;
  occurrences?: readonly {
     duration?: number;
     occurrence_id?: string;
     start_time?: string;
     status?: string;
  }[];
  participant_pin_code?: number;
  registrant_id?: string;
  start_time?: string;
  topic?: string;
};

id?¶

optional id?: number;

join_url?¶

optional join_url?: string;

occurrences?¶

optional occurrences?: readonly {
  duration?: number;
  occurrence_id?: string;
  start_time?: string;
  status?: string;
}[];

participant_pin_code?¶

optional participant_pin_code?: number;

registrant_id?¶

optional registrant_id?: string;

start_time?¶

optional start_time?: string;

topic?¶

optional topic?: string;

POST /meetings/{meetingId}/sip_dialing¶

POST /meetings/{meetingId}/sip_dialing: {
  expire_in?: number;
  paid_crc_plan_participant?: boolean;
  participant_identifier_code?: string;
  sip_dialing?: string;
};

expire_in?¶

optional expire_in?: number;

paid_crc_plan_participant?¶

optional paid_crc_plan_participant?: boolean;

participant_identifier_code?¶

optional participant_identifier_code?: string;

sip_dialing?¶

optional sip_dialing?: string;

POST /sip_phones/phones¶

POST /sip_phones/phones: {
  authorization_name?: string;
  display_number?: string;
  domain?: string;
  password?: string;
  phone_id?: string;
  registration_expire_time?: number;
  server?: {
     proxy_server?: string;
     register_server?: string;
     transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
  };
  server_2?: {
     proxy_server?: string;
     register_server?: string;
     transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
  };
  server_3?: {
     proxy_server?: string;
     register_server?: string;
     transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
  };
  user_email?: string;
  user_name?: string;
  voice_mail?: string;
};

authorization_name?¶

optional authorization_name?: string;

display_number?¶

optional display_number?: string;

domain?¶

optional domain?: string;

password?¶

optional password?: string;

phone_id?¶

optional phone_id?: string;

registration_expire_time?¶

optional registration_expire_time?: number;

server?¶

optional server?: {
  proxy_server?: string;
  register_server?: string;
  transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
};

server.proxy_server?¶

optional proxy_server?: string;

server.register_server?¶

optional register_server?: string;

server.transport_protocol?¶

optional transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";

server_2?¶

optional server_2?: {
  proxy_server?: string;
  register_server?: string;
  transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
};

server_2.proxy_server?¶

optional proxy_server?: string;

server_2.register_server?¶

optional register_server?: string;

server_2.transport_protocol?¶

optional transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";

server_3?¶

optional server_3?: {
  proxy_server?: string;
  register_server?: string;
  transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";
};

server_3.proxy_server?¶

optional proxy_server?: string;

server_3.register_server?¶

optional register_server?: string;

server_3.transport_protocol?¶

optional transport_protocol?: "UDP" | "TCP" | "TLS" | "AUTO";

user_email?¶

optional user_email?: string;

user_name?¶

optional user_name?: string;

voice_mail?¶

optional voice_mail?: string;

POST /tracking_fields¶

POST /tracking_fields: {
  id?: string;
} & {
  field?: string;
  recommended_values?: readonly string[];
  required?: boolean;
  visible?: boolean;
};

Type Declaration¶

id?¶

optional id?: string;

Type Declaration¶

field?¶

optional field?: string;

recommended_values?¶

optional recommended_values?: readonly string[];

required?¶

optional required?: boolean;

visible?¶

optional visible?: boolean;

POST /users/{userId}/meeting_templates¶

POST /users/{userId}/meeting_templates: {
  id?: string;
  name?: string;
};

id?¶

optional id?: string;

name?¶

optional name?: string;

POST /users/{userId}/meetings¶

POST /users/{userId}/meetings: {
  agenda?: string;
  assistant_id?: string;
  chat_join_url?: string;
  created_at?: string;
  creation_source?: "other" | "open_api" | "web_portal";
  duration?: number;
  dynamic_host_key?: string;
  encrypted_password?: string;
  h323_password?: string;
  host_email?: string;
  host_id?: string;
  id?: number;
  join_url?: string;
  occurrences?: readonly {
     duration?: number;
     occurrence_id?: string;
     start_time?: string;
     status?: "available" | "deleted";
  }[];
  password?: string;
  pmi?: string;
  pre_schedule?: boolean;
  pstn_password?: string;
  recurrence?: {
     end_date_time?: string;
     end_times?: number;
     monthly_day?: number;
     monthly_week?: -1 | 1 | 2 | 3 | 4;
     monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
     repeat_interval?: number;
     type: 1 | 2 | 3;
     weekly_days?: "2" | "1" | "3" | "4" | "5" | "6" | "7";
  };
  registration_url?: string;
  settings?: {
     additional_data_center_regions?: readonly string[];
     allow_host_control_participant_mute_state?: boolean;
     allow_multiple_devices?: boolean;
     alternative_host_manage_cloud_recording?: boolean;
     alternative_host_manage_meeting_summary?: boolean;
     alternative_host_update_polls?: boolean;
     alternative_hosts?: string;
     alternative_hosts_email_notification?: boolean;
     approval_type?: 0 | 1 | 2;
     approved_or_denied_countries_or_regions?: {
        approved_list?: readonly string[];
        denied_list?: readonly string[];
        enable?: boolean;
        method?: "approve" | "deny";
     };
     audio?: "both" | "telephony" | "voip" | "thirdParty";
     audio_conference_info?: string;
     authentication_domains?: string;
     authentication_exception?: readonly {
        email?: string;
        join_url?: string;
        name?: string;
     }[];
     authentication_name?: string;
     authentication_option?: string;
     auto_add_recording_to_video_management?: {
        channels?: readonly {
           channel_id: string;
           name?: string;
        }[];
        enable: boolean;
     };
     auto_recording?: "none" | "local" | "cloud";
     auto_start_ai_companion_questions?: boolean;
     auto_start_meeting_summary?: boolean;
     breakout_room?: {
        enable?: boolean;
        rooms?: readonly {
           name?: string;
           participants?: readonly string[];
        }[];
     };
     calendar_type?: 1 | 2;
     close_registration?: boolean;
     cn_meeting?: boolean;
     contact_email?: string;
     contact_name?: string;
     continuous_meeting_chat?: {
        auto_add_invited_external_users?: boolean;
        auto_add_meeting_participants?: boolean;
        channel_id?: string;
        enable?: boolean;
     };
     custom_keys?: readonly {
        key?: string;
        value?: string;
     }[];
     device_testing?: boolean;
     disable_participant_video?: boolean;
     email_in_attendee_report?: boolean;
     email_notification?: boolean;
     encryption_type?: "enhanced_encryption" | "e2ee";
     enforce_login?: boolean;
     enforce_login_domains?: string;
     focus_mode?: boolean;
     global_dial_in_countries?: readonly string[];
     global_dial_in_numbers?: readonly {
        city?: string;
        country?: string;
        country_name?: string;
        number?: string;
        type?: "toll" | "tollfree";
     }[];
     host_save_video_order?: boolean;
     host_video?: boolean;
     in_meeting?: boolean;
     internal_meeting?: boolean;
     jbh_time?: 0 | 5 | 10 | 15;
     join_before_host?: boolean;
     language_interpretation?: {
        enable?: boolean;
        interpreters?: readonly {
           email?: string;
           interpreter_languages?: string;
           languages?: string;
        }[];
     };
     meeting_authentication?: boolean;
     meeting_invitees?: readonly {
        email?: string;
     }[];
     mute_upon_entry?: boolean;
     participant_focused_meeting?: boolean;
     participant_video?: boolean;
     private_meeting?: boolean;
     push_change_to_calendar?: boolean;
     question_and_answer?: {
        allow_anonymous_questions?: boolean;
        allow_submit_questions?: boolean;
        attendees_can_comment?: boolean;
        attendees_can_upvote?: boolean;
        enable?: boolean;
        question_visibility?: "all" | "answered";
     };
     registrants_confirmation_email?: boolean;
     registrants_email_notification?: boolean;
     registration_type?: 1 | 2 | 3;
     request_permission_to_unmute_participants?: boolean;
     resources?: readonly {
        permission_level?: "editor" | "commenter" | "viewer";
        resource_id?: string;
        resource_type?: "whiteboard";
     }[];
     show_join_info?: boolean;
     show_share_button?: boolean;
     sign_language_interpretation?: {
        enable?: boolean;
        interpreters?: readonly {
           email?: string;
           sign_language?: string;
        }[];
     };
     summary_template_id?: string;
     use_pmi?: boolean;
     waiting_room?: boolean;
     waiting_room_options?: {
        mode: "custom" | "follow_setting";
        who_goes_to_waiting_room?:   | "everyone"
           | "users_not_in_account"
           | "users_not_in_account_or_whitelisted_domains"
           | "users_not_on_invite"
           | "users_not_in_org";
     };
     watermark?: boolean;
     who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;
     who_will_receive_summary?: 1 | 2 | 3 | 4;
  };
  start_time?: string;
  start_url?: string;
  status?: "started" | "waiting";
  template_id?: string;
  timezone?: string;
  topic?: string;
  tracking_fields?: readonly {
     field?: string;
     value?: string;
     visible?: boolean;
  }[];
  type?: 1 | 2 | 3 | 8 | 10;
  uuid?: string;
};

agenda?¶

optional agenda?: string;

assistant_id?¶

optional assistant_id?: string;

chat_join_url?¶

optional chat_join_url?: string;

created_at?¶

optional created_at?: string;

creation_source?¶

optional creation_source?: "other" | "open_api" | "web_portal";

duration?¶

optional duration?: number;

dynamic_host_key?¶

optional dynamic_host_key?: string;

encrypted_password?¶

optional encrypted_password?: string;

h323_password?¶

optional h323_password?: string;

host_email?¶

optional host_email?: string;

host_id?¶

optional host_id?: string;

id?¶

optional id?: number;

join_url?¶

optional join_url?: string;

occurrences?¶

optional occurrences?: readonly {
  duration?: number;
  occurrence_id?: string;
  start_time?: string;
  status?: "available" | "deleted";
}[];

password?¶

optional password?: string;

pmi?¶

optional pmi?: string;

pre_schedule?¶

optional pre_schedule?: boolean;

pstn_password?¶

optional pstn_password?: string;

recurrence?¶

optional recurrence?: {
  end_date_time?: string;
  end_times?: number;
  monthly_day?: number;
  monthly_week?: -1 | 1 | 2 | 3 | 4;
  monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
  repeat_interval?: number;
  type: 1 | 2 | 3;
  weekly_days?: "2" | "1" | "3" | "4" | "5" | "6" | "7";
};

recurrence.end_date_time?¶

optional end_date_time?: string;

recurrence.end_times?¶

optional end_times?: number;

recurrence.monthly_day?¶

optional monthly_day?: number;

recurrence.monthly_week?¶

optional monthly_week?: -1 | 1 | 2 | 3 | 4;

recurrence.monthly_week_day?¶

optional monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;

recurrence.repeat_interval?¶

optional repeat_interval?: number;

recurrence.type¶

type: 1 | 2 | 3;

recurrence.weekly_days?¶

optional weekly_days?: "2" | "1" | "3" | "4" | "5" | "6" | "7";

registration_url?¶

optional registration_url?: string;

settings?¶

optional settings?: {
  additional_data_center_regions?: readonly string[];
  allow_host_control_participant_mute_state?: boolean;
  allow_multiple_devices?: boolean;
  alternative_host_manage_cloud_recording?: boolean;
  alternative_host_manage_meeting_summary?: boolean;
  alternative_host_update_polls?: boolean;
  alternative_hosts?: string;
  alternative_hosts_email_notification?: boolean;
  approval_type?: 0 | 1 | 2;
  approved_or_denied_countries_or_regions?: {
     approved_list?: readonly string[];
     denied_list?: readonly string[];
     enable?: boolean;
     method?: "approve" | "deny";
  };
  audio?: "both" | "telephony" | "voip" | "thirdParty";
  audio_conference_info?: string;
  authentication_domains?: string;
  authentication_exception?: readonly {
     email?: string;
     join_url?: string;
     name?: string;
  }[];
  authentication_name?: string;
  authentication_option?: string;
  auto_add_recording_to_video_management?: {
     channels?: readonly {
        channel_id: string;
        name?: string;
     }[];
     enable: boolean;
  };
  auto_recording?: "none" | "local" | "cloud";
  auto_start_ai_companion_questions?: boolean;
  auto_start_meeting_summary?: boolean;
  breakout_room?: {
     enable?: boolean;
     rooms?: readonly {
        name?: string;
        participants?: readonly string[];
     }[];
  };
  calendar_type?: 1 | 2;
  close_registration?: boolean;
  cn_meeting?: boolean;
  contact_email?: string;
  contact_name?: string;
  continuous_meeting_chat?: {
     auto_add_invited_external_users?: boolean;
     auto_add_meeting_participants?: boolean;
     channel_id?: string;
     enable?: boolean;
  };
  custom_keys?: readonly {
     key?: string;
     value?: string;
  }[];
  device_testing?: boolean;
  disable_participant_video?: boolean;
  email_in_attendee_report?: boolean;
  email_notification?: boolean;
  encryption_type?: "enhanced_encryption" | "e2ee";
  enforce_login?: boolean;
  enforce_login_domains?: string;
  focus_mode?: boolean;
  global_dial_in_countries?: readonly string[];
  global_dial_in_numbers?: readonly {
     city?: string;
     country?: string;
     country_name?: string;
     number?: string;
     type?: "toll" | "tollfree";
  }[];
  host_save_video_order?: boolean;
  host_video?: boolean;
  in_meeting?: boolean;
  internal_meeting?: boolean;
  jbh_time?: 0 | 5 | 10 | 15;
  join_before_host?: boolean;
  language_interpretation?: {
     enable?: boolean;
     interpreters?: readonly {
        email?: string;
        interpreter_languages?: string;
        languages?: string;
     }[];
  };
  meeting_authentication?: boolean;
  meeting_invitees?: readonly {
     email?: string;
  }[];
  mute_upon_entry?: boolean;
  participant_focused_meeting?: boolean;
  participant_video?: boolean;
  private_meeting?: boolean;
  push_change_to_calendar?: boolean;
  question_and_answer?: {
     allow_anonymous_questions?: boolean;
     allow_submit_questions?: boolean;
     attendees_can_comment?: boolean;
     attendees_can_upvote?: boolean;
     enable?: boolean;
     question_visibility?: "all" | "answered";
  };
  registrants_confirmation_email?: boolean;
  registrants_email_notification?: boolean;
  registration_type?: 1 | 2 | 3;
  request_permission_to_unmute_participants?: boolean;
  resources?: readonly {
     permission_level?: "editor" | "commenter" | "viewer";
     resource_id?: string;
     resource_type?: "whiteboard";
  }[];
  show_join_info?: boolean;
  show_share_button?: boolean;
  sign_language_interpretation?: {
     enable?: boolean;
     interpreters?: readonly {
        email?: string;
        sign_language?: string;
     }[];
  };
  summary_template_id?: string;
  use_pmi?: boolean;
  waiting_room?: boolean;
  waiting_room_options?: {
     mode: "custom" | "follow_setting";
     who_goes_to_waiting_room?:   | "everyone"
        | "users_not_in_account"
        | "users_not_in_account_or_whitelisted_domains"
        | "users_not_on_invite"
        | "users_not_in_org";
  };
  watermark?: boolean;
  who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;
  who_will_receive_summary?: 1 | 2 | 3 | 4;
};

settings.additional_data_center_regions?¶

optional additional_data_center_regions?: readonly string[];

settings.allow_host_control_participant_mute_state?¶

optional allow_host_control_participant_mute_state?: boolean;

settings.allow_multiple_devices?¶

optional allow_multiple_devices?: boolean;

settings.alternative_host_manage_cloud_recording?¶

optional alternative_host_manage_cloud_recording?: boolean;

settings.alternative_host_manage_meeting_summary?¶

optional alternative_host_manage_meeting_summary?: boolean;

settings.alternative_host_update_polls?¶

optional alternative_host_update_polls?: boolean;

settings.alternative_hosts?¶

optional alternative_hosts?: string;

settings.alternative_hosts_email_notification?¶

optional alternative_hosts_email_notification?: boolean;

settings.approval_type?¶

optional approval_type?: 0 | 1 | 2;

settings.approved_or_denied_countries_or_regions?¶

optional approved_or_denied_countries_or_regions?: {
  approved_list?: readonly string[];
  denied_list?: readonly string[];
  enable?: boolean;
  method?: "approve" | "deny";
};

settings.approved_or_denied_countries_or_regions.approved_list?¶

optional approved_list?: readonly string[];

settings.approved_or_denied_countries_or_regions.denied_list?¶

optional denied_list?: readonly string[];

settings.approved_or_denied_countries_or_regions.enable?¶

optional enable?: boolean;

settings.approved_or_denied_countries_or_regions.method?¶

optional method?: "approve" | "deny";

settings.audio?¶

optional audio?: "both" | "telephony" | "voip" | "thirdParty";

settings.audio_conference_info?¶

optional audio_conference_info?: string;

settings.authentication_domains?¶

optional authentication_domains?: string;

settings.authentication_exception?¶

optional authentication_exception?: readonly {
  email?: string;
  join_url?: string;
  name?: string;
}[];

settings.authentication_name?¶

optional authentication_name?: string;

settings.authentication_option?¶

optional authentication_option?: string;

settings.auto_add_recording_to_video_management?¶

optional auto_add_recording_to_video_management?: {
  channels?: readonly {
     channel_id: string;
     name?: string;
  }[];
  enable: boolean;
};

settings.auto_add_recording_to_video_management.channels?¶

optional channels?: readonly {
  channel_id: string;
  name?: string;
}[];

settings.auto_add_recording_to_video_management.enable¶

enable: boolean;

settings.auto_recording?¶

optional auto_recording?: "none" | "local" | "cloud";

settings.auto_start_ai_companion_questions?¶

optional auto_start_ai_companion_questions?: boolean;

settings.auto_start_meeting_summary?¶

optional auto_start_meeting_summary?: boolean;

settings.breakout_room?¶

optional breakout_room?: {
  enable?: boolean;
  rooms?: readonly {
     name?: string;
     participants?: readonly string[];
  }[];
};

settings.breakout_room.enable?¶

optional enable?: boolean;

settings.breakout_room.rooms?¶

optional rooms?: readonly {
  name?: string;
  participants?: readonly string[];
}[];

settings.calendar_type?¶

optional calendar_type?: 1 | 2;

settings.close_registration?¶

optional close_registration?: boolean;

settings.cn_meeting?¶

optional cn_meeting?: boolean;

settings.contact_email?¶

optional contact_email?: string;

settings.contact_name?¶

optional contact_name?: string;

settings.continuous_meeting_chat?¶

optional continuous_meeting_chat?: {
  auto_add_invited_external_users?: boolean;
  auto_add_meeting_participants?: boolean;
  channel_id?: string;
  enable?: boolean;
};

settings.continuous_meeting_chat.auto_add_invited_external_users?¶

optional auto_add_invited_external_users?: boolean;

settings.continuous_meeting_chat.auto_add_meeting_participants?¶

optional auto_add_meeting_participants?: boolean;

settings.continuous_meeting_chat.channel_id?¶

optional channel_id?: string;

settings.continuous_meeting_chat.enable?¶

optional enable?: boolean;

settings.custom_keys?¶

optional custom_keys?: readonly {
  key?: string;
  value?: string;
}[];

settings.device_testing?¶

optional device_testing?: boolean;

settings.disable_participant_video?¶

optional disable_participant_video?: boolean;

settings.email_in_attendee_report?¶

optional email_in_attendee_report?: boolean;

settings.email_notification?¶

optional email_notification?: boolean;

settings.encryption_type?¶

optional encryption_type?: "enhanced_encryption" | "e2ee";

settings.enforce_login?¶

optional enforce_login?: boolean;

settings.enforce_login_domains?¶

optional enforce_login_domains?: string;

settings.focus_mode?¶

optional focus_mode?: boolean;

settings.global_dial_in_countries?¶

optional global_dial_in_countries?: readonly string[];

settings.global_dial_in_numbers?¶

optional global_dial_in_numbers?: readonly {
  city?: string;
  country?: string;
  country_name?: string;
  number?: string;
  type?: "toll" | "tollfree";
}[];

settings.host_save_video_order?¶

optional host_save_video_order?: boolean;

settings.host_video?¶

optional host_video?: boolean;

settings.in_meeting?¶

optional in_meeting?: boolean;

settings.internal_meeting?¶

optional internal_meeting?: boolean;

settings.jbh_time?¶

optional jbh_time?: 0 | 5 | 10 | 15;

settings.join_before_host?¶

optional join_before_host?: boolean;

settings.language_interpretation?¶

optional language_interpretation?: {
  enable?: boolean;
  interpreters?: readonly {
     email?: string;
     interpreter_languages?: string;
     languages?: string;
  }[];
};

settings.language_interpretation.enable?¶

optional enable?: boolean;

settings.language_interpretation.interpreters?¶

optional interpreters?: readonly {
  email?: string;
  interpreter_languages?: string;
  languages?: string;
}[];

settings.meeting_authentication?¶

optional meeting_authentication?: boolean;

settings.meeting_invitees?¶

optional meeting_invitees?: readonly {
  email?: string;
}[];

settings.mute_upon_entry?¶

optional mute_upon_entry?: boolean;

settings.participant_focused_meeting?¶

optional participant_focused_meeting?: boolean;

settings.participant_video?¶

optional participant_video?: boolean;

settings.private_meeting?¶

optional private_meeting?: boolean;

settings.push_change_to_calendar?¶

optional push_change_to_calendar?: boolean;

settings.question_and_answer?¶

optional question_and_answer?: {
  allow_anonymous_questions?: boolean;
  allow_submit_questions?: boolean;
  attendees_can_comment?: boolean;
  attendees_can_upvote?: boolean;
  enable?: boolean;
  question_visibility?: "all" | "answered";
};

settings.question_and_answer.allow_anonymous_questions?¶

optional allow_anonymous_questions?: boolean;

settings.question_and_answer.allow_submit_questions?¶

optional allow_submit_questions?: boolean;

settings.question_and_answer.attendees_can_comment?¶

optional attendees_can_comment?: boolean;

settings.question_and_answer.attendees_can_upvote?¶

optional attendees_can_upvote?: boolean;

settings.question_and_answer.enable?¶

optional enable?: boolean;

settings.question_and_answer.question_visibility?¶

optional question_visibility?: "all" | "answered";

settings.registrants_confirmation_email?¶

optional registrants_confirmation_email?: boolean;

settings.registrants_email_notification?¶

optional registrants_email_notification?: boolean;

settings.registration_type?¶

optional registration_type?: 1 | 2 | 3;

settings.request_permission_to_unmute_participants?¶

optional request_permission_to_unmute_participants?: boolean;

settings.resources?¶

optional resources?: readonly {
  permission_level?: "editor" | "commenter" | "viewer";
  resource_id?: string;
  resource_type?: "whiteboard";
}[];

settings.show_join_info?¶

optional show_join_info?: boolean;

settings.show_share_button?¶

optional show_share_button?: boolean;

settings.sign_language_interpretation?¶

optional sign_language_interpretation?: {
  enable?: boolean;
  interpreters?: readonly {
     email?: string;
     sign_language?: string;
  }[];
};

settings.sign_language_interpretation.enable?¶

optional enable?: boolean;

settings.sign_language_interpretation.interpreters?¶

optional interpreters?: readonly {
  email?: string;
  sign_language?: string;
}[];

settings.summary_template_id?¶

optional summary_template_id?: string;

settings.use_pmi?¶

optional use_pmi?: boolean;

settings.waiting_room?¶

optional waiting_room?: boolean;

settings.waiting_room_options?¶

optional waiting_room_options?: {
  mode: "custom" | "follow_setting";
  who_goes_to_waiting_room?:   | "everyone"
     | "users_not_in_account"
     | "users_not_in_account_or_whitelisted_domains"
     | "users_not_on_invite"
     | "users_not_in_org";
};

settings.waiting_room_options.mode¶

mode: "custom" | "follow_setting";

settings.waiting_room_options.who_goes_to_waiting_room?¶

optional who_goes_to_waiting_room?:
  | "everyone"
  | "users_not_in_account"
  | "users_not_in_account_or_whitelisted_domains"
  | "users_not_on_invite"
  | "users_not_in_org";

settings.watermark?¶

optional watermark?: boolean;

settings.who_can_ask_questions?¶

optional who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;

settings.who_will_receive_summary?¶

optional who_will_receive_summary?: 1 | 2 | 3 | 4;

start_time?¶

optional start_time?: string;

start_url?¶

optional start_url?: string;

status?¶

optional status?: "started" | "waiting";

template_id?¶

optional template_id?: string;

timezone?¶

optional timezone?: string;

topic?¶

optional topic?: string;

tracking_fields?¶

optional tracking_fields?: readonly {
  field?: string;
  value?: string;
  visible?: boolean;
}[];

type?¶

optional type?: 1 | 2 | 3 | 8 | 10;

uuid?¶

optional uuid?: string;

POST /users/{userId}/tsp¶

POST /users/{userId}/tsp: {
  id?: string;
} & {
  conference_code: string;
  dial_in_numbers?: readonly {
     code?: string;
     country_label?: string;
     number?: string;
     type?: "toll" | "tollfree" | "media_link";
  }[];
  leader_pin: string;
  tsp_bridge?: "US_TSP_TB" | "EU_TSP_TB";
};

Type Declaration¶

id?¶

optional id?: string;

Type Declaration¶

conference_code¶

conference_code: string;

dial_in_numbers?¶

optional dial_in_numbers?: readonly {
  code?: string;
  country_label?: string;
  number?: string;
  type?: "toll" | "tollfree" | "media_link";
}[];

leader_pin¶

leader_pin: string;

tsp_bridge?¶

optional tsp_bridge?: "US_TSP_TB" | "EU_TSP_TB";

POST /users/{userId}/webinar_templates¶

POST /users/{userId}/webinar_templates: {
  id?: string;
  name?: string;
};

id?¶

optional id?: string;

name?¶

optional name?: string;

POST /users/{userId}/webinars¶

POST /users/{userId}/webinars: {
  agenda?: string;
  created_at?: string;
  creation_source?: "other" | "open_api" | "web_portal";
  duration?: number;
  encrypted_passcode?: string;
  h323_passcode?: string;
  host_email?: string;
  host_id?: string;
  id?: number;
  is_simulive?: boolean;
  join_url?: string;
  occurrences?: readonly {
     duration?: number;
     occurrence_id?: string;
     start_time?: string;
     status?: "available" | "deleted";
  }[];
  password?: string;
  record_file_id?: string;
  recurrence?: {
     end_date_time?: string;
     end_times?: number;
     monthly_day?: number;
     monthly_week?: -1 | 1 | 2 | 3 | 4;
     monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
     repeat_interval?: number;
     type: 1 | 2 | 3;
     weekly_days?: string;
  };
  registration_url?: string;
  settings?: {
     add_audio_watermark?: boolean;
     add_watermark?: boolean;
     additional_data_center_regions?: readonly string[];
     allow_host_control_participant_mute_state?: boolean;
     allow_multiple_devices?: boolean;
     alternative_host_update_polls?: boolean;
     alternative_hosts?: string;
     approval_type?: 0 | 1 | 2;
     attendees_and_panelists_reminder_email_notification?: {
        enable?: boolean;
        type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
     };
     audio?: "both" | "telephony" | "voip" | "thirdParty";
     audio_conference_info?: string;
     authentication_domains?: string;
     authentication_name?: string;
     authentication_option?: string;
     auto_recording?: "none" | "local" | "cloud";
     close_registration?: boolean;
     contact_email?: string;
     contact_name?: string;
     email_in_attendee_report?: boolean;
     email_language?: string;
     enable_session_branding?: boolean;
     enforce_login?: boolean;
     enforce_login_domains?: string;
     follow_up_absentees_email_notification?: {
        enable?: boolean;
        type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
     };
     follow_up_attendees_email_notification?: {
        enable?: boolean;
        type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
     };
     global_dial_in_countries?: readonly string[];
     global_dial_in_numbers?: readonly {
        city?: string;
        country?: string;
        country_name?: string;
        number?: string;
        type?: "toll" | "tollfree" | "premium";
     }[];
     hd_video?: boolean;
     hd_video_for_attendees?: boolean;
     host_video?: boolean;
     language_interpretation?: {
        enable?: boolean;
        interpreters?: readonly {
           email?: string;
           interpreter_languages?: string;
           languages?: string;
        }[];
     };
     meeting_authentication?: boolean;
     on_demand?: boolean;
     panelist_authentication?: boolean;
     panelists_invitation_email_notification?: boolean;
     panelists_video?: boolean;
     post_webinar_survey?: boolean;
     practice_session?: boolean;
     question_and_answer?: {
        allow_anonymous_questions?: boolean;
        allow_auto_reply?: boolean;
        allow_submit_questions?: boolean;
        answer_questions?: "all" | "only";
        attendees_can_comment?: boolean;
        attendees_can_upvote?: boolean;
        auto_reply_text?: string;
        enable?: boolean;
     };
     registrants_confirmation_email?: boolean;
     registrants_email_notification?: boolean;
     registrants_restrict_number?: number;
     registration_type?: 1 | 2 | 3;
     request_permission_to_unmute_participants?: boolean;
     send_1080p_video_to_attendees?: boolean;
     show_join_info?: boolean;
     show_share_button?: boolean;
     sign_language_interpretation?: {
        enable?: boolean;
        interpreters?: readonly {
           email?: string;
           sign_language?: string;
        }[];
     };
     survey_url?: string;
  };
  simulive_delay_start?: {
     enable?: boolean;
     time?: number;
     timeunit?: string;
  };
  start_time?: string;
  start_url?: string;
  template_id?: string;
  timezone?: string;
  topic?: string;
  tracking_fields?: readonly {
     field?: string;
     value?: string;
     visible?: boolean;
  }[];
  transition_to_live?: boolean;
  type?: 5 | 6 | 9;
  uuid?: string;
};

agenda?¶

optional agenda?: string;

created_at?¶

optional created_at?: string;

creation_source?¶

optional creation_source?: "other" | "open_api" | "web_portal";

duration?¶

optional duration?: number;

encrypted_passcode?¶

optional encrypted_passcode?: string;

h323_passcode?¶

optional h323_passcode?: string;

host_email?¶

optional host_email?: string;

host_id?¶

optional host_id?: string;

id?¶

optional id?: number;

is_simulive?¶

optional is_simulive?: boolean;

join_url?¶

optional join_url?: string;

occurrences?¶

optional occurrences?: readonly {
  duration?: number;
  occurrence_id?: string;
  start_time?: string;
  status?: "available" | "deleted";
}[];

password?¶

optional password?: string;

record_file_id?¶

optional record_file_id?: string;

recurrence?¶

optional recurrence?: {
  end_date_time?: string;
  end_times?: number;
  monthly_day?: number;
  monthly_week?: -1 | 1 | 2 | 3 | 4;
  monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
  repeat_interval?: number;
  type: 1 | 2 | 3;
  weekly_days?: string;
};

recurrence.end_date_time?¶

optional end_date_time?: string;

recurrence.end_times?¶

optional end_times?: number;

recurrence.monthly_day?¶

optional monthly_day?: number;

recurrence.monthly_week?¶

optional monthly_week?: -1 | 1 | 2 | 3 | 4;

recurrence.monthly_week_day?¶

optional monthly_week_day?: 1 | 2 | 3 | 4 | 5 | 6 | 7;

recurrence.repeat_interval?¶

optional repeat_interval?: number;

recurrence.type¶

type: 1 | 2 | 3;

recurrence.weekly_days?¶

optional weekly_days?: string;

registration_url?¶

optional registration_url?: string;

settings?¶

optional settings?: {
  add_audio_watermark?: boolean;
  add_watermark?: boolean;
  additional_data_center_regions?: readonly string[];
  allow_host_control_participant_mute_state?: boolean;
  allow_multiple_devices?: boolean;
  alternative_host_update_polls?: boolean;
  alternative_hosts?: string;
  approval_type?: 0 | 1 | 2;
  attendees_and_panelists_reminder_email_notification?: {
     enable?: boolean;
     type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
  };
  audio?: "both" | "telephony" | "voip" | "thirdParty";
  audio_conference_info?: string;
  authentication_domains?: string;
  authentication_name?: string;
  authentication_option?: string;
  auto_recording?: "none" | "local" | "cloud";
  close_registration?: boolean;
  contact_email?: string;
  contact_name?: string;
  email_in_attendee_report?: boolean;
  email_language?: string;
  enable_session_branding?: boolean;
  enforce_login?: boolean;
  enforce_login_domains?: string;
  follow_up_absentees_email_notification?: {
     enable?: boolean;
     type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
  };
  follow_up_attendees_email_notification?: {
     enable?: boolean;
     type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
  };
  global_dial_in_countries?: readonly string[];
  global_dial_in_numbers?: readonly {
     city?: string;
     country?: string;
     country_name?: string;
     number?: string;
     type?: "toll" | "tollfree" | "premium";
  }[];
  hd_video?: boolean;
  hd_video_for_attendees?: boolean;
  host_video?: boolean;
  language_interpretation?: {
     enable?: boolean;
     interpreters?: readonly {
        email?: string;
        interpreter_languages?: string;
        languages?: string;
     }[];
  };
  meeting_authentication?: boolean;
  on_demand?: boolean;
  panelist_authentication?: boolean;
  panelists_invitation_email_notification?: boolean;
  panelists_video?: boolean;
  post_webinar_survey?: boolean;
  practice_session?: boolean;
  question_and_answer?: {
     allow_anonymous_questions?: boolean;
     allow_auto_reply?: boolean;
     allow_submit_questions?: boolean;
     answer_questions?: "all" | "only";
     attendees_can_comment?: boolean;
     attendees_can_upvote?: boolean;
     auto_reply_text?: string;
     enable?: boolean;
  };
  registrants_confirmation_email?: boolean;
  registrants_email_notification?: boolean;
  registrants_restrict_number?: number;
  registration_type?: 1 | 2 | 3;
  request_permission_to_unmute_participants?: boolean;
  send_1080p_video_to_attendees?: boolean;
  show_join_info?: boolean;
  show_share_button?: boolean;
  sign_language_interpretation?: {
     enable?: boolean;
     interpreters?: readonly {
        email?: string;
        sign_language?: string;
     }[];
  };
  survey_url?: string;
};

settings.add_audio_watermark?¶

optional add_audio_watermark?: boolean;

settings.add_watermark?¶

optional add_watermark?: boolean;

settings.additional_data_center_regions?¶

optional additional_data_center_regions?: readonly string[];

settings.allow_host_control_participant_mute_state?¶

optional allow_host_control_participant_mute_state?: boolean;

settings.allow_multiple_devices?¶

optional allow_multiple_devices?: boolean;

settings.alternative_host_update_polls?¶

optional alternative_host_update_polls?: boolean;

settings.alternative_hosts?¶

optional alternative_hosts?: string;

settings.approval_type?¶

optional approval_type?: 0 | 1 | 2;

settings.attendees_and_panelists_reminder_email_notification?¶

optional attendees_and_panelists_reminder_email_notification?: {
  enable?: boolean;
  type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
};

settings.attendees_and_panelists_reminder_email_notification.enable?¶

optional enable?: boolean;

settings.attendees_and_panelists_reminder_email_notification.type?¶

optional type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;

settings.audio?¶

optional audio?: "both" | "telephony" | "voip" | "thirdParty";

settings.audio_conference_info?¶

optional audio_conference_info?: string;

settings.authentication_domains?¶

optional authentication_domains?: string;

settings.authentication_name?¶

optional authentication_name?: string;

settings.authentication_option?¶

optional authentication_option?: string;

settings.auto_recording?¶

optional auto_recording?: "none" | "local" | "cloud";

settings.close_registration?¶

optional close_registration?: boolean;

settings.contact_email?¶

optional contact_email?: string;

settings.contact_name?¶

optional contact_name?: string;

settings.email_in_attendee_report?¶

optional email_in_attendee_report?: boolean;

settings.email_language?¶

optional email_language?: string;

settings.enable_session_branding?¶

optional enable_session_branding?: boolean;

settings.enforce_login?¶

optional enforce_login?: boolean;

settings.enforce_login_domains?¶

optional enforce_login_domains?: string;

settings.follow_up_absentees_email_notification?¶

optional follow_up_absentees_email_notification?: {
  enable?: boolean;
  type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
};

settings.follow_up_absentees_email_notification.enable?¶

optional enable?: boolean;

settings.follow_up_absentees_email_notification.type?¶

optional type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;

settings.follow_up_attendees_email_notification?¶

optional follow_up_attendees_email_notification?: {
  enable?: boolean;
  type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
};

settings.follow_up_attendees_email_notification.enable?¶

optional enable?: boolean;

settings.follow_up_attendees_email_notification.type?¶

optional type?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;

settings.global_dial_in_countries?¶

optional global_dial_in_countries?: readonly string[];

settings.global_dial_in_numbers?¶

optional global_dial_in_numbers?: readonly {
  city?: string;
  country?: string;
  country_name?: string;
  number?: string;
  type?: "toll" | "tollfree" | "premium";
}[];

settings.hd_video?¶

optional hd_video?: boolean;

settings.hd_video_for_attendees?¶

optional hd_video_for_attendees?: boolean;

settings.host_video?¶

optional host_video?: boolean;

settings.language_interpretation?¶

optional language_interpretation?: {
  enable?: boolean;
  interpreters?: readonly {
     email?: string;
     interpreter_languages?: string;
     languages?: string;
  }[];
};

settings.language_interpretation.enable?¶

optional enable?: boolean;

settings.language_interpretation.interpreters?¶

optional interpreters?: readonly {
  email?: string;
  interpreter_languages?: string;
  languages?: string;
}[];

settings.meeting_authentication?¶

optional meeting_authentication?: boolean;

settings.on_demand?¶

optional on_demand?: boolean;

settings.panelist_authentication?¶

optional panelist_authentication?: boolean;

settings.panelists_invitation_email_notification?¶

optional panelists_invitation_email_notification?: boolean;

settings.panelists_video?¶

optional panelists_video?: boolean;

settings.post_webinar_survey?¶

optional post_webinar_survey?: boolean;

settings.practice_session?¶

optional practice_session?: boolean;

settings.question_and_answer?¶

optional question_and_answer?: {
  allow_anonymous_questions?: boolean;
  allow_auto_reply?: boolean;
  allow_submit_questions?: boolean;
  answer_questions?: "all" | "only";
  attendees_can_comment?: boolean;
  attendees_can_upvote?: boolean;
  auto_reply_text?: string;
  enable?: boolean;
};

settings.question_and_answer.allow_anonymous_questions?¶

optional allow_anonymous_questions?: boolean;

settings.question_and_answer.allow_auto_reply?¶

optional allow_auto_reply?: boolean;

settings.question_and_answer.allow_submit_questions?¶

optional allow_submit_questions?: boolean;

settings.question_and_answer.answer_questions?¶

optional answer_questions?: "all" | "only";

settings.question_and_answer.attendees_can_comment?¶

optional attendees_can_comment?: boolean;

settings.question_and_answer.attendees_can_upvote?¶

optional attendees_can_upvote?: boolean;

settings.question_and_answer.auto_reply_text?¶

optional auto_reply_text?: string;

settings.question_and_answer.enable?¶

optional enable?: boolean;

settings.registrants_confirmation_email?¶

optional registrants_confirmation_email?: boolean;

settings.registrants_email_notification?¶

optional registrants_email_notification?: boolean;

settings.registrants_restrict_number?¶

optional registrants_restrict_number?: number;

settings.registration_type?¶

optional registration_type?: 1 | 2 | 3;

settings.request_permission_to_unmute_participants?¶

optional request_permission_to_unmute_participants?: boolean;

settings.send_1080p_video_to_attendees?¶

optional send_1080p_video_to_attendees?: boolean;

settings.show_join_info?¶

optional show_join_info?: boolean;

settings.show_share_button?¶

optional show_share_button?: boolean;

settings.sign_language_interpretation?¶

optional sign_language_interpretation?: {
  enable?: boolean;
  interpreters?: readonly {
     email?: string;
     sign_language?: string;
  }[];
};

settings.sign_language_interpretation.enable?¶

optional enable?: boolean;

settings.sign_language_interpretation.interpreters?¶

optional interpreters?: readonly {
  email?: string;
  sign_language?: string;
}[];

settings.survey_url?¶

optional survey_url?: string;

simulive_delay_start?¶

optional simulive_delay_start?: {
  enable?: boolean;
  time?: number;
  timeunit?: string;
};

simulive_delay_start.enable?¶

optional enable?: boolean;

simulive_delay_start.time?¶

optional time?: number;

simulive_delay_start.timeunit?¶

optional timeunit?: string;

start_time?¶

optional start_time?: string;

start_url?¶

optional start_url?: string;

template_id?¶

optional template_id?: string;

timezone?¶

optional timezone?: string;

topic?¶

optional topic?: string;

tracking_fields?¶

optional tracking_fields?: readonly {
  field?: string;
  value?: string;
  visible?: boolean;
}[];

transition_to_live?¶

optional transition_to_live?: boolean;

type?¶

optional type?: 5 | 6 | 9;

uuid?¶

optional uuid?: string;

POST /webinars/{webinarId}/batch_registrants¶

POST /webinars/{webinarId}/batch_registrants: {
  registrants?: readonly {
     email?: string;
     join_url?: string;
     registrant_id?: string;
  }[];
};

registrants?¶

optional registrants?: readonly {
  email?: string;
  join_url?: string;
  registrant_id?: string;
}[];

POST /webinars/{webinarId}/branding/name_tags¶

POST /webinars/{webinarId}/branding/name_tags: {
  accent_color?: string;
  background_color?: string;
  id?: string;
  is_default?: boolean;
  name?: string;
  text_color?: string;
};

accent_color?¶

optional accent_color?: string;

background_color?¶

optional background_color?: string;

id?¶

optional id?: string;

is_default?¶

optional is_default?: boolean;

name?¶

optional name?: string;

text_color?¶

optional text_color?: string;

POST /webinars/{webinarId}/branding/virtual_backgrounds¶

POST /webinars/{webinarId}/branding/virtual_backgrounds: {
  id?: string;
  is_default?: boolean;
  name?: string;
  size?: number;
  type?: "image";
};

id?¶

optional id?: string;

is_default?¶

optional is_default?: boolean;

name?¶

optional name?: string;

size?¶

optional size?: number;

type?¶

optional type?: "image";

POST /webinars/{webinarId}/branding/wallpaper¶

POST /webinars/{webinarId}/branding/wallpaper: {
  id?: string;
  name?: string;
  size?: number;
  type?: "image";
};

id?¶

optional id?: string;

name?¶

optional name?: string;

size?¶

optional size?: number;

type?¶

optional type?: "image";

POST /webinars/{webinarId}/invite_links¶

POST /webinars/{webinarId}/invite_links: {
  attendees?: readonly {
     join_url?: string;
     name?: string;
  }[];
};

attendees?¶

optional attendees?: readonly {
  join_url?: string;
  name?: string;
}[];

POST /webinars/{webinarId}/panelists¶

POST /webinars/{webinarId}/panelists: {
  id?: string;
  updated_at?: string;
};

id?¶

optional id?: string;

updated_at?¶

optional updated_at?: string;

POST /webinars/{webinarId}/polls¶

POST /webinars/{webinarId}/polls: {
  id?: string;
  status?: "started" | "ended" | "notstart" | "sharing";
} & {
  anonymous?: boolean;
  poll_type?: 1 | 2 | 3;
  questions?: readonly {
     answer_max_character?: number;
     answer_min_character?: number;
     answer_required?: boolean;
     answers?: readonly string[];
     case_sensitive?: boolean;
     name?: string;
     prompts?: readonly {
        prompt_question?: string;
        prompt_right_answers?: readonly string[];
     }[];
     rating_max_label?: string;
     rating_max_value?: number;
     rating_min_label?: string;
     rating_min_value?: number;
     right_answers?: readonly string[];
     show_as_dropdown?: boolean;
     type?:   | "single"
        | "multiple"
        | "matching"
        | "rank_order"
        | "short_answer"
        | "long_answer"
        | "fill_in_the_blank"
        | "rating_scale";
  }[];
  title?: string;
};

Type Declaration¶

id?¶

optional id?: string;

status?¶

optional status?: "started" | "ended" | "notstart" | "sharing";

Type Declaration¶

anonymous?¶

optional anonymous?: boolean;

poll_type?¶

optional poll_type?: 1 | 2 | 3;

questions?¶

optional questions?: readonly {
  answer_max_character?: number;
  answer_min_character?: number;
  answer_required?: boolean;
  answers?: readonly string[];
  case_sensitive?: boolean;
  name?: string;
  prompts?: readonly {
     prompt_question?: string;
     prompt_right_answers?: readonly string[];
  }[];
  rating_max_label?: string;
  rating_max_value?: number;
  rating_min_label?: string;
  rating_min_value?: number;
  right_answers?: readonly string[];
  show_as_dropdown?: boolean;
  type?:   | "single"
     | "multiple"
     | "matching"
     | "rank_order"
     | "short_answer"
     | "long_answer"
     | "fill_in_the_blank"
     | "rating_scale";
}[];

title?¶

optional title?: string;

POST /webinars/{webinarId}/registrants¶

POST /webinars/{webinarId}/registrants: {
  id?: number;
  join_url?: string;
  occurrences?: readonly {
     duration?: number;
     occurrence_id?: string;
     start_time?: string;
     status?: string;
  }[];
  registrant_id?: string;
  start_time?: string;
  topic?: string;
};

id?¶

optional id?: number;

join_url?¶

optional join_url?: string;

occurrences?¶

optional occurrences?: readonly {
  duration?: number;
  occurrence_id?: string;
  start_time?: string;
  status?: string;
}[];

registrant_id?¶

optional registrant_id?: string;

start_time?¶

optional start_time?: string;

topic?¶

optional topic?: string;

POST /webinars/{webinarId}/sip_dialing¶

POST /webinars/{webinarId}/sip_dialing: {
  expire_in?: number;
  paid_crc_plan_participant?: boolean;
  participant_identifier_code?: string;
  sip_dialing?: string;
};

expire_in?¶

optional expire_in?: number;

paid_crc_plan_participant?¶

optional paid_crc_plan_participant?: boolean;

participant_identifier_code?¶

optional participant_identifier_code?: string;

sip_dialing?¶

optional sip_dialing?: string;

PUT /meetings/{meetingId}/polls/{pollId}¶

PUT /meetings/{meetingId}/polls/{pollId}: void;

PUT /meetings/{meetingId}/recordings/{recordingId}/status¶

PUT /meetings/{meetingId}/recordings/{recordingId}/status: void;

PUT /meetings/{meetingId}/recordings/registrants/status¶

PUT /meetings/{meetingId}/recordings/registrants/status: void;

PUT /meetings/{meetingId}/registrants/status¶

PUT /meetings/{meetingId}/registrants/status: void;

PUT /meetings/{meetingId}/status¶

PUT /meetings/{meetingId}/status: void;

PUT /meetings/{meetingUUID}/recordings/status¶

PUT /meetings/{meetingUUID}/recordings/status: void;

PUT /webinars/{webinarId}/polls/{pollId}¶

PUT /webinars/{webinarId}/polls/{pollId}: void;

PUT /webinars/{webinarId}/registrants/status¶

PUT /webinars/{webinarId}/registrants/status: void;

PUT /webinars/{webinarId}/status¶

PUT /webinars/{webinarId}/status: void;

ZoomOperationRequestInput¶

Properties¶

body?¶

optional body?: ZoomVideoProviderPayload;

headers?¶

optional headers?: Record<string, string>;

pathParams?¶

optional pathParams?: Record<string, string | number | boolean>;

query?¶

optional query?: ZoomVideoProviderQuery;

ZoomProviderJsonRetryOptions¶

Properties¶

attempts?¶

optional attempts?: number;

baseDelayMs?¶

optional baseDelayMs?: number;

maxDelayMs?¶

optional maxDelayMs?: number;

statusCodes?¶

optional statusCodes?: readonly number[];

ZoomResource¶

Indexable¶

[key: string]: ZoomVideoProviderExtensionValue

ZoomServerOAuthTokenOptions¶

Properties¶

accountId¶

accountId: string;

clientId¶

clientId: string;

clientSecret¶

clientSecret: string;

fetch?¶

optional fetch?: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`URL` \| `RequestInfo`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`string` \| `Request` \| `URL`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

oauthBaseUrl?¶

optional oauthBaseUrl?: string;

signal?¶

optional signal?: AbortSignal;

ZoomSignedWebhookRequest¶

Properties¶

contentType?¶

optional contentType?: string;

event?¶

optional event?: string;

json?¶

optional json?: ZoomWebhookEvent;

payload?¶

optional payload?: {
[key: string]: ZoomVideoProviderExtensionValue;
  account_id?: string;
  object?: ZoomVideoProviderExtensionValue;
  plainToken?: string;
};

Index Signature¶

[key: string]: ZoomVideoProviderExtensionValue

account_id?¶

optional account_id?: string;

object?¶

optional object?: ZoomVideoProviderExtensionValue;

plainToken?¶

optional plainToken?: string;

rawBody¶

rawBody: string;

urlValidationResponse?¶

optional urlValidationResponse?: ZoomWebhookValidationResponse;

ZoomTrackingField¶

Properties¶

field¶

field: string;

value¶

value: string;

ZoomUpdateMeetingInput¶

Properties¶

additionalFields?¶

optional additionalFields?: ZoomVideoProviderExtensionFields;

agenda?¶

optional agenda?: string;

duration?¶

optional duration?: number;

password?¶

optional password?: string;

recurrence?¶

optional recurrence?: ZoomMeetingRecurrence;

scheduleFor?¶

optional scheduleFor?: string;

settings?¶

optional settings?: ZoomVideoJsonObject;

startTime?¶

optional startTime?: string;

timezone?¶

optional timezone?: string;

topic?¶

optional topic?: string;

trackingFields?¶

optional trackingFields?: ZoomTrackingField[];

type?¶

optional type?: ZoomMeetingType;

ZoomUserResource¶

Indexable¶

[key: string]: ZoomVideoProviderExtensionValue

Properties¶

account_id?¶

optional account_id?: string;

email?¶

optional email?: string;

first_name?¶

optional first_name?: string;

id?¶

optional id?: string;

last_name?¶

optional last_name?: string;

status?¶

optional status?: string;

type?¶

optional type?: number;

ZoomVideoClient¶

Extends¶

ZoomVideoProviderClient

Properties¶

meetingsApi¶

meetingsApi: ZoomMeetingsApiGeneratedClient;

providerClient¶

providerClient: ZoomVideoProviderClient;

rawClient?¶

optional rawClient?: unknown;

Inherited from¶

ZoomVideoProviderClient.rawClient

requestOperation¶

requestOperation: ZoomMeetingsGeneratedOperationCaller;

Inherited from¶

ZoomVideoProviderClient.requestOperation

Methods¶

createMeeting()¶

createMeeting(input): Promise<ZoomMeetingResource>;

Parameters¶

Parameter	Type
`input`	`ZoomCreateMeetingInput`

Returns¶

Promise\<ZoomMeetingResource>

Inherited from¶

ZoomVideoProviderClient.createMeeting

deleteMeeting()¶

deleteMeeting(meetingId, input?): Promise<Record<string, never>>;

Parameters¶

Parameter	Type
`meetingId`	`string` \| `number`
`input?`	`ZoomDeleteMeetingInput`

Returns¶

Promise\<Record\<string, never>>

Inherited from¶

ZoomVideoProviderClient.deleteMeeting

getCurrentUser()¶

getCurrentUser(): Promise<ZoomUserResource>;

Returns¶

Promise\<ZoomUserResource>

Inherited from¶

ZoomVideoProviderClient.getCurrentUser

getMeeting()¶

getMeeting(meetingId, input?): Promise<ZoomMeetingResource>;

Parameters¶

Parameter	Type
`meetingId`	`string` \| `number`
`input?`	`ZoomGetMeetingInput`

Returns¶

Promise\<ZoomMeetingResource>

Inherited from¶

ZoomVideoProviderClient.getMeeting

listMeetings()¶

listMeetings(input?): Promise<ZoomListMeetingsResponse>;

Parameters¶

Parameter	Type
`input?`	`ZoomListMeetingsInput`

Returns¶

Promise\<ZoomListMeetingsResponse>

Inherited from¶

ZoomVideoProviderClient.listMeetings

rawRequest()?¶

optional rawRequest<T>(operation, input?): Promise<T>;

Type Parameters¶

Type Parameter	Default type
`T`	`ZoomVideoJsonValue`

Parameters¶

Parameter	Type
`operation`	`string`
`input?`	`unknown`

Returns¶

Promise\<T>

Inherited from¶

ZoomVideoProviderClient.rawRequest

updateMeeting()¶

updateMeeting(meetingId, input): Promise<ZoomMeetingResource>;

Parameters¶

Parameter	Type
`meetingId`	`string` \| `number`
`input`	`ZoomUpdateMeetingInput`

Returns¶

Promise\<ZoomMeetingResource>

Inherited from¶

ZoomVideoProviderClient.updateMeeting

ZoomVideoClientOptions¶

Extended by¶

ZoomLiveCheckOptions

Properties¶

accessToken?¶

optional accessToken?: string;

accountId?¶

optional accountId?: string;

baseUrl?¶

optional baseUrl?: string;

clientId?¶

optional clientId?: string;

clientSecret?¶

optional clientSecret?: string;

fetch?¶

optional fetch?: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`URL` \| `RequestInfo`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`string` \| `Request` \| `URL`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

getAccessToken?¶

optional getAccessToken?: () => string | Promise<string>;

Returns¶

string | Promise\<string>

oauthBaseUrl?¶

optional oauthBaseUrl?: string;

providerClient?¶

optional providerClient?: ZoomVideoProviderClient;

retry?¶

optional retry?:
  | number
  | ZoomProviderJsonRetryOptions;

signal?¶

optional signal?: AbortSignal;

timeoutMs?¶

optional timeoutMs?: number;

userId?¶

optional userId?: string | number;

ZoomVideoJsonObject¶

Indexable¶

[key: string]: ZoomVideoProviderExtensionValue

ZoomVideoProviderClient¶

Extended by¶

ZoomVideoClient

Properties¶

rawClient?¶

optional rawClient?: unknown;

requestOperation¶

requestOperation: ZoomMeetingsGeneratedOperationCaller;

Methods¶

createMeeting()¶

createMeeting(input): Promise<ZoomMeetingResource>;

Parameters¶

Parameter	Type
`input`	`ZoomCreateMeetingInput`

Returns¶

Promise\<ZoomMeetingResource>

deleteMeeting()¶

deleteMeeting(meetingId, input?): Promise<Record<string, never>>;

Parameters¶

Parameter	Type
`meetingId`	`string` \| `number`
`input?`	`ZoomDeleteMeetingInput`

Returns¶

Promise\<Record\<string, never>>

getCurrentUser()¶

getCurrentUser(): Promise<ZoomUserResource>;

Returns¶

Promise\<ZoomUserResource>

getMeeting()¶

getMeeting(meetingId, input?): Promise<ZoomMeetingResource>;

Parameters¶

Parameter	Type
`meetingId`	`string` \| `number`
`input?`	`ZoomGetMeetingInput`

Returns¶

Promise\<ZoomMeetingResource>

listMeetings()¶

listMeetings(input?): Promise<ZoomListMeetingsResponse>;

Parameters¶

Parameter	Type
`input?`	`ZoomListMeetingsInput`

Returns¶

Promise\<ZoomListMeetingsResponse>

rawRequest()?¶

optional rawRequest<T>(operation, input?): Promise<T>;

Type Parameters¶

Type Parameter	Default type
`T`	`ZoomVideoJsonValue`

Parameters¶

Parameter	Type
`operation`	`string`
`input?`	`unknown`

Returns¶

Promise\<T>

updateMeeting()¶

updateMeeting(meetingId, input): Promise<ZoomMeetingResource>;

Parameters¶

Parameter	Type
`meetingId`	`string` \| `number`
`input`	`ZoomUpdateMeetingInput`

Returns¶

Promise\<ZoomMeetingResource>

ZoomVideoProviderExtensionFields¶

Extends¶

ZoomVideoJsonObject

Indexable¶

[key: string]: ZoomVideoProviderExtensionValue

ZoomVideoProviderResponse¶

Extends¶

ZoomVideoJsonObject

Indexable¶

[key: string]: ZoomVideoProviderExtensionValue

ZoomWebhookEvent¶

Indexable¶

[key: string]: ZoomVideoProviderExtensionValue

Properties¶

event?¶

optional event?: string;

event_ts?¶

optional event_ts?: number;

payload?¶

optional payload?: {
[key: string]: ZoomVideoProviderExtensionValue;
  account_id?: string;
  object?: ZoomVideoProviderExtensionValue;
  plainToken?: string;
};

Index Signature¶

[key: string]: ZoomVideoProviderExtensionValue

account_id?¶

optional account_id?: string;

object?¶

optional object?: ZoomVideoProviderExtensionValue;

plainToken?¶

optional plainToken?: string;

ZoomWebhookValidationInput¶

Properties¶

plainToken¶

plainToken: string;

webhookSecretToken¶

webhookSecretToken: string;

ZoomWebhookValidationResponse¶

Properties¶

encryptedToken¶

encryptedToken: string;

plainToken¶

plainToken: string;

Type Aliases¶

ZoomListMeetingType¶

type ZoomListMeetingType =
  | "scheduled"
  | "live"
  | "upcoming"
  | "upcoming_meetings"
  | "previous_meetings";

ZoomMeetingsApiOperationUid¶

type ZoomMeetingsApiOperationUid = typeof ZOOM_MEETINGS_API_OPERATION_UIDS[number];

ZoomMeetingsApiSchemaJsonPrimitive¶

type ZoomMeetingsApiSchemaJsonPrimitive = string | number | boolean | null;

ZoomMeetingsApiSchemaJsonValue¶

type ZoomMeetingsApiSchemaJsonValue =
  | ZoomMeetingsApiSchemaJsonPrimitive
  | readonly ZoomMeetingsApiSchemaJsonValue[]
  | {
[key: string]: ZoomMeetingsApiSchemaJsonValue;
};

ZoomMeetingsGeneratedOperationCaller¶

type ZoomMeetingsGeneratedOperationCaller = <OperationKey>(operationKey, ...args) => Promise<ZoomMeetingsApiOperationResponseMap[OperationKey]>;

Type Parameters¶

Type Parameter
`OperationKey` extends `ZoomMeetingsApiOperationKey`

Parameters¶

Parameter	Type
`operationKey`	`OperationKey`
...`args`	`ZoomMeetingsApiOperationArgs`\<`OperationKey`>

Returns¶

Promise\<ZoomMeetingsApiOperationResponseMap[OperationKey]>

ZoomMeetingStatus¶

type ZoomMeetingStatus = "waiting" | "started" | "finished";

ZoomMeetingType¶

type ZoomMeetingType = 1 | 2 | 3 | 8 | 10;

ZoomMonthlyWeek¶

type ZoomMonthlyWeek = -1 | 1 | 2 | 3 | 4;

ZoomRecurrenceType¶

type ZoomRecurrenceType = 1 | 2 | 3;

ZoomVideoJsonPrimitive¶

type ZoomVideoJsonPrimitive = string | number | boolean | null;

ZoomVideoJsonValue¶

type ZoomVideoJsonValue =
  | ZoomVideoJsonPrimitive
  | ZoomVideoJsonObject
  | readonly ZoomVideoJsonValue[];

ZoomVideoProviderExtensionValue¶

type ZoomVideoProviderExtensionValue = ZoomVideoJsonValue | object | undefined;

ZoomVideoProviderPayload¶

type ZoomVideoProviderPayload = ZoomVideoJsonObject | object;

ZoomVideoProviderQuery¶

type ZoomVideoProviderQuery = Record<string, ZoomVideoProviderExtensionValue>;

ZoomWeekday¶

type ZoomWeekday = 1 | 2 | 3 | 4 | 5 | 6 | 7;

Variables¶

ZOOM_MEETINGS_API_DOCS_SOURCE¶

const ZOOM_MEETINGS_API_DOCS_SOURCE: "https://developers.zoom.us/docs/api/meetings/" = "https://developers.zoom.us/docs/api/meetings/";

ZOOM_MEETINGS_API_GENERATED_AT¶

const ZOOM_MEETINGS_API_GENERATED_AT: "2026-06-18" = "2026-06-18";

ZOOM_MEETINGS_API_GENERATED_FUNCTION_COUNT¶

const ZOOM_MEETINGS_API_GENERATED_FUNCTION_COUNT: 184;

ZOOM_MEETINGS_API_GENERATED_FUNCTION_NAMES¶

const ZOOM_MEETINGS_API_GENERATED_FUNCTION_NAMES: readonly ["ListArchivedFiles", "GetArchivedFileStatistics", "UpdateArchivedFile", "MeetingLocalArchivingArchiveToken", "GetArchivedFiles", "DeleteArchivedFiles", "RecordingGet", "RecordingDelete", "AnalyticsDetails", "AnalyticsSummary", "MeetingRecordingRegistrants", "MeetingRecordingRegistrantCreate", "RecordingRegistrantsQuestionsGet", "RecordingRegistrantQuestionUpdate", "MeetingRecordingRegistrantStatus", "RecordingSettingUpdate", "RecordingSettingsUpdate", "RecordingDeleteOne", "RecordingStatusUpdateOne", "GetMeetingTranscript", "DeleteMeetingTranscript", "RecordingStatusUpdate", "RecordingsList", "ListDevices", "AddDevice", "Getzdmgroupinfo", "AssigndevicetoauserCommonarea", "GetZpaDeviceListProfileSettingOfaUser", "UpgradeZpasApp", "DeleteZpaDeviceByVendorAndMacAddress", "GetZpaVersioninfo", "GetDevice", "DeleteDevice", "UpdateDevice", "AssginGroup", "ChangeDeviceAssociation", "DeviceList", "DeviceCreate", "DeviceDelete", "DeviceUpdate", "MeetingAppAdd", "MeetingAppDelete", "DeleteMeetingChatMessageById", "UpdateMeetingChatMessageById", "InMeetingControl", "MeetingLocalRecordingJoinToken", "MeetingToken", "AddBatchRegistrants", "MeetingInvitation", "MeetingInviteLinksCreate", "MeetingRegistrants", "MeetingRegistrantCreate", "MeetingRegistrantsQuestionsGet", "MeetingRegistrantQuestionUpdate", "MeetingRegistrantStatus", "MeetingRegistrantGet", "Meetingregistrantdelete", "MeetingLiveStreamingJoinToken", "GetMeetingLiveStreamDetails", "MeetingLiveStreamUpdate", "MeetingLiveStreamStatusUpdate", "MeetingRTMSStatusUpdate", "Meeting", "MeetingDelete", "MeetingUpdate", "GetSipDialingWithPasscode", "MeetingStatus", "PastMeetingDetails", "PastMeetings", "PastMeetingParticipants", "ListPastMeetingQA", "Meetings", "MeetingCreate", "ListUpcomingMeeting", "UserPACs", "CreateBatchPolls", "MeetingPolls", "MeetingPollCreate", "MeetingPollGet", "MeetingPollUpdate", "MeetingPollDelete", "ListPastMeetingPolls", "ReportSignInSignOutActivities", "GetBillingReport", "GetBillingInvoicesReports", "ReportCloudRecording", "ReportDaily", "Getdisclaimerreport", "Gethistorymeetingandwebinarlist", "ReportMeetingactivitylogs", "ReportMeetingDetails", "ReportMeetingParticipants", "ReportMeetingPolls", "ReportMeetingQA", "ReportMeetingSurvey", "ReportOperationLogs", "Getremotesupportreport", "ReportTelephone", "ReportUpcomingEvents", "ReportUsers", "ReportMeetings", "ReportWebinarDetails", "ReportWebinarParticipants", "ReportWebinarPolls", "ReportWebinarQA", "ReportWebinarSurvey", "ListSIPPhonePhones", "EnableSIPPhonePhones", "DeleteSIPPhonePhones", "UpdateSIPPhonePhones", "Listmeetingsummaries", "Getameetingsummary", "Deletemeetingorwebinarsummary", "MeetingSurveyGet", "MeetingSurveyDelete", "MeetingSurveyUpdate", "ListMeetingTemplates", "MeetingTemplateCreate", "TrackingfieldList", "TrackingfieldCreate", "TrackingfieldGet", "TrackingfieldDelete", "TrackingfieldUpdate", "Tsp", "TspUpdate", "UserTSPs", "UserTSPCreate", "TspUrlUpdate", "UserTSP", "UserTSPDelete", "UserTSPUpdate", "DeleteWebinarChatMessageById", "WebinarAbsentees", "PastWebinars", "ListWebinarParticipants", "ListPastWebinarPollResults", "ListPastWebinarQA", "ListWebinarTemplates", "WebinarTemplateCreate", "Webinars", "WebinarCreate", "Webinar", "WebinarDelete", "WebinarUpdate", "AddBatchWebinarRegistrants", "GetWebinarBranding", "CreateWebinarBrandingNameTag", "DeleteWebinarBrandingNameTag", "UpdateWebinarBrandingNameTag", "UploadWebinarBrandingVB", "DeleteWebinarBrandingVB", "SetWebinarBrandingVB", "UploadWebinarBrandingWallpaper", "DeleteWebinarBrandingWallpaper", "WebinarInviteLinksCreate", "WebinarLiveStreamingJoinToken", "WebinarLocalArchivingArchiveToken", "WebinarLocalRecordingJoinToken", "GetWebinarLiveStreamDetails", "WebinarLiveStreamUpdate", "WebinarLiveStreamStatusUpdate", "WebinarPanelists", "WebinarPanelistCreate", "WebinarPanelistsDelete", "WebinarPanelistDelete", "WebinarPolls", "WebinarPollCreate", "WebinarPollGet", "WebinarPollUpdate", "WebinarPollDelete", "WebinarRegistrants", "WebinarRegistrantCreate", "WebinarRegistrantsQuestionsGet", "WebinarRegistrantQuestionUpdate", "WebinarRegistrantStatus", "WebinarRegistrantGet", "DeleteWebinarRegistrant", "GetWebinarSipDialingWithPasscode", "WebinarStatus", "WebinarSurveyGet", "WebinarSurveyDelete", "WebinarSurveyUpdate", "WebinarToken", "GetTrackingSources"];

ZOOM_MEETINGS_API_OPENAPI_VERSION¶

const ZOOM_MEETINGS_API_OPENAPI_VERSION: "3.0.0" = "3.0.0";

ZOOM_MEETINGS_API_OPERATION_BY_ID¶

const ZOOM_MEETINGS_API_OPERATION_BY_ID: Map<string, ZoomMeetingsApiOperation>;

ZOOM_MEETINGS_API_OPERATION_BY_UID¶

const ZOOM_MEETINGS_API_OPERATION_BY_UID: Map<string, ZoomMeetingsApiOperation>;

ZOOM_MEETINGS_API_OPERATION_COUNT¶

const ZOOM_MEETINGS_API_OPERATION_COUNT: 184 = 184;

ZOOM_MEETINGS_API_OPERATIONS¶

const ZOOM_MEETINGS_API_OPERATIONS: readonly ZoomMeetingsApiOperation[];

ZOOM_MEETINGS_API_PATH_COUNT¶

const ZOOM_MEETINGS_API_PATH_COUNT: 129 = 129;

ZOOM_MEETINGS_API_SPEC_SOURCE¶

const ZOOM_MEETINGS_API_SPEC_SOURCE: "https://developers.zoom.us/api-hub/meetings/methods/endpoints.json" = "https://developers.zoom.us/api-hub/meetings/methods/endpoints.json";

ZOOM_MEETINGS_API_SPEC_VERSION¶

const ZOOM_MEETINGS_API_SPEC_VERSION: "2" = "2";

ZOOM_RIVET_MEETINGS_REST_EXCEPTION_OPERATION_UIDS¶

const ZOOM_RIVET_MEETINGS_REST_EXCEPTION_OPERATION_UIDS: readonly ["GET /report/disclaimer", "GET /report/remote_support"];

ZOOM_RIVET_MEETINGS_SDK_OPERATION_COUNT¶

const ZOOM_RIVET_MEETINGS_SDK_OPERATION_COUNT: number;

ZOOM_RIVET_SDK_PACKAGE_NAME¶

const ZOOM_RIVET_SDK_PACKAGE_NAME: "@zoom/rivet" = "@zoom/rivet";

zoomVideoIntegration¶

const zoomVideoIntegration: DefinedIntegration<{
  capabilities: {
     audiences?: ("customer-facing" | "internal-support" | "mixed")[];
     capability: string;
     changesWorkflow?: boolean;
     description?: string;
     exposesSensitiveData?: boolean;
     extension?: boolean;
     label?: string;
     metadata?: Record<string, unknown>;
     providerObjects?: {
        description?: string;
        kind: string;
        label?: string;
        metadata?: Record<string, unknown>;
        schemaName?: string;
     }[];
     requiresCredential?: boolean;
     sideEffect?: boolean;
  }[];
  category: string;
  channelAudiences: ("customer-facing" | "internal-support" | "mixed")[];
  coverage: {
     evidence: {
        label: string;
        url?: string;
     }[];
     notes: string[];
     scope:   | "provider-api-subset"
        | "support-workflow-subset"
        | "connector-required"
        | "local-protocol"
        | "full-provider-api";
  };
  credentialRequirements: {
     description?: string;
     id: string;
     label?: string;
     metadata?: Record<string, unknown>;
     required: boolean;
     scopes: string[];
  }[];
  directions: (
     | "inbound-only"
     | "outbound-only"
     | "bidirectional"
     | "receive-only"
    | "send-only")[];
  id: string;
  limitations: string[];
  maintainers: {
     name: string;
     type: "unknown" | "official" | "community" | "partner";
     url?: string;
  }[];
  metadata?: Record<string, unknown>;
  name: string;
  operations: {
     alias: string;
     audience?: "customer-facing" | "internal-support" | "mixed";
     audiences?: ("customer-facing" | "internal-support" | "mixed")[];
     capability: string;
     changesWorkflow?: boolean;
     description?: string;
     exposesSensitiveData?: boolean;
     extension: boolean;
     externallyVisible?: boolean;
     inputSchema?: unknown;
     inputSchemaName?: string;
     inputSchemaRef?: string;
     label?: string;
     metadata?: Record<string, unknown>;
     outputSchema?: unknown;
     outputSchemaName?: string;
     outputSchemaRef?: string;
     providerObject?: string;
     providerObjects?: {
        description?: string;
        kind: string;
        label?: string;
        metadata?: Record<string, unknown>;
        schemaName?: string;
     }[];
     providerOperation?: string;
     requiredPolicyIds?: string[];
     requiresApproval?: boolean;
     requiresCredential?: boolean;
     sideEffect?: boolean;
  }[];
  packageName: string;
  privacyNotes: string[];
  provider: string;
  trustLevel: "official" | "community" | "verified" | "experimental";
} & {
  capabilities: readonly [{
     audiences: readonly ["customer-facing", "internal-support", "mixed"];
     capability: "schedule";
     changesWorkflow: true;
     description: "Creates Zoom meetings through SDK-user-selected scheduling or escalation workflows.";
     exposesSensitiveData: true;
     label: "Schedule Zoom meetings";
     providerObjects: readonly [{
        kind: "zoomMeeting";
        label: "Zoom Meeting";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["customer-facing", "internal-support", "mixed"];
     capability: "create-provider-object";
     changesWorkflow: true;
     description: "Creates Zoom meeting resources with SDK-user-supplied topic, timing, recurrence, and settings.";
     exposesSensitiveData: true;
     label: "Create Zoom meetings";
     providerObjects: readonly [{
        kind: "zoomMeeting";
        label: "Zoom Meeting";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["customer-facing", "internal-support", "mixed"];
     capability: "read-provider-object";
     description: "Lists Zoom meetings and reads meeting details by meeting ID.";
     exposesSensitiveData: true;
     label: "Read Zoom meetings";
     providerObjects: readonly [{
        kind: "zoomMeeting";
        label: "Zoom Meeting";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["internal-support", "mixed"];
     capability: "delete-provider-object";
     changesWorkflow: true;
     description: "Deletes Zoom meetings when SDK-user lifecycle or retention policy permits deletion.";
     exposesSensitiveData: true;
     label: "Delete Zoom meetings";
     providerObjects: readonly [{
        kind: "zoomMeeting";
        label: "Zoom Meeting";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["internal-support", "mixed"];
     capability: "update-provider-object";
     changesWorkflow: true;
     description: "Updates Zoom meeting fields, recurrence, tracking fields, or settings when SDK-user policy permits mutation.";
     exposesSensitiveData: true;
     label: "Update Zoom meetings";
     providerObjects: readonly [{
        kind: "zoomMeeting";
        label: "Zoom Meeting";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     audiences: readonly ["customer-facing", "internal-support", "mixed"];
     capability: "receive";
     description: "Validates and parses Zoom webhook payloads for SDK-user-owned meeting lifecycle workflows.";
     exposesSensitiveData: true;
     label: "Receive Zoom webhooks";
     providerObjects: readonly [{
        kind: "zoomWebhookEvent";
        label: "Zoom Webhook Event";
      }, {
        kind: "zoomMeeting";
        label: "Zoom Meeting";
     }];
     requiresCredential: true;
   }, {
     audiences: readonly ["internal-support"];
     capability: "zoom.request-signature";
     description: "Validates Zoom x-zm-signature and x-zm-request-timestamp values and supports endpoint URL validation challenges.";
     exposesSensitiveData: true;
     extension: true;
     label: "Validate Zoom webhook signatures";
     providerObjects: readonly [{
        kind: "zoomSignedRequest";
        label: "Zoom Signed Request";
     }];
     requiresCredential: true;
  }];
  category: "video";
  channelAudiences: readonly ["customer-facing", "internal-support", "mixed"];
  coverage: {
     evidence: readonly [{
        label: "Zoom Rivet for JavaScript";
        url: "https://developers.zoom.us/docs/rivet/javascript/";
      }, {
        label: "Zoom Rivet JavaScript repository";
        url: "https://github.com/zoom/rivet-javascript";
      }, {
        label: "Zoom Meetings API Hub OpenAPI";
        url: "https://developers.zoom.us/api-hub/meetings/methods/endpoints.json";
      }, {
        label: "Zoom Meetings API reference";
        url: "https://developers.zoom.us/docs/api/meetings/";
      }, {
        label: "Zoom webhooks reference";
        url: "https://developers.zoom.us/docs/api/rest/webhook-reference/";
      }, {
        label: "Zoom webhook validation";
        url: "https://developers.zoom.us/docs/api/rest/webhook-reference/#validate-your-webhook-endpoint";
     }];
     notes: readonly ["Coverage includes generated per-operation functions for every operation in Zoom's official Meetings API Hub OpenAPI spec. Runtime uses Zoom's official @zoom/rivet Meetings SDK for mapped SDK operations when accessToken/getAccessToken/account OAuth credentials are provided.", "Typed convenience helpers remain available for meetings create/list/read/update/delete through @zoom/rivet, current-user readiness through @zoom/rivet/users, webhook URL-validation handling, and x-zm-signature verification; providerClient remains available as a host override.", "The built-in typed REST adapter remains only for explicit REST exceptions: @zoom/rivet 0.4.0 does not expose GET /report/disclaimer or GET /report/remote_support, and low-level fetch/signal/retry/oauthBaseUrl options intentionally request the package-owned REST transport.", "This package is a generated Zoom Meetings API domain slice, not full Zoom platform coverage. Zoom Phone, Contact Center, Team Chat, Rooms, Marketplace app management outside the Meetings API Hub, account administration beyond this spec, and full webhook/event catalogs remain separate Zoom surfaces.", "The SDK user owns OAuth scopes, host delegation, account plan/admin settings, meeting lifecycle policy, recording/transcript consent, retention, deletion, and participant disclosure decisions."];
     scope: "provider-api-subset";
  };
  credentialRequirements: readonly [{
     description: "Optional host-managed Zoom provider client backed by an approved SDK, provider package, or host-owned transport when overriding the built-in @zoom/rivet runtime.";
     id: "zoom-video-provider-client";
     label: "Optional Zoom video provider client override";
     metadata: {
        credentialOwnership: "sdk-user-or-host-managed";
        defaultClientPolicy: "official-rivet-sdk-with-reviewed-rest-exceptions";
        injectionInterface: "ZoomVideoProviderClient";
     };
     required: false;
   }, {
     description: "Server-side OAuth access token used by @zoom/rivet, the reviewed REST exceptions, or a host provider client for meeting and user endpoints.";
     id: "zoom-oauth-access-token";
     label: "Zoom OAuth access token";
     metadata: {
        credentialOwnership: "sdk-user-or-host-managed";
        scopeKind: "provider-oauth-scopes";
     };
     required: true;
     scopes: readonly ["meeting:write", "meeting:read", "user:read", "meeting:write:meeting", "meeting:read:list_meetings", "meeting:read:meeting", "meeting:update:meeting", "meeting:delete:meeting", "user:read:user"];
   }, {
     description: "Server-side secret token used to validate Zoom webhook request signatures.";
     id: "zoom-webhook-secret-token";
     label: "Zoom webhook secret token";
     required: false;
  }];
  directions: readonly ["inbound-only", "outbound-only", "bidirectional"];
  id: "video.zoom";
  limitations: readonly ["Runtime provider API calls use Zoom's official @zoom/rivet SDK when OAuth credentials are supplied, except for documented REST exceptions or explicit low-level REST transport options.", "Missing OAuth credentials and missing providerClient fail closed; SDK users own token lifecycle, retry policy, and account authorization policy.", "Available meeting operations depend on the SDK user's Zoom OAuth scopes, account plan, account-level settings, admin policy, and delegated host permissions.", "This package does not choose whether a video workflow is inbound, outbound, customer-facing, internal, recorded, retained, or escalated; those decisions remain SDK-user configuration.", "Live meeting media transport, captions, cloud recording retrieval, and telephony dial-out are outside this package's delegated SDK/provider-client and webhook foundation."];
  maintainers: readonly [{
     name: "Cognidesk";
     type: "official";
  }];
  metadata: {
     channelCoverage: {
        currentUser: "typed-read";
        meetings: "typed-create-list-read-update-delete";
        meetingsApiHub: "generated-constrained-support-slice";
        meetingsRecordingsRegistrantsReportsDevicesTspWebinars: "generated-full-surface-where-present-in-meetings-api-hub";
        webhooks: "typed-validate-parse";
        webhookUrlValidation: "typed-response";
        zoomPhoneContactCenterTeamChatRoomsCalendar: "provider-supported-not-typed-separate-surface";
     };
     generatedProviderSliceVerification: {
        allowlist: readonly ["Archiving", "Cloud Recording", "Devices", "H323 Devices", "In-Meeting Apps", "In-Meeting Features", "Invitation & Registration", "Live streaming", "Meetings", "PAC", "Polls", "Reports", "SIP Phone", "Summaries", "Surveys", "Templates", "Tracking Field", "TSP", "Webinars"];
        apiVersion: "2";
        coverageArtifact: "docs/provider-coverage/zoom-meetings-api-2026-06-18.operations.json";
        documentedOperationCount: 184;
        documentedPathCount: 129;
        functionCatalogArtifact: "docs/provider-coverage/zoom-meetings-api-2026-06-18.functions.json";
        functionCatalogChecksumSha256: "8934aa5f43e3a15d5a087dcf663854d41bb013d38aee8d65171b967bcc43202b";
        generatedFunctionCount: 184;
        implementedOperationCount: 184;
        operationCatalogArtifact: "docs/provider-coverage/zoom-meetings-api-2026-06-18.operations.json";
        operationCatalogChecksumSha256: "d32cdc0636126fef0491cfd13f95219359be167d339a57b4b4322f7be1146392";
        provider: "zoom-meetings-api-hub";
        sourceChecksumSha256: "07acb50f2a3f070b161ed57fbd9ca9ae83db42a6c1fa538f36b7e1c8300b6b06";
        unimplementedOperationCount: 0;
        verifiedAt: "2026-06-21";
     };
     implementation: {
        defaultClient: "official-zoom-rivet-sdk";
        failClosedWithoutOAuthCredentials: true;
        failClosedWithoutProviderClientOrOAuthCredentials: true;
        generatedMeetingsApiRuntime: "zoom-rivet-operation-dispatch-with-reviewed-rest-exception-fallback-and-host-provider-client-override";
        manifestImport: "no-client-initialization";
        officialSdk: {
           checkedVersion: "0.4.0";
           mappedMeetingsOperationCount: 182;
           meetingsModule: "@zoom/rivet/meetings";
           packageName: "@zoom/rivet";
           usersModule: "@zoom/rivet/users";
        };
        providerClientInterface: "ZoomVideoProviderClient";
        restAdapterException: {
           adapterKind: "reviewed-rest-exception";
           operationUids: readonly ["GET /report/disclaimer", "GET /report/remote_support"];
           transportOptions: readonly ["fetch", "signal", "retry", "oauthBaseUrl"];
        };
        strategy: "official-sdk-with-reviewed-rest-exceptions";
     };
     implementationStrategy: "official-sdk-with-reviewed-rest-exceptions";
     providerClient: {
        defaultClient: "official-zoom-rivet-sdk";
        importPolicy: "optional-host-override";
        injectionPolicy: "optional-runtime-override";
        interface: "ZoomVideoProviderClient";
     };
     providerRestAdapterException: {
        adapterKind: "reviewed-rest-exception";
        allowedDefaultRuntime: "official-zoom-rivet-sdk";
        failClosed: true;
        fallbackRuntime: "built-in-typed-rest-adapter";
        guardrails: readonly ["Keep generated operation IDs resolved against the local Zoom Meetings API catalog before SDK dispatch or REST fallback.", "Use @zoom/rivet for mapped operations whenever fetch/signal/retry/oauthBaseUrl are not explicitly requested.", "Only use the REST adapter for documented @zoom/rivet gaps, per-request headers, or transport options the SDK cannot represent."];
        hostSdkPath: "ZoomVideoProviderClient";
        operationUids: readonly ["GET /report/disclaimer", "GET /report/remote_support"];
        reason: "@zoom/rivet 0.4.0 covers 182 of this package's 184 generated Zoom Meetings API operations; the package-owned typed REST adapter is retained for the two missing report endpoints and explicit low-level transport options the SDK cannot honor.";
        reviewedAt: "2026-06-25";
        status: "accepted";
     };
     sdkViability: {
        checkedAt: "2026-06-25";
        decision: "official-provider-sdk-selected";
        rejectedSdkPackages: readonly [{
           packageName: "@zoom/meetingsdk";
           reason: "Official browser Meeting SDK for embedding/joining meetings, not a server REST API client.";
         }, {
           packageName: "@zoom/videosdk";
           reason: "Official browser Video SDK for custom video experiences, not the Zoom Meetings REST API.";
         }, {
           packageName: "@zoom/rtms";
           reason: "Official Node real-time media streams SDK, not scheduling/resource REST management.";
        }];
        selectedSdkPackage: {
           checkedVersion: "0.4.0";
           packageName: "@zoom/rivet";
           reason: "Official Zoom Node.js toolkit with Meetings API wrappers, server-to-server OAuth support, and webhook/event tooling.";
           source: "https://developers.zoom.us/docs/rivet/javascript/";
        };
     };
  };
  name: "Zoom Meetings";
  operations: readonly [{
     alias: "video.meeting.create";
     capability: "create-provider-object";
     changesWorkflow: true;
     exposesSensitiveData: true;
     providerObject: "zoomMeeting";
     sideEffect: true;
   }, {
     alias: "video.meeting.list";
     capability: "read-provider-object";
     exposesSensitiveData: true;
     providerObject: "zoomMeeting";
   }, {
     alias: "video.meeting.read";
     capability: "read-provider-object";
     exposesSensitiveData: true;
     providerObject: "zoomMeeting";
   }, {
     alias: "video.meeting.update";
     capability: "update-provider-object";
     changesWorkflow: true;
     exposesSensitiveData: true;
     providerObject: "zoomMeeting";
     sideEffect: true;
   }, {
     alias: "video.meeting.delete";
     capability: "delete-provider-object";
     changesWorkflow: true;
     exposesSensitiveData: true;
     providerObject: "zoomMeeting";
     sideEffect: true;
   }, {
     alias: "video.user.current.read";
     capability: "read-provider-object";
     exposesSensitiveData: true;
     providerObject: "zoomUser";
   }, {
     alias: "zoom.meetings.request";
     capability: "read-provider-object";
     extension: true;
     metadata: {
        execution: "official-rivet-sdk-or-reviewed-rest-exception-or-host-provider-client";
        supportSliceEscapeHatch: true;
     };
     providerObject: "zoomMeetingsApiOperation";
   }, {
     alias: "zoom.webhook.parse";
     capability: "receive";
     exposesSensitiveData: true;
     extension: true;
     providerObject: "zoomWebhookEvent";
  }];
  packageName: "@cognidesk/integration-video-zoom";
  privacyNotes: readonly ["Zoom meetings and webhooks can contain participant identifiers, host details, invite links, meeting metadata, chat-capable workflow context, and recording-related event metadata.", "Zoom OAuth access tokens and webhook secret tokens stay server-side and are represented in Studio only as credential readiness.", "User consent, meeting disclosure, recording enablement, transcript use, retention, and deletion are owned by the SDK user's Zoom account configuration and application policy."];
  provider: "zoom";
  trustLevel: "official";
}, ZoomVideoIntegrationContext, {
  video.meeting.create: (input, context) => Promise<ZoomMeetingResource>;
  video.meeting.delete: (input, context) => Promise<Record<string, never>>;
  video.meeting.list: (input, context) => Promise<ZoomListMeetingsResponse>;
  video.meeting.read: (input, context) => Promise<ZoomMeetingResource>;
  video.meeting.update: (input, context) => Promise<ZoomMeetingResource>;
  video.user.current.read: (_input, context) => Promise<ZoomUserResource>;
  zoom.meetings.request: <OperationKey>(input, context) => Promise<ZoomMeetingsApiOperationResponseMap[OperationKey]>;
  zoom.webhook.parse: (input) => Promise<ZoomSignedWebhookRequest>;
}>;

zoomVideoOperationHandlers¶

const zoomVideoOperationHandlers: {
  video.meeting.create: (input, context) => Promise<ZoomMeetingResource>;
  video.meeting.delete: (input, context) => Promise<Record<string, never>>;
  video.meeting.list: (input, context) => Promise<ZoomListMeetingsResponse>;
  video.meeting.read: (input, context) => Promise<ZoomMeetingResource>;
  video.meeting.update: (input, context) => Promise<ZoomMeetingResource>;
  video.user.current.read: (_input, context) => Promise<ZoomUserResource>;
  zoom.meetings.request: <OperationKey>(input, context) => Promise<ZoomMeetingsApiOperationResponseMap[OperationKey]>;
  zoom.webhook.parse: (input) => Promise<ZoomSignedWebhookRequest>;
};

Type Declaration¶

Name	Type
`video.meeting.create()`	(`input`, `context`) => `Promise`\<`ZoomMeetingResource`>
`video.meeting.delete()`	(`input`, `context`) => `Promise`\<`Record`\<`string`, `never`>>
`video.meeting.list()`	(`input`, `context`) => `Promise`\<`ZoomListMeetingsResponse`>
`video.meeting.read()`	(`input`, `context`) => `Promise`\<`ZoomMeetingResource`>
`video.meeting.update()`	(`input`, `context`) => `Promise`\<`ZoomMeetingResource`>
`video.user.current.read()`	(`_input`, `context`) => `Promise`\<`ZoomUserResource`>
`zoom.meetings.request()`	\<`OperationKey`>(`input`, `context`) => `Promise`\<`ZoomMeetingsApiOperationResponseMap`[`OperationKey`]>
`zoom.webhook.parse()`	(`input`) => `Promise`\<`ZoomSignedWebhookRequest`>

Functions¶

createMissingZoomVideoProviderClient()¶

function createMissingZoomVideoProviderClient(): ZoomVideoProviderClient;

Returns¶

ZoomVideoProviderClient

createZoomMeetingsApiGeneratedClient()¶

function createZoomMeetingsApiGeneratedClient(callOperation): ZoomMeetingsApiGeneratedClient;

Parameters¶

Parameter	Type
`callOperation`	`ZoomMeetingsGeneratedOperationCaller`

Returns¶

ZoomMeetingsApiGeneratedClient

createZoomOfficialSdkVideoProviderClient()¶

function createZoomOfficialSdkVideoProviderClient(options?): ZoomVideoProviderClient;

Parameters¶

Parameter	Type
`options?`	`Omit`\<`ZoomVideoClientOptions`, `"providerClient"`>

Returns¶

ZoomVideoProviderClient

createZoomRestVideoProviderClient()¶

function createZoomRestVideoProviderClient(options?): ZoomVideoProviderClient;

Parameters¶

Parameter	Type
`options?`	`Omit`\<`ZoomVideoClientOptions`, `"providerClient"`>

Returns¶

ZoomVideoProviderClient

createZoomServerOAuthAccessToken()¶

function createZoomServerOAuthAccessToken(options): Promise<string>;

Parameters¶

Parameter	Type
`options`	`ZoomServerOAuthTokenOptions`

Returns¶

Promise\<string>

createZoomVideoClient()¶

function createZoomVideoClient(options?): ZoomVideoClient;

Parameters¶

Parameter	Type
`options?`	`ZoomVideoClientOptions`

Returns¶

ZoomVideoClient

createZoomVideoLiveChecks()¶

function createZoomVideoLiveChecks(options?): {
  description: string;
  id: string;
  requiredCredentialIds: string[];
  run: Promise<{
     details: {
        accountId: string;
        email: string;
        status: string;
        userId: string;
     };
  }>;
}[];

Parameters¶

Parameter	Type
`options?`	`ZoomLiveCheckOptions`

Returns¶

{ description: string; id: string; requiredCredentialIds: string[]; run: Promise\<{ details: { accountId: string; email: string; status: string; userId: string; }; }>; }[]

createZoomWebhookValidationResponse()¶

function createZoomWebhookValidationResponse(input): ZoomWebhookValidationResponse;

Parameters¶

Parameter	Type
`input`	`ZoomWebhookValidationInput`

Returns¶

ZoomWebhookValidationResponse

parseZoomWebhookRequest()¶

function parseZoomWebhookRequest(request, options?): Promise<ZoomSignedWebhookRequest>;

Parameters¶

Parameter	Type
`request`	`Request`
`options?`	`ParseZoomWebhookRequestOptions`

Returns¶

Promise\<ZoomSignedWebhookRequest>

validateZoomWebhookSignature()¶

function validateZoomWebhookSignature(input): boolean;

Parameters¶

Parameter	Type
`input`	`ValidateZoomWebhookSignatureInput`

Returns¶

boolean

zoomVideoCredentialStatuses()¶

function zoomVideoCredentialStatuses(input): {
  expiresAt?: string;
  message?: string;
  providerPackageId?: string;
  requirementId: string;
  scopes?: string[];
  state:   | "required"
     | "configured"
     | "permission-blocked"
     | "not-required"
     | "missing"
     | "expired"
     | "insufficient-scope"
     | "unavailable";
}[];

Parameters¶

Parameter	Type
`input`	`ZoomCredentialStatusInput`

Returns¶

{ expiresAt?: string; message?: string; providerPackageId?: string; requirementId: string; scopes?: string[]; state: | "required" | "configured" | "permission-blocked" | "not-required" | "missing" | "expired" | "insufficient-scope" | "unavailable"; }[]