创建网络研讨会 - Zoom API 中文版

为用户 (网络研讨会主持人) 安排网络研讨会。对于用户级应用，传递 ['me' 值](https://developers.zoom.us/docs/api/rest/using-zoom-api/# the-me-关键字) 而不是 'userId' 参数。

Zoom拥有网络研讨会计划的用户可以创建和管理网络研讨会。网络研讨会允许主持人向多达10，000名与会者广播Zoom会议。

** 每天100个请求 **。速率限制应用于用于发出请求的 ** 网络研讨会主机 ** 的 “userid”。

** 先决条件: **

带有网络研讨会附加组件的Pro或更高版本计划。

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

** [速率限制标签](https://marketplace.zoom.us/docs/api-reference/Rate-limits # 速率限制):** 'LIGHT'

请求参数

Path 参数

Body 参数application/json

示例

{
    "settings": {
        "post_webinar_survey": true,
        "authentication_option": "signIn_D8cJuqWVQ623CI4Q8yQK0Q",
        "email_language": "en-US",
        "sign_language_interpretation": {
            "enable": true,
            "interpreters": [
                {
                    "sign_language": "American",
                    "email": "interpreter@example.com"
                }
            ]
        },
        "send_1080p_video_to_attendees": false,
        "show_share_button": true,
        "hd_video": false,
        "registration_type": 1,
        "contact_email": "jchill@example.com",
        "allow_multiple_devices": true,
        "meeting_authentication": true,
        "survey_url": "https://example.com",
        "alternative_hosts": "jchill@example.com;thill@example.com",
        "alternative_host_update_polls": true,
        "follow_up_absentees_email_notification": {
            "enable": true,
            "type": 0
        },
        "add_audio_watermark": true,
        "audio": "both",
        "practice_session": false,
        "enforce_login_domains": "example.com",
        "global_dial_in_countries": [
            "US"
        ],
        "registrants_restrict_number": 0,
        "question_and_answer": {
            "allow_auto_reply": true,
            "allow_anonymous_questions": true,
            "answer_questions": "only",
            "enable": true,
            "allow_submit_questions": true,
            "attendees_can_comment": true,
            "auto_reply_text": "Thank you for your question. We will get back to you shortly.",
            "attendees_can_upvote": true
        },
        "contact_name": "Jill Chill",
        "attendees_and_panelists_reminder_email_notification": {
            "enable": true,
            "type": 0
        },
        "registrants_email_notification": true,
        "approval_type": 2,
        "close_registration": true,
        "auto_recording": "none",
        "host_video": true,
        "language_interpretation": {
            "enable": true,
            "interpreters": [
                {
                    "languages": "US,CN",
                    "email": "interpreter@example.com"
                }
            ]
        },
        "panelists_video": true,
        "add_watermark": true,
        "enforce_login": true,
        "on_demand": false,
        "hd_video_for_attendees": false,
        "panelists_invitation_email_notification": true,
        "panelist_authentication": true,
        "enable_session_branding": true,
        "audio_conference_info": "test",
        "authentication_domains": "example.com",
        "follow_up_attendees_email_notification": {
            "enable": true,
            "type": 0
        }
    },
    "timezone": "America/Los_Angeles",
    "record_file_id": "f09340e1-cdc3-4eae-9a74-98f9777ed908",
    "schedule_for": "jchill@example.com",
    "type": 5,
    "agenda": "My Webinar",
    "duration": 60,
    "recurrence": {
        "end_date_time": "2022-04-02T15:59:00Z",
        "end_times": 1,
        "monthly_week": -1,
        "monthly_week_day": 1,
        "repeat_interval": 1,
        "monthly_day": 1,
        "type": 1,
        "weekly_days": "1"
    },
    "start_time": "2022-03-26T06:44:14Z",
    "password": "123456",
    "tracking_fields": [
        {
            "field": "field1",
            "value": "value1"
        }
    ],
    "is_simulive": true,
    "topic": "My Webinar",
    "template_id": "5Cj3ceXoStO6TGOVvIOVPA=="
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://prod-cn.your-api-server.com/accounts//users//webinars' \
--header 'Content-Type: application/json' \
--data-raw '{
    "settings": {
        "post_webinar_survey": true,
        "authentication_option": "signIn_D8cJuqWVQ623CI4Q8yQK0Q",
        "email_language": "en-US",
        "sign_language_interpretation": {
            "enable": true,
            "interpreters": [
                {
                    "sign_language": "American",
                    "email": "interpreter@example.com"
                }
            ]
        },
        "send_1080p_video_to_attendees": false,
        "show_share_button": true,
        "hd_video": false,
        "registration_type": 1,
        "contact_email": "jchill@example.com",
        "allow_multiple_devices": true,
        "meeting_authentication": true,
        "survey_url": "https://example.com",
        "alternative_hosts": "jchill@example.com;thill@example.com",
        "alternative_host_update_polls": true,
        "follow_up_absentees_email_notification": {
            "enable": true,
            "type": 0
        },
        "add_audio_watermark": true,
        "audio": "both",
        "practice_session": false,
        "enforce_login_domains": "example.com",
        "global_dial_in_countries": [
            "US"
        ],
        "registrants_restrict_number": 0,
        "question_and_answer": {
            "allow_auto_reply": true,
            "allow_anonymous_questions": true,
            "answer_questions": "only",
            "enable": true,
            "allow_submit_questions": true,
            "attendees_can_comment": true,
            "auto_reply_text": "Thank you for your question. We will get back to you shortly.",
            "attendees_can_upvote": true
        },
        "contact_name": "Jill Chill",
        "attendees_and_panelists_reminder_email_notification": {
            "enable": true,
            "type": 0
        },
        "registrants_email_notification": true,
        "approval_type": 2,
        "close_registration": true,
        "auto_recording": "none",
        "host_video": true,
        "language_interpretation": {
            "enable": true,
            "interpreters": [
                {
                    "languages": "US,CN",
                    "email": "interpreter@example.com"
                }
            ]
        },
        "panelists_video": true,
        "add_watermark": true,
        "enforce_login": true,
        "on_demand": false,
        "hd_video_for_attendees": false,
        "panelists_invitation_email_notification": true,
        "panelist_authentication": true,
        "enable_session_branding": true,
        "audio_conference_info": "test",
        "authentication_domains": "example.com",
        "follow_up_attendees_email_notification": {
            "enable": true,
            "type": 0
        }
    },
    "timezone": "America/Los_Angeles",
    "record_file_id": "f09340e1-cdc3-4eae-9a74-98f9777ed908",
    "schedule_for": "jchill@example.com",
    "type": 5,
    "agenda": "My Webinar",
    "duration": 60,
    "recurrence": {
        "end_date_time": "2022-04-02T15:59:00Z",
        "end_times": 1,
        "monthly_week": -1,
        "monthly_week_day": 1,
        "repeat_interval": 1,
        "monthly_day": 1,
        "type": 1,
        "weekly_days": "1"
    },
    "start_time": "2022-03-26T06:44:14Z",
    "password": "123456",
    "tracking_fields": [
        {
            "field": "field1",
            "value": "value1"
        }
    ],
    "is_simulive": true,
    "topic": "My Webinar",
    "template_id": "5Cj3ceXoStO6TGOVvIOVPA=="
}'

返回响应

🟢201** HTTP状态代码: ** '201' 网络研讨会创建。

application/json

Body

示例

{
    "occurrences": [
        {
            "duration": 60,
            "start_time": "2022-03-25T07:46:00Z",
            "occurrence_id": "1648194360000",
            "status": "available"
        }
    ],
    "settings": {
        "post_webinar_survey": true,
        "authentication_option": "signIn_D8cJuqWVQ623CI4Q8yQK0Q",
        "email_language": "en-US",
        "sign_language_interpretation": {
            "enable": true,
            "interpreters": [
                {
                    "sign_language": "American",
                    "email": "interpreter@example.com"
                }
            ]
        },
        "send_1080p_video_to_attendees": false,
        "show_share_button": true,
        "hd_video": false,
        "registrants_confirmation_email": true,
        "registration_type": 1,
        "contact_email": "jchill@example.com",
        "allow_multiple_devices": true,
        "meeting_authentication": true,
        "survey_url": "https://example.com",
        "alternative_hosts": "jchill@example.com",
        "alternative_host_update_polls": true,
        "follow_up_absentees_email_notification": {
            "enable": true,
            "type": 0
        },
        "add_audio_watermark": true,
        "audio": "both",
        "authentication_name": "Sign in to Zoom",
        "notify_registrants": true,
        "practice_session": false,
        "enforce_login_domains": "example.com",
        "global_dial_in_countries": [
            "US"
        ],
        "registrants_restrict_number": 0,
        "question_and_answer": {
            "allow_auto_reply": true,
            "allow_anonymous_questions": true,
            "answer_questions": "only",
            "enable": true,
            "allow_submit_questions": true,
            "attendees_can_comment": true,
            "auto_reply_text": "Thank you for your question. We will get back to you shortly.",
            "attendees_can_upvote": true
        },
        "contact_name": "Jill Chill",
        "attendees_and_panelists_reminder_email_notification": {
            "enable": true,
            "type": 0
        },
        "registrants_email_notification": true,
        "approval_type": 2,
        "close_registration": true,
        "auto_recording": "none",
        "host_video": true,
        "language_interpretation": {
            "enable": true,
            "interpreters": [
                {
                    "languages": "US,CN",
                    "email": "interpreter@example.com"
                }
            ]
        },
        "panelists_video": true,
        "add_watermark": true,
        "enforce_login": true,
        "on_demand": false,
        "hd_video_for_attendees": false,
        "panelists_invitation_email_notification": true,
        "panelist_authentication": true,
        "enable_session_branding": true,
        "audio_conference_info": "test",
        "authentication_domains": "example.com",
        "follow_up_attendees_email_notification": {
            "enable": true,
            "type": 0
        }
    },
    "join_url": "https://example.com/j/11111",
    "timezone": "America/Los_Angeles",
    "start_url": "https://example.com/s/11111",
    "created_at": "2022-03-26T07:18:32Z",
    "record_file_id": "f09340e1-cdc3-4eae-9a74-98f9777ed908",
    "type": 5,
    "registrants_confirmation_email": true,
    "uuid": "Bznyg8KZTdCVbQxvS/oZ7w==",
    "agenda": "My Webinar",
    "host_id": "30R7kT7bTIKSNUFEuH_Qlg",
    "duration": 60,
    "recurrence": {
        "end_date_time": "2022-04-02T15:59:00Z",
        "end_times": 1,
        "monthly_week": -1,
        "monthly_week_day": 1,
        "repeat_interval": 1,
        "monthly_day": 1,
        "type": 1,
        "weekly_days": "1"
    },
    "start_time": "2022-03-26T07:18:32Z",
    "password": "123456",
    "tracking_fields": [
        {
            "field": "field1",
            "value": "value1"
        }
    ],
    "is_simulive": true,
    "topic": "My Webinar",
    "template_id": "ull6574eur",
    "id": 95204914252,
    "host_email": "jchill@example.com"
}

🟠400** HTTP状态代码: ** '400' 错误的请求 ** 错误代码: ** '200' 缺少网络研讨会的订阅计划。添加订阅计划后，为该用户启用网络研讨会:{userId}。 * “{0}” 中的用户已被阻止加入会议和网络研讨会。要取消阻止它们，请转到Zoom web门户中的设置页面，并更新 “阻止特定域中的用户加入会议和网络研讨会”。 ** 错误代码: ** '300' * 您为schedule_for字段输入的值无效。请输入有效值，然后重试。

🟠404** HTTP状态代码: ** '404' 未找到 ** 错误代码: ** '1001' 用户 {userId} 不存在或不属于此帐户。