List meeting registrants

A host or a user with admin permission can require registration for a Zoom meeting. Use this API to list users that have registered for a meeting.

Scopes: meeting:read:admin meeting:read

Rate Limit Label: Medium

{ "page_count": 1, "page_number": 1, "page_size": 1, "registrants": [ { "address": "11111 Awesome St", "city": "Paris", "comments": "Love using Zoom APIs", "country": "France", "create_time": "2012-04-14T16:55:30.231Z", "custom_questions": [ { "title": "Did you enjoy the registration process?", "value": "Yes, alot." }, { "title": "Would you like to register for our next meeting?", "value": "Absolutely." } ], "email": "somemeail@emailprovider.com", "first_name": "Tim", "id": "zjkfsdfjdfhg", "industry": "Tech", "job_title": "Developer", "join_url": "https://success.zoom.us/j/0000000000000", "last_name": "S.", "no_of_employees": "1-20", "org": "Growth", "phone": "00000", "purchasing_time_frame": "Within a month", "role_in_purchase_process": "Not involved", "state": "Ile-de-France", "status": "approved", "zip": "11000" } ], "total_records": 1 }

请求参数

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

可选

The meeting occurrence ID.

status

enum<string>

可选

The registrant status:
pending - Registrant's status is pending.
approved - Registrant's status is approved.
denied - Registrant's status is denied.

枚举值:

pendingapproveddenied

默认值:

approved

page_size

integer

可选

The number of records returned within a single API call.

<= 300

默认值:

page_number

integer

可选

Deprecated - This field has been deprecated and we will stop supporting it completely in a future release. Please use "next_page_token" for pagination instead of this field.

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

默认值:

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.

返回响应

🟢200**HTTP Status Code:** `200` Successfully listedd meeting registrants.

application/json

Body

List of users.

next_page_token

string

可选

page_count

integer

可选

The number of pages returned for the request made.

page_number

integer

可选

Deprecated: This field has been deprecated. Please use the "next_page_token" field for pagination instead of this field.

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.

registrants

array [object {21}]

可选

List of registrant objects.

string

可选

Registrant ID.

address

string

可选

Registrant's address.

city

string

可选

Registrant's city.

comments

string

可选

A field that allows registrants to provide any questions or comments that they might have.

country

string

可选

Registrant's country. The value of this field must be in two-letter abbreviated form and must match the ID field provided in the Countries table.

custom_questions

array [object {2}]

可选

Custom questions.

string

必需

A valid email address of the registrant.

<= 128 字符

first_name

string

必需

Registrant's first name.

<= 64 字符

industry

string

可选

Registrant's Industry.

job_title

string

可选

Registrant's job title.

last_name

string

可选

Registrant's last name.

<= 64 字符

no_of_employees

string

可选

Number of Employees:
1-20
21-50
51-100
101-500
500-1,000
1,001-5,000
5,001-10,000
More than 10,000

org

string

可选

Registrant's Organization.

phone

string

可选

Registrant's Phone number.

purchasing_time_frame

string

可选

This field can be included to gauge interest of webinar attendees towards buying your product or service.

Purchasing Time Frame:
Within a month
1-3 months
4-6 months
More than 6 months
No timeframe

role_in_purchase_process

string

可选

Role in Purchase Process:
Decision Maker
Evaluator/Recommender
Influencer
Not involved

state

string

可选

Registrant's State/Province.

zip

string

可选

Registrant's Zip/Postal Code.

create_time

string <date-time>

可选

The time at which the registrant registered.

join_url

string <string>

可选

The URL using which an approved registrant can join the webinar.

status

string

可选

The status of the registrant's registration.
approved: User has been successfully approved for the webinar.
pending: The registration is still pending.
denied: User has been denied from joining the webinar.

🔵300**Error Code:** `300` Meeting {meetingId} is not found or has expired. This meeting has not set registration as required: {meetingId}.

🟠400**HTTP Status Code:** `400` **Error Code:** `1010` User does not belong to this account: {accountId}. **Error Code:** `3003` You are not the meeting host. **Error Code:** `3000` Cannot access meeting info.

🟠404**HTTP Status Code:** `404` Meeting not found. **Error Code:** `1001` Meeting host does not exist: {userId}.