Create a webinar

POST

/users/{userId}/webinars

Zoom users with a Webinar Plan have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.
Use this API to schedule a Webinar for a user (host).

Scopes: webinar:write:admin webinar:write

Rate Limit Label: Light
Prerequisites:

Pro or higher plan with a Webinar Add-on.

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://api.zoom.us/v2/users//webinars'

响应示例

201 - response

{
    "agenda": "string",
    "created_at": "string [date-time]",
    "duration": "integer",
    "host_id": "string",
    "id": "integer",
    "join_url": "string",
    "occurrences": [
        {
            "duration": "integer",
            "occurrence_id": "integer",
            "start_time": "string [date-time]",
            "status": "string"
        }
    ],
    "settings": {
        "allow_multiple_devices": "boolean",
        "alternative_hosts": "string",
        "approval_type": "integer",
        "attendees_and_panelists_reminder_email_notification": {
            "enable": "boolean",
            "type": "integer"
        },
        "audio": "string",
        "auto_recording": "string",
        "close_registration": "boolean",
        "email_language": "string",
        "enforce_login": "boolean",
        "enforce_login_domains": "string",
        "follow_up_absentees_email_notification": {
            "enable": "boolean",
            "type": "integer"
        },
        "follow_up_attendees_email_notification": {
            "enable": "boolean",
            "type": "integer"
        },
        "hd_video": "boolean",
        "host_video": "boolean",
        "panelists_invitation_email_notification": "boolean",
        "panelists_video": "boolean",
        "practice_session": "boolean",
        "registrants_confirmation_email": "boolean",
        "registrants_email_notification": "boolean",
        "registration_type": "integer",
        "show_share_button": "boolean"
    },
    "start_time": "string [date-time]",
    "start_url": "string",
    "timezone": "string",
    "topic": "string",
    "type": "integer",
    "uuid": "string"
}

请求参数

Path 参数

userId

string

必需

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

Body 参数multipart/form-data

object {0}

返回响应

🟢201**HTTP Status Code:** `201` Webinar created.

application/json

Body

Webinar object.

host_email

string <email>

可选

Email address of the meeting host.

host_id

string

可选

ID of the user set as host of the webinar.

integer <int64>

可选

Webinar ID in "long" format(represented as int64 data type in JSON), also known as the webinar number.

registrants_confirmation_email

boolean

可选

Specify whether or not registrants of this Webinar should receieve confirmation emails.

template_id

string

可选

Unique identifier of the Webinar template. Use this field only if you would like to schedule the webinar using an existing template. The value of this field can be retrieved from List Webinar Templates API.
You must provide the user ID of the host instead of the email address in the userId path parameter in order to use a template for scheduling a Webinar.

uuid

string

可选

Unique identifier of a Webinar. Each Webinar instance will generate its own UUID(i.e., after a Webinar ends, a new UUID will be generated for the next instance of the Webinar). Once a Webinar ends, the value of uuid for the same webinar will be different from when it was scheduled.

agenda

string

可选

Webinar agenda.

created_at

string <date-time>

可选

Create time.

duration

integer

可选

Webinar duration.

join_url

string

可选

URL to join the Webinar. This URL should only be shared with the users who should be invited to the Webinar.

occurrences

array [object {4}]

可选

Array of occurrence objects.

duration

integer

Duration.

可选

occurrence_id

string

可选

Occurrence ID: Unique Identifier that identifies an occurrence of a recurring webinar. Recurring webinars can have a maximum of 50 occurrences.

start_time

string <date-time>

可选

Start time.

status

string

可选

Occurrence status.

password

string

可选

Webinar passcode.

If "Require a passcode when scheduling new meetings" setting has been enabled and locked for the user, the passcode field will be autogenerated for the Webinar in the response even if it is not provided in the API request.

Note: If the account owner or the admin has configured minimum passcode requirement settings, the passcode value provided here must meet those requirements.

If the requirements are enabled, you can view those requirements by calling either the Get User Settings API or the Get Account Settings API.

<= 10 字符

recurrence

object

Recurrence Webinar

可选

Recurrence object. Use this object only for a webinar of type 9 i.e., a recurring webinar with fixed time.

end_date_time

string <date-time>

可选

Select a date when the webinar will recur before it is canceled. Should be in UTC time, such as 2017-11-25T12:00:00Z. (Cannot be used with "end_times".)

end_times

integer

可选

Select how many times the webinar will recur before it is canceled. (Cannot be used with "end_date_time".)

<= 365

默认值:

monthly_day

integer

可选

Use this field only if you're scheduling a recurring webinar of type 3 to state which day in a month, the webinar should recur. The value range is from 1 to 31.

For instance, if you would like the webinar to recur on 23rd of each month, provide 23 as the value of this field and 1 as the value of the repeat_interval field. Instead, if you would like the webinar to recur once every three months, on 23rd of the month, change the value of the repeat_interval field to 3.

monthly_week

enum<integer>

可选

Use this field only if you're scheduling a recurring webinar of type 3 to state the week of the month when the webinar should recur. If you use this field, you must also use the monthly_week_day field to state the day of the week when the webinar should recur.
-1 - Last week of the month.
1 - First week of the month.
2 - Second week of the month.
3 - Third week of the month.
4 - Fourth week of the month.

枚举值:

-11234

monthly_week_day

enum<integer>

可选

Use this field only if you're scheduling a recurring webinar of type 3 to state a specific day in a week when the monthly webinar should recur. To use this field, you must also use the monthly_week field.
1 - Sunday.
2 - Monday.
3 - Tuesday.
4 - Wednesday.
5 - Thursday.
6 - Friday.
7 - Saturday.

枚举值:

1234567

repeat_interval

integer

可选

Define the interval at which the webinar should recur. For instance, if you would like to schedule a Webinar that recurs every two months, you must set the value of this field as 2 and the value of the type parameter as 3.

For a daily webinar, the maximum interval you can set is 90 days. For a weekly webinar, the maximum interval that you can set is 12 weeks. For a monthly webinar, the maximum interval that you can set is 3 months.

type

enum<integer>

必需

Recurrence webinar types:
1 - Daily.
2 - Weekly.
3 - Monthly.

枚举值:

123

weekly_days

string

可选

Use this field only if you're scheduling a recurring webinar of type 2 to state which day(s) of the week the webinar should repeat.
The value for this field could be a number between 1 to 7 in string format. For instance, if the Webinar should recur on Sunday, provide "1" as the value of this field.

Note: If you would like the webinar to occur on multiple days of a week, you should provide comma separated values for this field. For instance, if the Webinar should recur on Sundays and Tuesdays provide "1,3" as the value of this field.

1 - Sunday.
2 - Monday.
3 - Tuesday.
4 - Wednesday.
5 - Thursday.
6 - Friday.
7 - Saturday.

settings

object

可选

Webinar settings.

allow_multiple_devices

boolean

可选

Allow attendees to join from multiple devices.

alternative_hosts

string

可选

Alternative host emails or IDs. Multiple values separated by comma.

approval_type

enum<integer>

可选

0 - Automatically approve.
1 - Manually approve.
2 - No registration required.

枚举值:

012

默认值:

attendees_and_panelists_reminder_email_notification

object

可选

Send reminder email to attendees and panelists.

audio

enum<string>

可选

Determine how participants can join the audio portion of the webinar.

枚举值:

bothtelephonyvoip

默认值:

both

authentication_domains

string

可选

If user has configured "Sign Into Zoom with Specified Domains" option, this will list the domains that are authenticated.

authentication_name

string

可选

Authentication name set in the authentication profile.

authentication_option

string

可选

Webinar authentication option id.

auto_recording

enum<string>

可选

Automatic recording:
local - Record on local.
cloud - Record on cloud.
none - Disabled.

枚举值:

localcloudnone

默认值:

none

close_registration

boolean

可选

Close registration after event date.

contact_email

string

可选

Contact email for registration

contact_name

string

可选

Contact name for registration

email_language

string

可选

Set the email language to one of the following:
en-US,de-DE,es-ES,fr-FR,jp-JP,pt-PT,ru-RU,zh-CN, zh-TW, ko-KO, it-IT, vi-VN.

enforce_login

boolean

可选

Only signed in users can join this meeting.

This field is deprecated and will not be supported in the future.

As an alternative, use the "meeting_authentication", "authentication_option" and "authentication_domains" fields to understand the authentication configurations set for the Webinar.

enforce_login_domains

string

可选

Only signed in users with specified domains can join meetings.

follow_up_absentees_email_notification

object

可选

Send follow-up email to absentees.

follow_up_attendees_email_notification

object

可选

Send follow-up email to attendees.

global_dial_in_countries

array[string]

可选

List of global dial-in countries

hd_video

boolean

可选

Default to HD video.

默认值:

false

host_video

boolean

可选

Start video when host joins webinar.

meeting_authentication

boolean

可选

true- Only authenticated users can join Webinar.

notify_registrants

boolean

可选

Send notification email to registrants when the host updates a webinar.

on_demand

boolean

可选

Make the webinar on-demand

默认值:

false

panelists_invitation_email_notification

boolean

可选

true: Send invitation email to panelists.

false: Do not send invitation email to panelists.

panelists_video

boolean

可选

Start video when panelists join webinar.

post_webinar_survey

boolean

可选

Zoom will open a survey page in attendees' browsers after leaving the webinar

practice_session

boolean

可选

Enable practice session.

默认值:

false

question_and_answer

object

可选

Q&A for webinar.

registrants_confirmation_email

boolean

可选

Send confirmation email to registrants

registrants_email_notification

boolean

可选

Send email notifications to registrants about approval, cancellation, denial of the registration. The value of this field must be set to true in order to use the registrants_confirmation_email field.

registrants_restrict_number

integer

可选

Restrict number of registrants for a webinar. By default, it is set to 0. A 0 value means that the restriction option is disabled. Provide a number higher than 0 to restrict the webinar registrants by the that number.

>= 0<= 20000

默认值:

registration_type

enum<integer>

可选

Registration types. Only used for recurring webinars with a fixed time.
1 - Attendees register once and can attend any of the webinar sessions.
2 - Attendees need to register for each session in order to attend.
3 - Attendees register once and can choose one or more sessions to attend.

枚举值:

123

默认值:

show_share_button

boolean

可选

Show social share buttons on the registration page.

survey_url

string

可选

Survey url for post webinar survey

start_time

string <date-time>

可选

Webinar start time in GMT/UTC.

start_url

string

可选

The start_url of a Webinar is a URL using which a host or an alternative host can start the Webinar. This URL should only be used by the host of the meeting and should not be shared with anyone other than the host of the Webinar.

The expiration time for the start_url field listed in the response of Create a Webinar API is two hours for all regular users.

For users created using the custCreate option via the Create Users API, the expiration time of the start_url field is 90 days.

For security reasons, to retrieve the latest value for the start_url field programmatically (after expiry), you must call the Retrieve a Webinar API and refer to the value of the start_url field in the response.

timezone

string

可选

Time zone to format start_time.

topic

string

可选

Webinar topic.

<= 200 字符

tracking_fields

array [object {2}]

可选

Tracking fields

field

string

可选

Tracking fields type

value

string

可选

Tracking fields value

type

enum<integer>

可选

Webinar Types:
5 - Webinar.
6 - Recurring webinar with no fixed time.
9 - Recurring webinar with a fixed time.

枚举值:

569

默认值:

🟠400**HTTP Status Code:** `400` **Bad Request** **Error Code:** `200` Subscription plan for webinar is missing. Enable webinar for this user once the subscription plan is added:{userId}.

🟠404**HTTP Status Code:** `404` **Not Found** **Error Code:** `1001` User {userId} not exist or not belong to this account.

修改于 2024-04-24 09:06:48

List webinars

Delete a webinar