Get a meeting

GET

/meetings/{meetingId}

Meetings

Retrieve the details of a meeting.

Scopes: meeting:read:admin meeting:read

Rate Limit Label: Light

响应示例

200 - response

{
  "agenda": "API overview",
  "created_at": "2019-09-09T15:54:24Z",
  "duration": 60,
  "host_id": "ABcdofjdogh11111",
  "id": 1234555466,
  "join_url": "https://zoom.us/j/1234555466",
  "settings": {
    "alternative_hosts": "kjxckfjxgfgjdfk@dkjfhdskhf.com",
    "approval_type": 2,
    "audio": "both",
    "auto_recording": "local",
    "close_registration": false,
    "cn_meeting": false,
    "enforce_login": false,
    "enforce_login_domains": "mycompanydomain.com",
    "global_dial_in_countries": [
      "US"
    ],
    "global_dial_in_numbers": [
      {
        "city": "New York",
        "country": "US",
        "country_name": "US",
        "number": "+1 000011100",
        "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 221122112211",
        "type": "toll"
      }
    ],
    "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,
    "use_pmi": false,
    "waiting_room": false,
    "watermark": false
  },
  "start_time": "2019-08-30T22:00:00Z",
  "start_url": "https://zoom.us/1234555466/cdknfdffgggdfg4MDUxNjY0LCJpYXQiOjE1NjgwNDQ0NjQsImFpZCI6IjRBOWR2QkRqVHphd2J0amxoejNQZ1EiLCJjaWQiOiIifQ.Pz_msGuQwtylTtYQ",
  "status": "waiting",
  "timezone": "America/New_York",
  "topic": "My API Test",
  "type": 2,
  "uuid": "iAABBBcccdddd7A=="
}

请求参数

Path 参数

meetingId

integer <int64>

必需

The meeting ID in long format. The data type of this field is "long"(represented as int64 in JSON).

While storing it in your database, store it as a long data type and not as an integer, as the Meeting IDs can be longer than 10 digits.

Query 参数

occurrence_id

string

可选

Meeting Occurrence ID. Provide this field to view meeting details of a particular occurrence of the recurring meeting.

show_previous_occurrences

boolean

可选

Set the value of this field to true if you would like to view meeting details of all previous occurrences of a recurring meeting.

返回响应

🟢200**HTTP Status Code:** `200` Meeting object returned.

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.

host_id

string

可选

ID of the user who is set as host of meeting.

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.

uuid

string

可选

Unique meeting ID. Each meeting instance will generate its own Meeting UUID (i.e., after a meeting ends, a new UUID will be generated for the next instance of the meeting). You can retrieve a list of UUIDs from past meeting instances using this API . Please double encode your UUID when using it for API calls if the UUID begins with a '/'or contains '//' in it.

agenda

string

可选

Meeting description

<= 2000 字符

created_at

string <date-time>

可选

Time of creation.

duration

integer

可选

Meeting duration.

encrypted_password

string

可选

Encrypted passcode for third party endpoints (H323/SIP).

h323_password

string

可选

H.323/SIP room system passcode.

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

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.

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

默认值:

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>

可选

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

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>

可选

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

可选

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

可选

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 time in GMT/UTC. Start time will not be returned if the meeting is an instant meeting.

start_url

string

可选

The start_url of a Meeting is a URL using which a host or an alternative host can start the Meeting.

The expiration time for the start_url field listed in the response of Create a Meeting 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 updated value for the start_url field programmatically (after the expiry time), you must call the Retrieve a Meeting API and refer to the value of the start_url field in the response.

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.

status

enum<string>

可选

Meeting status

枚举值:

waitingstarted

timezone

string

可选

Timezone to format the meeting start time on the .

topic

string

可选

Meeting topic.

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 when they look at the meeting details 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 Types:
1 - Instant meeting.
2 - Scheduled meeting.
3 - Recurring meeting with no fixed time.
4 - PMI Meeting
8 - Recurring meeting with a fixed time.

枚举值:

1238

默认值:

🟠400**HTTP Status Code:** `400` **Error Code:** `1010` User not found on this account: {accountId}. **Error Code:** `3000` Cannot access webinar info.

🟠404**HTTP Status Code:** `404` Meeting not found. **Error Code:** `1001` User not exist: {userId}. **Error Code:** `3001` Meeting {meetingId} is not found or has expired.

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

Delete a meeting

Update a meeting