Interface CreateRequest

interface CreateRequest {
    accessControl: WebcastAccessControl;
    attendeeJoinMethod?: LiteralString<"Anonymous" | "Registration">;
    autoAssociateVod?: boolean;
    automatedWebcast?: boolean;
    autoplay?: boolean;
    bannerDetails?: { banners: WebcastBanner.Request[]; isEnabled: boolean };
    categories?: string[];
    chatEnabled?: boolean;
    closedCaptionsEnabled?: boolean;
    consentVerbiage?: string;
    customFields?: Admin.CustomField.Request[];
    description?: string;
    disableAutoRecording?: boolean;
    emailToPreRegistrants?: boolean;
    embeddedContent?: {
        contentLinks: (Webcast.ContentLink | Webcast.ContentLink.Request)[];
        isEnabled: boolean;
    };
    endDate: string
    | Date;
    estimatedAttendees?: number;
    eventAdminIds: string[];
    externalPresenters?: { email: string; name: string; title: string }[];
    groupIds?: string[];
    hideShareUrl?: boolean;
    isCustomConsentEnabled?: boolean;
    isSecureRtmp?: boolean;
    linkedVideoId?: string;
    liveSubtitles?: { sourceLanguage: string; translationLanguages: string[] };
    lobbyTimeMinutes?: number;
    moderatorIds?: string[];
    password?: string;
    pollsEnabled?: boolean;
    preProduction?: {
        duration?: string;
        groupIds?: string[];
        userIds?: string[];
    };
    presentationFileDownloadAllowed?: boolean;
    presentationProfileId?: string;
    presenterId?: string;
    presenterIds?: string[];
    questionAndAnswerEnabled?: boolean;
    questionOption?: string;
    reactionsSettings?: ReactionsSettings;
    recordingUploaderUserEmail?: string;
    recordingUploaderUserId?: string;
    redirectVod?: boolean;
    regenerateRtmpUrlAndKey?: boolean;
    registrationFieldIds?: string[];
    shortcutName?: string;
    startDate: string
    | Date;
    tags?: string[];
    title: string;
    unlisted?: boolean;
    userIds?: string[];
    vcMicrosoftTeamsMeetingUrl?: string;
    vcSipAddress?: string;
    videoSourceType?: VideoSourceType;
    viewerIdEnabled?: boolean;
    vodId?: string;
    webcastType?: LiteralString<"WebexEvents" | "Rev">;
    webexTeam?: { name?: string; roomId: string };
    zoom?: { meetingId: string; meetingPassword?: string };
}

Properties

accessControl attendeeJoinMethod? autoAssociateVod? automatedWebcast? autoplay? bannerDetails? categories? chatEnabled? closedCaptionsEnabled? consentVerbiage? customFields? description? disableAutoRecording? emailToPreRegistrants? embeddedContent? endDate estimatedAttendees? eventAdminIds externalPresenters? groupIds? hideShareUrl? isCustomConsentEnabled? isSecureRtmp? linkedVideoId? liveSubtitles? lobbyTimeMinutes? moderatorIds? password? pollsEnabled? preProduction? presentationFileDownloadAllowed? presentationProfileId? presenterId? presenterIds? questionAndAnswerEnabled? questionOption? reactionsSettings? recordingUploaderUserEmail? recordingUploaderUserId? redirectVod? regenerateRtmpUrlAndKey? registrationFieldIds? shortcutName? startDate tags? title unlisted? userIds? vcMicrosoftTeamsMeetingUrl? vcSipAddress? videoSourceType? viewerIdEnabled? vodId? webcastType? webexTeam? zoom?

Properties

accessControl

accessControl: WebcastAccessControl

OptionalattendeeJoinMethod

attendeeJoinMethod?: LiteralString<"Anonymous" | "Registration">

Attendee join method. Only required when 'accesscontrol' is Public. Default is 'Registration'. When set to 'Anonymous', no attendee specific details are collected or registered.

OptionalautoAssociateVod

autoAssociateVod?: boolean

OptionalautomatedWebcast

automatedWebcast?: boolean

Optionalautoplay

autoplay?: boolean

OptionalbannerDetails

bannerDetails?: { banners: WebcastBanner.Request[]; isEnabled: boolean }

Type declaration

Optionalcategories

categories?: string[]

OptionalchatEnabled

chatEnabled?: boolean

OptionalclosedCaptionsEnabled

closedCaptionsEnabled?: boolean

OptionalconsentVerbiage

consentVerbiage?: string

If isCustomConsentEnabled is true then you can customize the consent verbiage for public attendees.

OptionalcustomFields

customFields?: Admin.CustomField.Request[]

Optionaldescription

description?: string

OptionaldisableAutoRecording

disableAutoRecording?: boolean

OptionalemailToPreRegistrants

emailToPreRegistrants?: boolean

OptionalembeddedContent

embeddedContent?: {
    contentLinks: (Webcast.ContentLink | Webcast.ContentLink.Request)[];
    isEnabled: boolean;
}

endDate

endDate: string | Date

OptionalestimatedAttendees

estimatedAttendees?: number

eventAdminIds

eventAdminIds: string[]

OptionalexternalPresenters

externalPresenters?: { email: string; name: string; title: string }[]

Only required when 'Producer' selected as a videoSourceType.

OptionalgroupIds

groupIds?: string[]

OptionalhideShareUrl

hideShareUrl?: boolean

OptionalisCustomConsentEnabled

isCustomConsentEnabled?: boolean

Default=false. If accessControl is set to Public and 'EDIT PUBLIC REG. PAGE CONSENT VERBIAGE' is enabled on the account. When true, you can customize the consent verbiage for public attendees.

OptionalisSecureRtmp

isSecureRtmp?: boolean

OptionallinkedVideoId

linkedVideoId?: string

OptionalliveSubtitles

liveSubtitles?: { sourceLanguage: string; translationLanguages: string[] }

OptionallobbyTimeMinutes

lobbyTimeMinutes?: number

OptionalmoderatorIds

moderatorIds?: string[]

Optionalpassword

password?: string

OptionalpollsEnabled

pollsEnabled?: boolean

OptionalpreProduction

preProduction?: { duration?: string; groupIds?: string[]; userIds?: string[] }

OptionalpresentationFileDownloadAllowed

presentationFileDownloadAllowed?: boolean

OptionalpresentationProfileId

presentationProfileId?: string

OptionalpresenterId

presenterId?: string

Internal user Id. Only required when 'WebrtcSinglePresenter' selected as a videoSourceType

OptionalpresenterIds

presenterIds?: string[]

Internal user Ids. Only required when 'Producer' selected as a videoSourceType.

OptionalquestionAndAnswerEnabled

questionAndAnswerEnabled?: boolean

OptionalquestionOption

questionOption?: string

OptionalreactionsSettings

reactionsSettings?: ReactionsSettings

OptionalrecordingUploaderUserEmail

recordingUploaderUserEmail?: string

OptionalrecordingUploaderUserId

recordingUploaderUserId?: string

OptionalredirectVod

redirectVod?: boolean

OptionalregenerateRtmpUrlAndKey

regenerateRtmpUrlAndKey?: boolean

only valid for edit request - Specifies if the exiting RTMP based webcast URL and Key needs to be regenerated

OptionalregistrationFieldIds

registrationFieldIds?: string[]

OptionalshortcutName

shortcutName?: string

startDate

startDate: string | Date

Optionaltags

tags?: string[]

title

title: string

Optionalunlisted

unlisted?: boolean

OptionaluserIds

userIds?: string[]

OptionalvcMicrosoftTeamsMeetingUrl

vcMicrosoftTeamsMeetingUrl?: string

If this is an MS Teams event then the URL to the MS Teams meeting.

OptionalvcSipAddress

vcSipAddress?: string

OptionalvideoSourceType

videoSourceType?: VideoSourceType

This field is required to create/edit WebexLiveStream event.

OptionalviewerIdEnabled

viewerIdEnabled?: boolean

OptionalvodId

vodId?: string

OptionalwebcastType

webcastType?: LiteralString<"WebexEvents" | "Rev">

OptionalwebexTeam

webexTeam?: { name?: string; roomId: string }

Optionalzoom

zoom?: { meetingId: string; meetingPassword?: string }

Settings

Member Visibility

On This Page

Properties