- 说明
- Meetings
- Billing
- SIP Phone
- Users
- Reports
- Groups
- H323 Devices
- Webinars
- 创建网络研讨会模板POST
- 列出网络研讨会模板GET
- 更新实时流状态PATCH
- 设置网络研讨会的默认品牌虚拟背景PATCH
- 上传网络研讨会的品牌虚拟背景POST
- 删除网络研讨会的品牌虚拟背景DELETE
- 创建网络研讨会POST
- 列出网络研讨会GET
- 执行批量注册POST
- 更新网络研讨会PATCH
- 获取网络研讨会GET
- 删除网络研讨会DELETE
- 创建网络研讨会的邀请链接POST
- 更新网络研讨会的品牌名称标签PATCH
- 更新注册人的状态PUT
- 获取缺席的网络研讨会GET
- 获取网络研讨会的会议品牌推广GET
- 获取网络研讨会注册人GET
- 删除网络研讨会注册人DELETE
- 获取网络研讨会的令牌GET
- 更新实时流PATCH
- 获取实时流详细信息GET
- 创建网络研 讨会的投票POST
- 列出网络研讨会的民意调查GET
- 获取网络研讨会跟踪源GET
- 更新注册问题PATCH
- 列出登记问题GET
- 更新网络研讨会状态PUT
- 添加小组成员POST
- 小组成员名单GET
- 删除网络研讨会小组成员DELETE
- 更新网络研讨会调查PATCH
- 获取网络研讨会调查GET
- 删除网络研讨会调查DELETE
- 添加网络研讨会注册人POST
- 列出网络研讨会注册人GET
- 删除小组成员DELETE
- 获取网络研讨会投票GET
- 删除网络研讨会投票DELETE
- 更新网络研讨会投票PUT
- 创建网络研讨会的品牌名称标签POST
- 删除网络研讨会的品牌名称标签DELETE
- 上传网络研讨会的品牌壁 纸POST
- 删除网络研讨会的品牌壁纸DELETE
- 列出过去的网络研讨会实例GET
- Tracking Field
- Dashboards
- Dashboards Copy
- Cloud Recording
- TSP
- SIP Connected Audio
- Accounts
- PAC
- Information Barriers
- IM Groups
- Roles
- Archiving
获取网络研讨会
GET
/accounts/{accountId}/webinars/{webinarId}
Webinars
使用此API获取计划的网络研讨会的详细信息。
请求参数
Path 参数
webinarId
string
必需
accountId
string
帐户的唯一标识符。
Query 参数
occurrence_id
string
可选
show_previous_occurrences
string
可选
示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://prod-cn.your-api-server.com/accounts//webinars/'
返回响应
🟢200** HTTP状态代码: ** '200'
成功
application/json
Body
网络研讨会对象。
occurrences
array [object {4}]
出现对象的数组。
duration
integer
持续时间。
示例值:
60
start_time
string <date-time>
开始时间。
示例值:
2022-03-25T07:46:00Z
status
string
发生状态。
示例值:
available
settings
object
网络研讨会设置。
post_webinar_survey
boolean
可选
示例值:
true
authentication_option
string
可选
示例值:
signIn_D8cJuqWVQ623CI4Q8yQK0Q
email_language
string
可选
“en-us” 、 “de-de” 、 “es-es” 、 “fr-fr” 、 “jp-jp” 、 “pt-pt” 、 “ru-ru” 、 “zh-cn” 、 'Zh-tw',' ko-ko ',' it-it ',' vi-vn '。
示例值:
en-US
sign_language_interpretation
object
可选
send_1080p_video_to_attendees
boolean
可选
默认值:
false
示例值:
false
show_share_button
boolean
可选
示例值:
true
hd_video
boolean
默认为高清视频。
默认值:
false
示例值:
false
registrants_confirmation_email
boolean
可选
示例值:
true
registration_type
enum<integer>
可选
'1'-与会者注册一次,即可参加任何网络研讨会。
“2”-与会者需要注册每个会话才能参加。
“3”-与会者注册一次,可以选择参加一个或多个会议。
枚举值:
123
默认值:
1
示例值:
1
contact_email
string
联系电子邮件注册。
示例值:
jchill@example.com
allow_multiple_devices
boolean
可选
示例值:
true
meeting_authentication
boolean
可选
示例值:
true
survey_url
string
可选
示例值:
https://example.com
alternative_hosts
string
可选
示例值:
jchill@example.com
alternative_host_update_polls
boolean
可选
示例值:
true
follow_up_absentees_email_notification
object
可选
add_audio_watermark
boolean
可选
示例值:
true
audio
enum<string>
可选
枚举值:
bothtelephonyvoipthirdParty
默认值:
both
示例值:
telephony
authentication_name
string
可选
示例值:
Sign in to Zoom
notify_registrants
boolean
可选
示例值:
true
practice_session
boolean
启用练习会话。
默认值:
false
示例值:
false
enforce_login_domains
string
已废弃
示例值:
example.com
global_dial_in_countries
array[string]
全球拨入国家列表
registrants_restrict_number
integer
可选
>= 0<= 20000
默认值:
0
示例值:
100
question_and_answer
object
可选
contact_name
string
注册的联系人姓名。
示例值:
Jill Chill
attendees_and_panelists_reminder_email_notification
object
可选
registrants_email_notification
boolean
可选
示例值:
true
approval_type
enum<integer>
可选
'1'-手动批准。
“2”-无需注册。
枚举值:
012
默认值:
2
示例值:
0
close_registration
boolean
已废弃
示例值:
true
auto_recording
enum<string>
可选
“本地”-记录在本地。
“云”-记录在云端。
'none'-已禁用。
枚举值:
localcloudnone
默认值:
none
示例值:
cloud
host_video
boolean
可选
示例值:
true
language_interpretation
object
可选
panelists_video
boolean
可选
示例值:
true
add_watermark
boolean
可选
示例值:
true
enforce_login
boolean
已废弃
示例值:
true
on_demand
boolean
可选
默认值:
false
示例值:
false
hd_video_for_attendees
boolean
可选
默认值:
false
示例值:
false
panelists_invitation_email_notification
boolean
可选
示例值:
true
panelist_authentication
boolean
可选
示例值:
true
enable_session_branding
boolean
可选
示例值:
true
audio_conference_info
string
可选
<= 2048 字符
示例值:
test
authentication_domains
string
可选
示例值:
example.com
follow_up_attendees_email_notification
object
可选
join_url
string
可选
示例值:
https://example.com/j/11111
timezone
string
可选
示例值:
America/Los_Angeles
start_url
string
可选
示例值:
https://example.com/s/11111
created_at
string <date-time>
创造时间。
示例值:
2022-03-26T07:18:32Z
record_file_id
string
可选
示例值:
f09340e1-cdc3-4eae-9a74-98f9777ed908
type
enum<integer>
可选
'5'-网络研讨会。
“6”-定期网络研讨 会,没有固定时间。
'9'-固定时间的定期网络研讨会。
枚举值:
569
默认值:
5
示例值:
5
uuid
string
可选
示例值:
m3WqMkvuRXyYqH+eKWhk9w==
agenda
string
网络研讨会议程。
示例值:
My webinar
host_id
string
可选
示例值:
30R7kT7bTIKSNUFEuH_Qlg
duration
integer
可选
示例值:
60
recurrence
object
复发网络研讨会
end_date_time
string <date-time>
可选
示例值:
2022-04-02T15:59:00Z
end_times
integer
可选
<= 60
默认值:
1
示例值:
7
monthly_week
enum<integer>
可选
“-1”-这个月的最后一周。
'1'-该月的第一周。
'2'-这个月的第二周。
'3'-这个月的第三周。
“4”-这个月的第四周。
枚举值:
-11234
示例值:
1
monthly_week_day
enum<integer>
可选
'1'-星期天。
“2”-星期一。
“3”-星期二。
“4”-星期三。
“5”-星期四。
“6”-星期五。
'7'-星期六。
枚举值:
1234567
示例值:
1
repeat_interval
integer
可选
示例值:
1
monthly_day
integer
可选
示例值:
1
type
enum<integer>
必需
'1'-每天。
“2”-每周。
“3”-每月。
枚举值:
123
示例值:
1
weekly_days
string
可选
此字段的值可以是字符串格式的 '1' 到 '7' 之间的数字。例如,如果网络研讨会应该在周日重复,请提供 “1” 作为此字段的值。
“2”-星期一。
“3”-星期二。
“4”-星期三。
“5”-星期四。
“6”-星期五。
'7'-星期六。
示例值:
1
start_time
string <date-time>
可选
示例值:
2022-03-26T07:18:32Z
password
string
可选
<= 10 字符
示例值:
123456
tracking_fields
array [object {2}]
跟踪字段。
field
string
跟踪字段类型。
示例值:
field1
value
string
跟踪字段值。
示例值:
value1
is_simulive
boolean
可选
示例值:
true
topic
string
网络研讨会主题。
<= 200 字符
示例值:
My Webinar
id
integer <int64>
可选
示例值:
97871060099
host_email
string <email>
可选
示例值:
jchill@example.com
示例
{
"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,
"uuid": "m3WqMkvuRXyYqH+eKWhk9w==",
"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",
"id": 97871060099,
"host_email": "jchill@example.com"
}
🟠400** HTTP状态代码: ** '400' <br>
错误的请求
** 错误代码: ** '1010' <br>
用户不属于此帐户:{accountId}。<br>
🟠404** HTTP状态代码: ** '404' <br>
未找到
** 错误代码: ** '1001' <br>
用户 {userId} 不存在或不属于此帐户。<br>
** 错误代码: ** '3001' <br>
网络研讨会 {webinarId} 未找到或已过期。<br>

扫码加 ZOOM 开发者 微信交流
在这里,获得 ZOOM API 文档 使用上的任何帮助,快速上手让你的研测效率得到大幅提升


修改于 2023-10-31 06:13:33