List webinar registrants

GET

/webinars/{webinarId}/registrants

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. Scheduling a Webinar with registration requires your registrants to complete a brief form before receiving the link to join the Webinar.

Use this API to list all the users that have registered for a webinar.

Prerequisites:

Pro or higher plan with a Webinar Add-on.
Scopes: webinar:read:admin webinar:read
Rate Limit Label: Medium

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://api.zoom.us/v2/webinars//registrants'

响应示例

200 - response

{
  "page_count": "1",
  "page_number": "1",
  "page_size": "30",
  "registrants": [
    {
      "address": "dsfhkdjsfh st",
      "city": "jackson heights",
      "comments": "Looking forward to the Webinar",
      "country": "US",
      "create_time": "2019-02-26T23:01:16.899Z",
      "custom_questions": [
        {
          "title": "What do you hope to learn from this Webinar?",
          "value": "Look forward to learning how you come up with new recipes and what other services you offer."
        }
      ],
      "email": "sjfkghdsg@someemail.dfgjd",
      "first_name": "Jill",
      "id": "24000002122",
      "industry": "Food",
      "job_title": "Chef",
      "join_url": "https://zoom.us/webinar/mywebinarissocooldighdghodghodg",
      "last_name": "Chill",
      "no_of_employees": "10",
      "org": "Cooking Org",
      "phone": "00000000",
      "purchasing_time_frame": "1-3 months",
      "role_in_purchase_process": "Influencer",
      "state": "NY",
      "status": "approved",
      "zip": "11371"
    }
  ],
  "total_records": "1"
}

请求参数

Path 参数

webinarId

integer <int64>

必需

The webinar ID in "long" format(represented as int64 data type in JSON).

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

tracking_source_id

string

可选

The tracking source ID for the registrants. Useful if you share the webinar registration page in multiple locations. See Creating source tracking links for webinar registration for details.

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` Webinar plan subscription is missing. Enable webinar for this user once the subscription is added:{userId}.

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**HTTP Status Code:** `300` Invalid webinar ID.

🟠400**HTTP Status Code:** `400` Bad request **Error Code:** `1010` User does not belong to this account:{accountId}.

🟠404**HTTP Status Code:** `404` Webinar not found. **Error Code:** `1001` User {userId} does not exist or does not belong to this account. **Error Code:** `3001` Webinar {webinarId} not found or has expired.

Update a webinar poll

Add a webinar registrant