List meetings - Zoom API

List all the meetings that were scheduled for a user (meeting host). This API only supports scheduled meetings and thus, details on instant meetings are not returned via this API.

Scopes: meeting:read:admin meeting:read

Rate Limit Label: Medium

{ "meetings": [ { "created_at": "2019-08-16T01:13:12Z", "duration": 30, "host_id": "abckjdfhsdkjf", "id": 11111, "join_url": "https://zoom.us/j/11111", "start_time": "2019-08-16T02:00:00Z", "timezone": "America/Los_Angeles", "topic": "Zoom Meeting", "type": 2, "uuid": "mlghmfghlBBB" }, { "agenda": "RegistrationDeniedTest", "created_at": "2019-08-16T18:30:46Z", "duration": 60, "host_id": "abckjdfhsdkjf", "id": 2222, "join_url": "https://zoom.us/j/2222", "start_time": "2019-08-16T19:00:00Z", "timezone": "America/Los_Angeles", "topic": "TestMeeting", "type": 2, "uuid": "J8H8eavweUcd321==" }, { "created_at": "2019-08-16T21:15:56Z", "duration": 60, "host_id": "abckjdfhsdkjf", "id": 33333, "join_url": "https://zoom.us/j/33333", "start_time": "2019-08-16T22:00:00Z", "timezone": "America/Los_Angeles", "topic": "My Meeting", "type": 2, "uuid": "SGVTAcfSfCbbbb" }, { "created_at": "2019-08-29T17:32:33Z", "duration": 60, "host_id": "abckjdfhsdkjf", "id": 44444, "join_url": "https://zoom.us/j/4444", "start_time": "2019-08-29T18:00:00Z", "timezone": "America/Los_Angeles", "topic": "MyTestPollMeeting", "type": 2, "uuid": "64123avdfsMVA==" } ], "page_count": 1, "page_number": 1, "page_size": 30, "total_records": 4 }

请求参数

Path 参数

userId

string

必需

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

Query 参数

type

enum<string>

可选

The meeting types:
scheduled - This includes all valid past meetings (unexpired), live meetings and upcoming scheduled meetings. It is equivalent to the combined list of "Previous Meetings" and "Upcoming Meetings" displayed in the user's Meetings page on the Zoom Web Portal.
live - All the ongoing meetings.
upcoming - All upcoming meetings including live meetings.

枚举值:

scheduledliveupcoming

默认值:

live

page_size

integer

可选

The number of records returned within a single API call.

<= 300

默认值:

next_page_token

string

可选

The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

page_number

string

可选

The page number of the current page in the returned records.

返回响应

🟢200**HTTP Status Code:** `200` List of meeting objects returned.

application/json

Body

List of meetings.

next_page_token

string

可选

page_count

integer

可选

The number of pages returned for the request made.

page_number

integer

可选

The page number of the current results.

默认值:

page_size

integer

可选

The number of records returned with a single API call.

<= 300

默认值:

total_records

integer

可选

The total number of all the records available across pages.

meetings

array [object {12}]

可选

List of Meeting objects.

agenda

string

可选

Meeting description. The length of agenda gets truncated to 250 characters when you list all meetings for a user. To view the complete agenda of a meeting, retrieve details for a single meeting here.

created_at

string <date-time>

可选

Time of creation.

duration

integer

可选

Meeting duration.

host_id

string

可选

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

integer <int64>

可选

Meeting ID - also known as the meeting number in long (int64) format.

join_url

string

可选

URL using which participants can join a meeting.

pmi

string

可选

Personal meeting ID. This field is only returned if PMI was used to schedule the meeting.

start_time

string <date-time>

可选

Meeting start time.

timezone

string

可选

Timezone to format the meeting start time.

topic

string

可选

Meeting topic.

type

enum<integer>

可选

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

枚举值:

1238

uuid

string

可选

Unique Meeting ID. Each meeting instance will generate its own Meeting UUID.

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