Create a meeting

POST

/users/{userId}/meetings

Meetings

Create a meeting for a user.
This API has a daily rate limit of 100 requests per day. Therefore, only 100 Create a Meeting API requests are permitted within a 24 hour window for a user.

The start_url of a meeting is a URL using which a host or an alternative host can start a meeting. The expiration time for the start_url field is two hours for all regular users.

For custCreate meeting hosts( i.e., users created using the custCreate option via the Create Users API), the expiration time of the start_url field is 90 days from the generation of the start_url.

For security reasons, the recommended way to retrieve the updated value for the start_url field programmatically (after expiry) is by calling the Retrieve a Meeting API and referring to the value of the start_url field in the response.

Scopes: meeting:write:admin meeting:write

Rate Limit Label: Medium

请求示例

Shell

JavaScript

Java

Swift

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

响应示例

201 - response

{
  "created_at": "2019-09-05T16:54:14Z",
  "duration": 60,
  "host_id": "AbcDefGHi",
  "id": 1100000,
  "join_url": "https://zoom.us/j/1100000",
  "settings": {
    "alternative_hosts": "",
    "approval_type": 2,
    "audio": "both",
    "auto_recording": "local",
    "breakout_room": {
      "enable": false,
      "host_video": false,
      "in_meeting": false,
      "join_before_host": true,
      "mute_upon_entry": false,
      "participant_video": false,
      "registrants_confirmation_email": true,
      "registrants_email_notification": true,
      "rooms": [
        {
          "name": "room1",
          "participants": [
            "james.user01@somemail1234.com",
            "james.user02@somemail1234.com"
          ]
        },
        {
          "name": "room2",
          "participants": [
            "james.user03@somemail1234.com"
          ]
        }
      ],
      "use_pmi": false,
      "waiting_room": false,
      "watermark": false
    },
    "close_registration": false,
    "cn_meeting": false,
    "enforce_login": false,
    "enforce_login_domains": "",
    "global_dial_in_countries": [
      "US"
    ],
    "global_dial_in_numbers": [
      {
        "city": "New York",
        "country": "US",
        "country_name": "US",
        "number": "+1 1000200200",
        "type": "toll"
      },
      {
        "city": "San Jose",
        "country": "US",
        "country_name": "US",
        "number": "+1 6699006833",
        "type": "toll"
      },
      {
        "city": "San Jose",
        "country": "US",
        "country_name": "US",
        "number": "+1 408000000",
        "type": "toll"
      }
    ],
    "start_time": "2019-08-30T22:00:00Z",
    "start_url": "https://zoom.us/s/1100000?iIifQ.wfY2ldlb82SWo3TsR77lBiJjR53TNeFUiKbLyCvZZjw",
    "status": "waiting",
    "timezone": "America/New_York",
    "topic": "API Test",
    "type": 2,
    "uuid": "ng1MzyWNQaObxcf3+Gfm6A=="
  }
}

请求参数

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

agenda

string

可选

Meeting description.

<= 2000 字符

duration

integer

可选

Meeting duration (minutes). Used for scheduled meetings only.

password

string

可选

Passcode to join the meeting. By default, passcode may only contain the following characters: [a-z A-Z 0-9 @ - _ *] and can have a maximum of 10 characters.

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 object. Use this object only for a meeting with type 8 i.e., a recurring meeting with fixed time.

end_date_time

string <date-time>

可选

Select the final date on which the meeting 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 meeting should 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 meeting of type 3 to state which day in a month, the meeting should recur. The value range is from 1 to 31.

For instance, if you would like the meeting 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 meeting to recur 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 meeting of type 3 to state the week of the month when the meeting 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 meeting 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 meeting of type 3 to state a specific day in a week when the monthly meeting 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 meeting should recur. For instance, if you would like to schedule a meeting 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 meeting, the maximum interval you can set is 90 days. For a weekly meeting the maximum interval that you can set is of 12 weeks. For a monthly meeting, there is a maximum of 3 months.

type

enum<integer>

必需

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

枚举值:

123

weekly_days

enum<string>

可选

This field is required if you're scheduling a recurring meeting of type 2 to state which day(s) of the week the meeting should repeat.

The value for this field could be a number between 1 to 7 in string format. For instance, if the meeting should recur on Sunday, provide "1" as the value of this field.

Note: If you would like the meeting to occur on multiple days of a week, you should provide comma separated values for this field. For instance, if the meeting 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.

枚举值:

1234567

默认值:

schedule_for

string

可选

If you would like to schedule this meeting for someone else in your account, provide the Zoom user id or email address of the user here.

settings

object

可选

Meeting settings.

additional_data_center_regions

array[string]

可选

Enable additional data center regions for this meeting. Provide the value in the form of array of country code(s) for the countries which are available as data center regions in the account settings but have been opt out of in the user settings. For instance, let's say that in your account settings, the data center regions that have been selected are Europe, Honkong, Australia, India, Latin America, Japan, China, United States,and Canada. The complete list of available data center regions for your account is: ["EU", "HK", "AU", "IN", "LA", "TY", "CN", "US", "CA"]. In user settings, you have opted out of India(IN) and Japan(TY) for meeting and webinar traffic routing. If you would like, you can still include India and Japan as additional data centers for this meeting using this field. To include India and Japan as additional data center regions, you would provide ["IN", "TY"] as the value.

allow_multiple_devices

boolean

可选

If set to true, attendees will be allowed to join a meeting from multiple devices.

Note: This setting is only applied for meetings that have enabled registration.

alternative_hosts

string

可选

Alternative host's emails or IDs: multiple values separated by a comma.

alternative_hosts_email_notification

boolean

可选

Flag to determine whether to send email notifications to alternative hosts, default value is true.

默认值:

true

approval_type

enum<integer>

可选

The default value is 2. To enable registration required, set the approval type to 0 or 1. Values include:

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

枚举值:

012

默认值:

approved_or_denied_countries_or_regions

object

可选

Approve or block users from specific regions/countries from joining this meeting.

audio

enum<string>

可选

Determine how participants can join the audio portion of the meeting.
both - Both Telephony and VoIP.
telephony - Telephony only.
voip - VoIP only.

枚举值:

bothtelephonyvoip

默认值:

both

authentication_domains

string

可选

Meeting authentication domains. This option, allows you to specify the rule so that Zoom users, whose email address contains a certain domain, can join the meeting. You can either provide multiple domains, using a comma in between and/or use a wildcard for listing domains.

authentication_option

string

可选

Specify the authentication type for users to join a meeting withmeeting_authentication setting set to true. The value of this field can be retrieved from the id field within authentication_options array in the response of Get User Settings API.

auto_recording

enum<string>

可选

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

枚举值:

localcloudnone

默认值:

none

breakout_room

object

可选

Setting to pre-assign breakout rooms.

close_registration

boolean

可选

Close registration after event date

默认值:

false

cn_meeting

boolean

可选

Host meeting in China.

默认值:

false

contact_email

string

可选

Contact email for registration

contact_name

string

可选

Contact name for registration

encryption_type

enum<string>

可选

Choose between enhanced encryption and end-to-end encryption when starting or a meeting. When using end-to-end encryption, several features (e.g. cloud recording, phone/SIP/H.323 dial-in) will be automatically disabled.

The value of this field can be one of the following:
enhanced_encryption: Enhanced encryption. Encryption is stored in the cloud if you enable this option.

e2ee: End-to-end encryption. The encryption key is stored in your local device and can not be obtained by anyone else. Enabling this setting also disables the following features: join before host, cloud recording, streaming, live transcription, breakout rooms, polling, 1:1 private chat, and meeting reactions.

枚举值:

enhanced_encryptione2ee

global_dial_in_countries

array[string]

可选

List of global dial-in countries

host_video

boolean

可选

Start video when the host joins the meeting.

in_meeting

boolean

可选

Host meeting in India.

默认值:

false

jbh_time

enum<integer>

可选

If the value of "join_before_host" field is set to true, this field can be used to indicate time limits within which a participant may join a meeting before a host. The value of this field can be one of the following:

0: Allow participant to join anytime.

5: Allow participant to join 5 minutes before meeting start time.

10: Allow participant to join 10 minutes before meeting start time.

枚举值:

0510

join_before_host

boolean

可选

Allow participants to join the meeting before the host starts the meeting. This field can only used for scheduled or recurring meetings.

Note: If waiting room is enabled, the join before host setting will be disabled.

默认值:

false

language_interpretation

object

可选

Language interpretation settings for meetings.

Note: This feature is only available on certain Webinar add-on, Education, Business and higher plans. If this feature is not enabled on the host's account, this setting will not be applied for the meeting.

meeting_authentication

boolean

可选

Only authenticated users can join meeting if the value of this field is set to true.

mute_upon_entry

boolean

可选

Mute participants upon entry.

默认值:

false

participant_video

boolean

可选

Start video when participants join the meeting.

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.

registration_type

enum<integer>

可选

Registration type. Used for recurring meeting with fixed time only.
1 Attendees register once and can attend any of the occurrences.
2 Attendees need to register for each occurrence to attend.
3 Attendees register once and can choose one or more occurrences to attend.

枚举值:

123

默认值:

show_share_button

boolean

可选

If set to true, the registration page for the meeting will include social share buttons.

Note: This setting is only applied for meetings that have enabled registration.

use_pmi

boolean

可选

Use Personal Meeting ID instead of an automatically generated meeting ID. It can only be used for scheduled meetings, instant meetings and recurring meetings with no fixed time.

默认值:

false

waiting_room

boolean

可选

Enable waiting room. Note that if the value of this field is set to true, it will override and disable the join_before_host setting.

watermark

boolean

可选

Add watermark when viewing a shared screen.

默认值:

false

start_time

string <date-time>

可选

Meeting start time. We support two formats for start_time - local time and GMT.

To set time as GMT the format should be yyyy-MM-ddTHH:mm:ssZ. Example: "2020-03-31T12:02:00Z"

To set time using a specific timezone, use yyyy-MM-ddTHH:mm:ss format and specify the timezone ID in the timezone field OR leave it blank and the timezone set on your Zoom account will be used. You can also set the time as UTC as the timezone field.

The start_time should only be used for scheduled and / or recurring webinars with fixed time.

template_id

string

可选

Unique identifier of the admin meeting template. To create admin meeting templates, contact the Zoom support team.

Use this field if you would like to schedule the meeting from a admin meeting template. You can retrieve the value of this field by calling the List meeting templates API.

timezone

string

可选

Time zone to format start_time. For example, "America/Los_Angeles". For scheduled meetings only. Please reference our time zone list for supported time zones and their formats.

topic

string

可选

Meeting topic.

tracking_fields

array [object {2}]

可选

Tracking fields

field

string

必需

Label of the tracking field.

value

string

可选

Tracking fields value

type

enum<integer>

可选

Meeting Type:
1 - Instant meeting.
2 - Scheduled meeting.
3 - Recurring meeting with no fixed time.
8 - Recurring meeting with fixed time.

枚举值:

1238

默认值:

示例值:

返回响应

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

application/json

Body

Meeting object

assistant_id

string

可选

Unique identifier of the scheduler who scheduled this meeting on behalf of the host. This field is only returned if you used "schedule_for" option in the Create a Meeting API request.

host_email

string <email>

可选

Email address of the meeting host.

integer <int64>

可选

Meeting ID: Unique identifier of the meeting in "long" format(represented as int64 data type in JSON), also known as the meeting number.

registration_url

string

可选

URL using which registrants can register for a meeting. This field is only returned for meetings that have enabled registration.

agenda

string

Agenda

可选

created_at

string <date-time>

可选

The date and time at which this meeting was created.

duration

integer

可选

Meeting duration.

h323_password

string

可选

H.323/SIP room system password

join_url

string

可选

URL for participants to join the meeting. This URL should only be shared with users that you would like to invite for the meeting.

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

可选

Meeting password. Password may only contain the following characters: [a-z A-Z 0-9 @ - _ * !]

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

pmi

integer <int64>

可选

Personal Meeting Id. Only used for scheduled meetings and recurring meetings with no fixed time.

recurrence

object

可选

Recurrence object. Use this object only for a meeting with type 8 i.e., a recurring meeting with fixed time.

end_date_time

string <date-time>

可选

Select the final date on which the meeting 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 meeting should 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 meeting of type 3 to state which day in a month, the meeting should recur. The value range is from 1 to 31.

默认值:

monthly_week

enum<integer>

可选

枚举值:

-11234

monthly_week_day

enum<integer>

可选

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

枚举值:

1234567

repeat_interval

integer

可选

type

enum<integer>

必需

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

枚举值:

123

weekly_days

enum<string>

可选

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

枚举值:

1234567

默认值:

settings

object

可选

Meeting settings.

allow_multiple_devices

boolean

可选

Allow attendees to join the meeting from multiple devices. This setting only works for meetings that require registration.

alternative_hosts

string

可选

Alternative host's emails or IDs: multiple values are separated by a semicolon.

alternative_hosts_email_notification

boolean

可选

Flag to determine whether to send email notifications to alternative hosts, default value is true.

默认值:

true

approval_type

enum<integer>

可选

Enable registration and set approval for the registration. Note that this feature requires the host to be of Licensed user type. Registration cannot be enabled for a basic user.

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

枚举值:

012

默认值:

approved_or_denied_countries_or_regions

object

可选

Approve or block users from specific regions/countries from joining this meeting.

audio

enum<string>

可选

Determine how participants can join the audio portion of the meeting.
both - Both Telephony and VoIP.
telephony - Telephony only.
voip - VoIP only.

枚举值:

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_exception

array [object {2}]

可选

The participants added here will receive unique meeting invite links and bypass authentication.

authentication_name

string

可选

Authentication name set in the authentication profile.

authentication_option

string

可选

Meeting authentication option id.

auto_recording

enum<string>

可选

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

枚举值:

localcloudnone

默认值:

none

breakout_room

object

可选

Setting to pre-assign breakout rooms.

close_registration

boolean

可选

Close registration after event date

默认值:

false

cn_meeting

boolean

可选

Host meeting in China.

默认值:

false

contact_email

string

可选

Contact email for registration

contact_name

string

可选

Contact name for registration

custom_keys

array [object {2}]

可选

Custom keys and values assigned to the meeting.

<= 10 items

encryption_type

enum<string>

可选

枚举值:

enhanced_encryptione2ee

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 meeting.

enforce_login_domains

string

可选

Only signed in users with specified domains can join meetings.

global_dial_in_countries

array[string]

可选

List of global dial-in countries

global_dial_in_numbers

array [object {5}]

可选

Global Dial-in Countries/Regions

host_video

boolean

可选

Start video when the host joins the meeting.

in_meeting

boolean

可选

Host meeting in India.

默认值:

false

jbh_time

enum<integer>

可选

0: Allow participant to join anytime.

5: Allow participant to join 5 minutes before meeting start time.

10: Allow participant to join 10 minutes before meeting start time.

枚举值:

0510

join_before_host

boolean

可选

Allow participants to join the meeting before the host starts the meeting. Only used for scheduled or recurring meetings.

默认值:

false

language_interpretation

object

可选

meeting_authentication

boolean

可选

true- Only authenticated users can join meetings.

mute_upon_entry

boolean

可选

Mute participants upon entry.

默认值:

false

participant_video

boolean

可选

Start video when participants join the meeting.

registrants_confirmation_email

boolean

可选

Send confirmation email to registrants upon successful registration.

registrants_email_notification

boolean

可选

registration_type

enum<integer>

可选

枚举值:

123

默认值:

show_share_button

boolean

可选

Show social share buttons on the meeting registration page.
This setting only works for meetings that require registration.

use_pmi

boolean

可选

Use a personal meeting ID. Only used for scheduled meetings and recurring meetings with no fixed time.

默认值:

false

waiting_room

boolean

可选

Enable waiting room

默认值:

false

watermark

boolean

可选

Add watermark when viewing a shared screen.

默认值:

false

start_time

string <date-time>

可选

Meeting start date-time in UTC/GMT. Example: "2020-03-31T12:02:00Z"

start_url

string

可选

URL to start the meeting. 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 meeting as anyone with this URL will be able to login to the Zoom Client as the host of the meeting.

timezone

string

可选

Timezone to format start_time

topic

string

可选

Meeting topic

<= 200 字符

tracking_fields

array [object {3}]

可选

Tracking fields

field

string

可选

Label of the tracking field.

value

string

可选

Value for the field.

visible

boolean

可选

Indicates whether the tracking field is visible in the meeting scheduling options in the Zoom Web Portal or not.

true: Tracking field is visible.

false: Tracking field is not visible to the users in the meeting options in the Zoom Web Portal but the field was used while scheduling this meeting via API. An invisible tracking field can be used by users while scheduling meetings via API only.

type

enum<integer>

可选

Meeting Type

枚举值:

1238

默认值:

🔵300**HTTP Status Code:** `300` Invalid enforce_login_domains, separate multiple domains by semicolon. A maximum of {rateLimitNumber} meetings can be created/updated for a single user in one day.

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

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

List meetings

List Zoom meetings client feedback