获取缺席的网络研讨会

列出网络研讨会的缺席者。

** 范围: ** 'webinar:master'

** [速率限制标签](https://marketplace.zoom.us/docs/api参考/速率限制 # 速率限制):** “沉重”

请求参数

Path 参数

webinarId

string

必需

网络研讨会的ID或通用唯一ID (UUID)。

如果您提供网络研讨会ID，API将返回最新网络研讨会实例的响应。

如果您提供的网络研讨会UUID以 “/” 字符开头或包含 “//” 字符，您必须在发出API请求之前 ** [double encode](https://developers.zoom.us/docs/api/rest/using-zoom-API/# meeting-id-and-uuid) 网络研讨会UUID。

accountId

string

帐户的唯一标识符。

必需

Query 参数

occurrence_id

string

可选

会议或网络研讨会事件ID。

page_size

integer

可选

单个API调用中返回的记录数。

next_page_token

string

可选

使用next page标记对大型结果集进行分页。只要可用结果集超过当前页面大小时，就会返回下一页令牌。此令牌的有效期为15分钟。

返回响应

🟢200** HTTP状态代码: ** '200' 成功。 ** 错误代码: ** '200' 缺少网络研讨会计划订阅。添加订阅后，请为此用户启用网络研讨会:{userId}。

application/json

Body

用户列表。

registrants

array [object {21}]

注册人对象的列表。

可选

zip

string

注册人的邮政编码。

可选

示例值:

94045

country

string

可选

注册人的两个字母的ISO [国家代码](https://developers.zoom.us/docs/api/rest/其他-参考/缩写-列表/# 国家)。

示例值:

custom_questions

array [object {2}]

可选

有关自定义问题的信息。

purchasing_time_frame

enum<string>

可选

注册人的购买时间范围。

“一个月内”

'1-3个月'

'4-6个月'

“超过6个月”

'无时间帧'

枚举值:

Within a month1-3 months4-6 monthsMore than 6 monthsNo timeframe

示例值:

1-3 months

join_url

string <string>

可选

经批准的注册人可用于加入会议或网络研讨会的URL。

示例值:

https://example.com/j/11111

address

string

注册人的地址。

可选

示例值:

1800 Amphibious Blvd.

comments

string

可选

注册人的问题和评论。

示例值:

Looking forward to the discussion.

create_time

string <date-time>

注册人注册的时间。

可选

示例值:

2022-03-22T05:59:09Z

city

string

注册人的城市。

可选

示例值:

Mountain View

org

string

注册人的组织。

可选

示例值:

Cooking Org

last_name

string

注册人的姓氏。

可选

<= 64 字符

示例值:

Chill

no_of_employees

enum<string>

可选

注册人的员工人数。

'1-20'

'21-50'

'51-100'

'101-250'

'251-500'

'501-1,000'

'1,001-5,000'

'5,001-10,000'

“超过10，000”

枚举值:

1-2021-5051-100101-250251-500501-1,0001,001-5,0005,001-10,000More than 10,000

示例值:

1-20

industry

string

注册人的行业。

可选

示例值:

Food

phone

string

注册人的电话号码。

可选

示例值:

5550100

role_in_purchase_process

enum<string>

可选

注册人在购买过程中的角色。

“决策者”

“评估者/推荐者”

'影响者'

'不参与'

枚举值:

Decision MakerEvaluator/RecommenderInfluencerNot involved

示例值:

Influencer

string

注册人ID。

可选

示例值:

9tboDiHUQAeOnbmudzWa5g

state

string

注册人的州或省。

可选

示例值:

first_name

string

注册人的名字。

必需

<= 64 字符

示例值:

Jill

job_title

string

注册人的职称。

可选

示例值:

Chef

string <email>

必需

注册人的电子邮件地址。有关返回值的详细信息，请参阅 [电子邮件地址显示规则](https://developers.zoom.us/docs/api/rest/using-zoom-api/# Email-address-display-rules)。

<= 128 字符

示例值:

jchill@example.com

status

enum<string>

可选

注册人的注册状态。
“已批准”-用户已成功获得网络研讨会的批准。
“待定”-注册仍在进行中。
“拒绝”-用户被拒绝加入网络研讨会。

枚举值:

approveddeniedpending

示例值:

approved

page_number

integer

已废弃

** 已弃用。** 此字段已弃用。在将来的版本中，我们将不再支持此字段。相反，使用 'next_page_token' 进行分页。

默认值:

示例值:

next_page_token

string

可选

使用next page标记对大型结果集进行分页。只要可用结果集超过当前页面大小时，就会返回下一页令牌。此令牌的有效期为15分钟。

示例值:

w7587w4eiyfsudgf

total_records

integer

可选

跨页可用的所有记录的总数。

示例值:

page_count

integer

可选

为发出的请求返回的页数。

示例值:

page_size

integer

可选

通过单个API调用返回的记录数。

<= 300

默认值:

示例值:

示例

{
    "registrants": [
        {
            "zip": "94045",
            "country": "US",
            "custom_questions": [
                {
                    "title": "What do you hope to learn from this?",
                    "value": "Look forward to learning how you come up with new recipes and what other services you offer."
                }
            ],
            "purchasing_time_frame": "",
            "join_url": "https://example.com/j/11111",
            "address": "1800 Amphibious Blvd.",
            "comments": "Looking forward to the discussion.",
            "create_time": "2022-03-22T05:59:09Z",
            "city": "Mountain View",
            "org": "Cooking Org",
            "last_name": "Chill",
            "no_of_employees": "",
            "industry": "Food",
            "phone": "5550100",
            "role_in_purchase_process": "",
            "id": "9tboDiHUQAeOnbmudzWa5g",
            "state": "CA",
            "first_name": "Jill",
            "job_title": "Chef",
            "email": "jchill@example.com",
            "status": "approved"
        }
    ],
    "page_number": 1,
    "next_page_token": "w7587w4eiyfsudgf",
    "total_records": 20,
    "page_count": 1,
    "page_size": 30
}

🟠400** HTTP状态代码: ** '400' 错误的请求 ** 错误代码: ** '300' 无法完成请求，因为您提供了无效的发生ID: {occurrenceId} ** 错误代码: ** '1010' 用户不属于此帐户:{accountId}。 ** 错误码: ** '3000' 此网络研讨会无需注册: {webinarUUID}

🟠404** HTTP状态代码: ** '404' 未找到 ** 错误代码: ** '1001' 用户 {userId} 不存在或不属于此帐户。 ** 错误代码: ** '3001' 会议ID无效或未结束。

请求参数

示例代码

返回响应