Class: ZoomUs::Webinars

Inherits:
Object
  • Object
show all
Defined in:
lib/zoom_us/webinars.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ Webinars

Returns a new instance of Webinars.



19
20
21
 
# File 'lib/zoom_us/webinars.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/zoom_us/webinars.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_tracking_sources(webinar_id, opts = {}) ⇒ InlineResponse20074

Get Webinar Tracking Sources [Webinar Registration Tracking Sources](support.zoom.us/hc/en-us/articles/360000315683-Webinar-Registration-Source-Tracking) allow you to see where your registrants are coming from if you share the webinar registration page in multiple platforms. You can then use the source tracking to see the number of registrants generated from each platform.
Use this API to list information on all the tracking sources of a Webinar.
Scopes: ‘webinar:read:admin`, `webinar:read`

Prerequisites:
* [Webinar license](zoom.us/webinar). * Registration must be required for the Webinar.

Parameters:

  • webinar_id —

    The webinar ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (InlineResponse20074) 


27
28
29
30
 
# File 'lib/zoom_us/webinars.rb', line 27

def get_tracking_sources(webinar_id, opts = {})
  data, _status_code, _headers = get_tracking_sources_with_http_info(webinar_id, opts)
  data
end

#get_tracking_sources_with_http_info(webinar_id, opts = {}) ⇒ Array<(InlineResponse20074, Fixnum, Hash)>

Get Webinar Tracking Sources [Webinar Registration Tracking Sources](support.zoom.us/hc/en-us/articles/360000315683-Webinar-Registration-Source-Tracking) allow you to see where your registrants are coming from if you share the webinar registration page in multiple platforms. You can then use the source tracking to see the number of registrants generated from each platform.&lt;br&gt; Use this API to list information on all the tracking sources of a Webinar.&lt;br&gt; Scopes: &#x60;webinar:read:admin&#x60;, &#x60;webinar:read&#x60;&lt;br&gt; &lt;br&gt; Prerequisites:&lt;br&gt; * [Webinar license](zoom.us/webinar). * Registration must be required for the Webinar.

Parameters:

  • webinar_id —

    The webinar ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20074, Fixnum, Hash)>) —

    InlineResponse20074 data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/zoom_us/webinars.rb', line 37

def get_tracking_sources_with_http_info(webinar_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebinarsApi.get_tracking_sources ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling WebinarsApi.get_tracking_sources"
  end
  # resource path
  local_var_path = '/webinars/{webinarId}/tracking_sources'.sub('{' + 'webinarId' + '}', webinar_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20074')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebinarsApi#get_tracking_sources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_past_webinar_files(webinar_id, opts = {}) ⇒ InlineResponse20084

List Past Webinar Files List files sent via in-meeting chat during a meeting. The in-meeting files are deleted after 24 hours of the meeting completion time.
Scope: ‘webinar:read`, `webinar:read:admin`

Parameters:

  • webinar_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (InlineResponse20084) 


81
82
83
84
 
# File 'lib/zoom_us/webinars.rb', line 81

def list_past_webinar_files(webinar_id, opts = {})
  data, _status_code, _headers = list_past_webinar_files_with_http_info(webinar_id, opts)
  data
end

#list_past_webinar_files_with_http_info(webinar_id, opts = {}) ⇒ Array<(InlineResponse20084, Fixnum, Hash)>

List Past Webinar Files List files sent via in-meeting chat during a meeting. The in-meeting files are deleted after 24 hours of the meeting completion time. &lt;br&gt;&lt;br&gt; Scope: &#x60;webinar:read&#x60;, &#x60;webinar:read:admin&#x60;&lt;br&gt; &lt;br&gt;

Parameters:

  • webinar_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20084, Fixnum, Hash)>) —

    InlineResponse20084 data, response status code and response headers



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/zoom_us/webinars.rb', line 91

def list_past_webinar_files_with_http_info(webinar_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebinarsApi.list_past_webinar_files ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling WebinarsApi.list_past_webinar_files"
  end
  # resource path
  local_var_path = '/past_webinars/{webinarId}/files'.sub('{' + 'webinarId' + '}', webinar_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20084')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebinarsApi#list_past_webinar_files\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_past_webinar_poll_results(webinar_id, opts = {}) ⇒ InlineResponse20085

List Past Webinar Poll Results The polling feature for webinar allows you to create single choice or multiple choice polling questions for your webinars. Use this API to retrieve the results for Webinar Polls of a specific Webinar. Prerequisites:
* [Webinar license](zoom.us/webinar)
Scopes: ‘webinar:read:admin`, `webinar:read`

Parameters:

  • webinar_id —

    The Webinar ID or Webinar UUID. If the webinar ID is passed, it will take the last webinar instance.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (InlineResponse20085) 


135
136
137
138
 
# File 'lib/zoom_us/webinars.rb', line 135

def list_past_webinar_poll_results(webinar_id, opts = {})
  data, _status_code, _headers = list_past_webinar_poll_results_with_http_info(webinar_id, opts)
  data
end

#list_past_webinar_poll_results_with_http_info(webinar_id, opts = {}) ⇒ Array<(InlineResponse20085, Fixnum, Hash)>

List Past Webinar Poll Results The polling feature for webinar allows you to create single choice or multiple choice polling questions for your webinars. Use this API to retrieve the results for Webinar Polls of a specific Webinar. Prerequisites:&lt;br&gt; * [Webinar license](zoom.us/webinar)&lt;br&gt; Scopes: &#x60;webinar:read:admin&#x60;, &#x60;webinar:read&#x60;&lt;br&gt; &lt;br&gt;

Parameters:

  • webinar_id —

    The Webinar ID or Webinar UUID. If the webinar ID is passed, it will take the last webinar instance.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20085, Fixnum, Hash)>) —

    InlineResponse20085 data, response status code and response headers



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/zoom_us/webinars.rb', line 145

def list_past_webinar_poll_results_with_http_info(webinar_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebinarsApi.list_past_webinar_poll_results ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling WebinarsApi.list_past_webinar_poll_results"
  end
  # resource path
  local_var_path = '/past_webinars/{webinarId}/polls'.sub('{' + 'webinarId' + '}', webinar_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20085')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebinarsApi#list_past_webinar_poll_results\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_past_webinar_qa(webinar_id, opts = {}) ⇒ InlineResponse20086

List Q&A of Past Webinar The [Question & Answer (Q&A)](support.zoom.us/hc/en-us/articles/203686015-Getting-Started-with-Question-Answer) feature for Webinars allows attendees to ask questions during the Webinar and for the panelists, co-hosts and host to answer their questions.
Use this API to list Q&A of a specific Webinar. Prerequisites:
* [Webinar license](zoom.us/webinar)
Scopes: ‘webinar:read:admin`, `webinar:read`

Parameters:

  • webinar_id —

    The Webinar ID or Webinar UUID. If the webinar ID is passed, it will take the last webinar instance.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (InlineResponse20086) 


189
190
191
192
 
# File 'lib/zoom_us/webinars.rb', line 189

def list_past_webinar_qa(webinar_id, opts = {})
  data, _status_code, _headers = list_past_webinar_qa_with_http_info(webinar_id, opts)
  data
end

#list_past_webinar_qa_with_http_info(webinar_id, opts = {}) ⇒ Array<(InlineResponse20086, Fixnum, Hash)>

List Q&amp;A of Past Webinar The [Question &amp; Answer (Q&amp;A)](support.zoom.us/hc/en-us/articles/203686015-Getting-Started-with-Question-Answer) feature for Webinars allows attendees to ask questions during the Webinar and for the panelists, co-hosts and host to answer their questions.&lt;br&gt; Use this API to list Q&amp;A of a specific Webinar. Prerequisites:&lt;br&gt; * [Webinar license](zoom.us/webinar)&lt;br&gt; Scopes: &#x60;webinar:read:admin&#x60;, &#x60;webinar:read&#x60;&lt;br&gt; &lt;br&gt;

Parameters:

  • webinar_id —

    The Webinar ID or Webinar UUID. If the webinar ID is passed, it will take the last webinar instance.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20086, Fixnum, Hash)>) —

    InlineResponse20086 data, response status code and response headers



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/zoom_us/webinars.rb', line 199

def list_past_webinar_qa_with_http_info(webinar_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebinarsApi.list_past_webinar_qa ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling WebinarsApi.list_past_webinar_qa"
  end
  # resource path
  local_var_path = '/past_webinars/{webinarId}/qa'.sub('{' + 'webinarId' + '}', webinar_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20086')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebinarsApi#list_past_webinar_qa\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#past_webinars(webinar_id, opts = {}) ⇒ Object

List Past Webinar Instances List past webinar instances.
Scopes: ‘webinar:read:admin` `webinar:read`

Parameters:

  • webinar_id —

    The webinar ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


243
244
245
246
 
# File 'lib/zoom_us/webinars.rb', line 243

def past_webinars(webinar_id, opts = {})
  data, _status_code, _headers = past_webinars_with_http_info(webinar_id, opts)
  data
end

#past_webinars_with_http_info(webinar_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

List Past Webinar Instances List past webinar instances.&lt;br&gt;&lt;br&gt; Scopes: &#x60;webinar:read:admin&#x60; &#x60;webinar:read&#x60;&lt;br&gt; &lt;br&gt;

Parameters:

  • webinar_id —

    The webinar ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Fixnum, Hash)>) —

    Object data, response status code and response headers



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/zoom_us/webinars.rb', line 253

def past_webinars_with_http_info(webinar_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebinarsApi.past_webinars ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling WebinarsApi.past_webinars"
  end
  # resource path
  local_var_path = '/past_webinars/{webinarId}/instances'.sub('{' + 'webinarId' + '}', webinar_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebinarsApi#past_webinars\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webinar(webinar_id, opts = {}) ⇒ InlineResponse20054

Get a Webinar Zoom users with a [Webinar Plan](zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.
Use this API to get details of a scheduled webinar.
Scopes: ‘webinar:read:admin` `webinar:read`

Prerequisites: * Pro or higher plan with a Webinar Add-on.

Parameters:

  • webinar_id —

    The webinar ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (InlineResponse20054) 


298
299
300
301
 
# File 'lib/zoom_us/webinars.rb', line 298

def webinar(webinar_id, opts = {})
  data, _status_code, _headers = webinar_with_http_info(webinar_id, opts)
  data
end

#webinar_absentees(webinar_uuid, opts = {}) ⇒ RegistrationList

Get Webinar Absentees List absentees of a webinar.
Scopes: ‘webinar:read:admin` `webinar:read`

Parameters:

  • webinar_uuid —

    The webinar UUID. Please double encode your UUID when using it for API calls if the UUID begins with a &#39;/&#39;or contains &#39;//&#39; in it.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :occurrence_id (String) —

    The meeting occurrence ID.

  • :page_size (Integer) —

    The number of records returned within a single API call. (default to 30)

  • :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.

Returns:

  • (RegistrationList) 


357
358
359
360
 
# File 'lib/zoom_us/webinars.rb', line 357

def webinar_absentees(webinar_uuid, opts = {})
  data, _status_code, _headers = webinar_absentees_with_http_info(webinar_uuid, opts)
  data
end

#webinar_absentees_with_http_info(webinar_uuid, opts = {}) ⇒ Array<(RegistrationList, Fixnum, Hash)>

Get Webinar Absentees List absentees of a webinar.&lt;br&gt;&lt;br&gt; Scopes: &#x60;webinar:read:admin&#x60; &#x60;webinar:read&#x60;&lt;br&gt;

Parameters:

  • webinar_uuid —

    The webinar UUID. Please double encode your UUID when using it for API calls if the UUID begins with a &#39;/&#39;or contains &#39;//&#39; in it.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :occurrence_id (String) —

    The meeting occurrence ID.

  • :page_size (Integer) —

    The number of records returned within a single API call.

  • :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.

Returns:

  • (Array<(RegistrationList, Fixnum, Hash)>) —

    RegistrationList data, response status code and response headers



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/zoom_us/webinars.rb', line 370

def webinar_absentees_with_http_info(webinar_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebinarsApi.webinar_absentees ...'
  end
  # verify the required parameter 'webinar_uuid' is set
  if @api_client.config.client_side_validation && webinar_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_uuid' when calling WebinarsApi.webinar_absentees"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 300
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling WebinarsApi.webinar_absentees, must be smaller than or equal to 300.'
  end

  # resource path
  local_var_path = '/past_webinars/{WebinarUUID}/absentees'.sub('{' + 'WebinarUUID' + '}', webinar_uuid.to_s)

  # query parameters
  query_params = {}
  query_params[:'occurrence_id'] = opts[:'occurrence_id'] if !opts[:'occurrence_id'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page_token'] = opts[:'next_page_token'] if !opts[:'next_page_token'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RegistrationList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebinarsApi#webinar_absentees\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webinar_create(user_id, body, opts = {}) ⇒ InlineResponse20118

Create a Webinar Zoom users with a [Webinar Plan](zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.
Use this API to schedule a Webinar for a user (host).
Scopes: ‘webinar:write:admin` `webinar:write`

Prerequisites: * Pro or higher plan with a Webinar Add-on.

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (InlineResponse20118) 


422
423
424
425
 
# File 'lib/zoom_us/webinars.rb', line 422

def webinar_create(user_id, body, opts = {})
  data, _status_code, _headers = webinar_create_with_http_info(user_id, body, opts)
  data
end

#webinar_create_with_http_info(user_id, body, opts = {}) ⇒ Array<(InlineResponse20118, Fixnum, Hash)>

Create a Webinar Zoom users with a [Webinar Plan](zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.&lt;br&gt;Use this API to schedule a Webinar for a user (host).&lt;br&gt;&lt;br&gt; Scopes: &#x60;webinar:write:admin&#x60; &#x60;webinar:write&#x60;&lt;br&gt; &lt;br&gt; Prerequisites: * Pro or higher plan with a Webinar Add-on.

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20118, Fixnum, Hash)>) —

    InlineResponse20118 data, response status code and response headers



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/zoom_us/webinars.rb', line 433

def webinar_create_with_http_info(user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebinarsApi.webinar_create ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling WebinarsApi.webinar_create"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling WebinarsApi.webinar_create"
  end
  # resource path
  local_var_path = '/users/{userId}/webinars'.sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20118')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebinarsApi#webinar_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webinar_delete(webinar_id, opts = {}) ⇒ nil

Delete a Webinar Delete a Webinar.
Scopes: ‘webinar:write:admin` `webinar:write`

Prerequisites:
* Pro or higher plan with a Webinar Add-on.

Parameters:

  • webinar_id —

    The webinar ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :occurrence_id (String) —

    The meeting occurrence ID.

Returns:

  • (nil) 


482
483
484
485
 
# File 'lib/zoom_us/webinars.rb', line 482

def webinar_delete(webinar_id, opts = {})
  webinar_delete_with_http_info(webinar_id, opts)
  nil
end

#webinar_delete_with_http_info(webinar_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a Webinar Delete a Webinar.&lt;br&gt;&lt;br&gt; Scopes: &#x60;webinar:write:admin&#x60; &#x60;webinar:write&#x60;&lt;br&gt; &lt;br&gt; Prerequisites:&lt;br&gt; * Pro or higher plan with a Webinar Add-on.

Parameters:

  • webinar_id —

    The webinar ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :occurrence_id (String) —

    The meeting occurrence ID.

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'lib/zoom_us/webinars.rb', line 493

def webinar_delete_with_http_info(webinar_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebinarsApi.webinar_delete ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling WebinarsApi.webinar_delete"
  end
  # resource path
  local_var_path = '/webinars/{webinarId}'.sub('{' + 'webinarId' + '}', webinar_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'occurrence_id'] = opts[:'occurrence_id'] if !opts[:'occurrence_id'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebinarsApi#webinar_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webinar_panelist_create(webinar_id, body, opts = {}) ⇒ nil

Add Panelists Panelists in a Webinar can view and send video, screen share, annotate, etc and do much more compared to attendees in a webinar.
Use this API to [add panelists](support.zoom.us/hc/en-us/articles/115005657826-Inviting-Panelists-to-a-Webinar#h_7550d59e-23f5-4703-9e22-e76bded1ed70) to a scheduled webinar.
Scopes: ‘webinar:write:admin` `webinar:write`

Prerequisites: * Pro or a higher plan with [Webinar Add-on](zoom.us/webinar).

Parameters:

  • webinar_id —

    The webinar ID.

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


538
539
540
541
 
# File 'lib/zoom_us/webinars.rb', line 538

def webinar_panelist_create(webinar_id, body, opts = {})
  webinar_panelist_create_with_http_info(webinar_id, body, opts)
  nil
end

#webinar_panelist_create_with_http_info(webinar_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Add Panelists Panelists in a Webinar can view and send video, screen share, annotate, etc and do much more compared to attendees in a webinar.&lt;br&gt;Use this API to [add panelists](support.zoom.us/hc/en-us/articles/115005657826-Inviting-Panelists-to-a-Webinar#h_7550d59e-23f5-4703-9e22-e76bded1ed70) to a scheduled webinar.&lt;br&gt;&lt;br&gt; Scopes: &#x60;webinar:write:admin&#x60; &#x60;webinar:write&#x60;&lt;br&gt; &lt;br&gt; Prerequisites: * Pro or a higher plan with [Webinar Add-on](zoom.us/webinar).&lt;br&gt;

Parameters:

  • webinar_id —

    The webinar ID.

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
 
# File 'lib/zoom_us/webinars.rb', line 549

def webinar_panelist_create_with_http_info(webinar_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebinarsApi.webinar_panelist_create ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling WebinarsApi.webinar_panelist_create"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling WebinarsApi.webinar_panelist_create"
  end
  # resource path
  local_var_path = '/webinars/{webinarId}/panelists'.sub('{' + 'webinarId' + '}', webinar_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebinarsApi#webinar_panelist_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webinar_panelist_delete(webinar_id, panelist_id, opts = {}) ⇒ nil

Remove a Panelist [Remove](support.zoom.us/hc/en-us/articles/115005657826-Inviting-Panelists-to-a-Webinar#h_de31f237-a91c-4fb2-912b-ecfba8ec5ffb) a single panelist from a webinar.
You can retrieve the ‘panelistId` by calling **List Panelists API**.
Scopes: `webinar:write:admin` `webinar:write`

Prerequisites:
* Pro or a higher plan with [Webinar Add-on](zoom.us/webinar).

Parameters:

  • webinar_id —

    The webinar ID.

  • panelist_id —

    The panelist ID or panelist email.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


597
598
599
600
 
# File 'lib/zoom_us/webinars.rb', line 597

def webinar_panelist_delete(webinar_id, panelist_id, opts = {})
  webinar_panelist_delete_with_http_info(webinar_id, panelist_id, opts)
  nil
end

#webinar_panelist_delete_with_http_info(webinar_id, panelist_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Remove a Panelist [Remove](support.zoom.us/hc/en-us/articles/115005657826-Inviting-Panelists-to-a-Webinar#h_de31f237-a91c-4fb2-912b-ecfba8ec5ffb) a single panelist from a webinar.&lt;br&gt; You can retrieve the &#x60;panelistId&#x60; by calling **List Panelists API**.&lt;br&gt;&lt;br&gt; Scopes: &#x60;webinar:write:admin&#x60; &#x60;webinar:write&#x60;&lt;br&gt; &lt;br&gt; Prerequisites:&lt;br&gt; * Pro or a higher plan with [Webinar Add-on](zoom.us/webinar).&lt;br&gt;

Parameters:

  • webinar_id —

    The webinar ID.

  • panelist_id —

    The panelist ID or panelist email.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
 
# File 'lib/zoom_us/webinars.rb', line 608

def webinar_panelist_delete_with_http_info(webinar_id, panelist_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebinarsApi.webinar_panelist_delete ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling WebinarsApi.webinar_panelist_delete"
  end
  # verify the required parameter 'panelist_id' is set
  if @api_client.config.client_side_validation && panelist_id.nil?
    fail ArgumentError, "Missing the required parameter 'panelist_id' when calling WebinarsApi.webinar_panelist_delete"
  end
  # resource path
  local_var_path = '/webinars/{webinarId}/panelists/{panelistId}'.sub('{' + 'webinarId' + '}', webinar_id.to_s).sub('{' + 'panelistId' + '}', panelist_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebinarsApi#webinar_panelist_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webinar_panelists(webinar_id, opts = {}) ⇒ InlineResponse20055

List Panelists Panelists in a Webinar can view and send video, screen share, annotate, etc and do much more compared to attendees in a Webinar. Use this API to list all the panelists of a Webinar.
Scopes: ‘webinar:read:admin` `webinar:read`

Prerequisites:
* Pro or a higher plan with [Webinar Add-on](zoom.us/webinar).

Parameters:

  • webinar_id —

    The webinar ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (InlineResponse20055) 


655
656
657
658
 
# File 'lib/zoom_us/webinars.rb', line 655

def webinar_panelists(webinar_id, opts = {})
  data, _status_code, _headers = webinar_panelists_with_http_info(webinar_id, opts)
  data
end

#webinar_panelists_delete(webinar_id, opts = {}) ⇒ nil

Remove Panelists Remove all the panelists from a Webinar.
Scopes: ‘webinar:write:admin` `webinar:write`

Prerequisites:
* Pro or a higher plan with [Webinar Add-on](zoom.us/webinar).

Parameters:

  • webinar_id —

    The webinar ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


709
710
711
712
 
# File 'lib/zoom_us/webinars.rb', line 709

def webinar_panelists_delete(webinar_id, opts = {})
  webinar_panelists_delete_with_http_info(webinar_id, opts)
  nil
end

#webinar_panelists_delete_with_http_info(webinar_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Remove Panelists Remove all the panelists from a Webinar.&lt;br&gt; Scopes: &#x60;webinar:write:admin&#x60; &#x60;webinar:write&#x60;&lt;br&gt; &lt;br&gt; Prerequisites:&lt;br&gt; * Pro or a higher plan with [Webinar Add-on](zoom.us/webinar).&lt;br&gt;

Parameters:

  • webinar_id —

    The webinar ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
 
# File 'lib/zoom_us/webinars.rb', line 719

def webinar_panelists_delete_with_http_info(webinar_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebinarsApi.webinar_panelists_delete ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling WebinarsApi.webinar_panelists_delete"
  end
  # resource path
  local_var_path = '/webinars/{webinarId}/panelists'.sub('{' + 'webinarId' + '}', webinar_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebinarsApi#webinar_panelists_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webinar_panelists_with_http_info(webinar_id, opts = {}) ⇒ Array<(InlineResponse20055, Fixnum, Hash)>

List Panelists Panelists in a Webinar can view and send video, screen share, annotate, etc and do much more compared to attendees in a Webinar. Use this API to list all the panelists of a Webinar.&lt;br&gt;&lt;br&gt; Scopes: &#x60;webinar:read:admin&#x60; &#x60;webinar:read&#x60;&lt;br&gt; &lt;br&gt; Prerequisites:&lt;br&gt; * Pro or a higher plan with [Webinar Add-on](zoom.us/webinar).&lt;br&gt;

Parameters:

  • webinar_id —

    The webinar ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20055, Fixnum, Hash)>) —

    InlineResponse20055 data, response status code and response headers



665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
 
# File 'lib/zoom_us/webinars.rb', line 665

def webinar_panelists_with_http_info(webinar_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebinarsApi.webinar_panelists ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling WebinarsApi.webinar_panelists"
  end
  # resource path
  local_var_path = '/webinars/{webinarId}/panelists'.sub('{' + 'webinarId' + '}', webinar_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20055')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebinarsApi#webinar_panelists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webinar_poll_create(webinar_id, body, opts = {}) ⇒ InlineResponse20121

Create a Webinar’s Poll Create a [poll](support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) for a webinar.
Scopes: ‘webinar:write:admin` `webinar:write`

Parameters:

  • webinar_id —

    The webinar ID.

  • body —

    Webinar poll object

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (InlineResponse20121) 


763
764
765
766
 
# File 'lib/zoom_us/webinars.rb', line 763

def webinar_poll_create(webinar_id, body, opts = {})
  data, _status_code, _headers = webinar_poll_create_with_http_info(webinar_id, body, opts)
  data
end

#webinar_poll_create_with_http_info(webinar_id, body, opts = {}) ⇒ Array<(InlineResponse20121, Fixnum, Hash)>

Create a Webinar&#39;s Poll Create a [poll](support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) for a webinar.&lt;br&gt;&lt;br&gt; Scopes: &#x60;webinar:write:admin&#x60; &#x60;webinar:write&#x60;&lt;br&gt; &lt;br&gt;

Parameters:

  • webinar_id —

    The webinar ID.

  • body —

    Webinar poll object

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20121, Fixnum, Hash)>) —

    InlineResponse20121 data, response status code and response headers



774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'lib/zoom_us/webinars.rb', line 774

def webinar_poll_create_with_http_info(webinar_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebinarsApi.webinar_poll_create ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling WebinarsApi.webinar_poll_create"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling WebinarsApi.webinar_poll_create"
  end
  # resource path
  local_var_path = '/webinars/{webinarId}/polls'.sub('{' + 'webinarId' + '}', webinar_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20121')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebinarsApi#webinar_poll_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webinar_poll_delete(webinar_id, poll_id, opts = {}) ⇒ nil

Delete a Webinar Poll Delete a webinar’s [poll](support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars).
Scopes: ‘webinar:write:admin` `webinar:write`

Parameters:

  • webinar_id —

    The webinar ID.

  • poll_id —

    The poll ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


823
824
825
826
 
# File 'lib/zoom_us/webinars.rb', line 823

def webinar_poll_delete(webinar_id, poll_id, opts = {})
  webinar_poll_delete_with_http_info(webinar_id, poll_id, opts)
  nil
end

#webinar_poll_delete_with_http_info(webinar_id, poll_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a Webinar Poll Delete a webinar&#39;s [poll](support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars).&lt;br&gt;&lt;br&gt; Scopes: &#x60;webinar:write:admin&#x60; &#x60;webinar:write&#x60;&lt;br&gt; &lt;br&gt;

Parameters:

  • webinar_id —

    The webinar ID.

  • poll_id —

    The poll ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
 
# File 'lib/zoom_us/webinars.rb', line 834

def webinar_poll_delete_with_http_info(webinar_id, poll_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebinarsApi.webinar_poll_delete ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling WebinarsApi.webinar_poll_delete"
  end
  # verify the required parameter 'poll_id' is set
  if @api_client.config.client_side_validation && poll_id.nil?
    fail ArgumentError, "Missing the required parameter 'poll_id' when calling WebinarsApi.webinar_poll_delete"
  end
  # resource path
  local_var_path = '/webinars/{webinarId}/polls/{pollId}'.sub('{' + 'webinarId' + '}', webinar_id.to_s).sub('{' + 'pollId' + '}', poll_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebinarsApi#webinar_poll_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webinar_poll_get(webinar_id, poll_id, opts = {}) ⇒ InlineResponse20121

Get a Webinar Poll Get a webinar’s [poll](support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) details.
Scopes: ‘webinar:read:admin` `webinar:read`

Parameters:

  • webinar_id —

    The webinar ID.

  • poll_id —

    The poll ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (InlineResponse20121) 


882
883
884
885
 
# File 'lib/zoom_us/webinars.rb', line 882

def webinar_poll_get(webinar_id, poll_id, opts = {})
  data, _status_code, _headers = webinar_poll_get_with_http_info(webinar_id, poll_id, opts)
  data
end

#webinar_poll_get_with_http_info(webinar_id, poll_id, opts = {}) ⇒ Array<(InlineResponse20121, Fixnum, Hash)>

Get a Webinar Poll Get a webinar&#39;s [poll](support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) details.&lt;br&gt;&lt;br&gt; Scopes: &#x60;webinar:read:admin&#x60; &#x60;webinar:read&#x60;&lt;br&gt; &lt;br&gt;

Parameters:

  • webinar_id —

    The webinar ID.

  • poll_id —

    The poll ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20121, Fixnum, Hash)>) —

    InlineResponse20121 data, response status code and response headers



893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
 
# File 'lib/zoom_us/webinars.rb', line 893

def webinar_poll_get_with_http_info(webinar_id, poll_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebinarsApi.webinar_poll_get ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling WebinarsApi.webinar_poll_get"
  end
  # verify the required parameter 'poll_id' is set
  if @api_client.config.client_side_validation && poll_id.nil?
    fail ArgumentError, "Missing the required parameter 'poll_id' when calling WebinarsApi.webinar_poll_get"
  end
  # resource path
  local_var_path = '/webinars/{webinarId}/polls/{pollId}'.sub('{' + 'webinarId' + '}', webinar_id.to_s).sub('{' + 'pollId' + '}', poll_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20121')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebinarsApi#webinar_poll_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webinar_poll_update(webinar_id, poll_id, body, opts = {}) ⇒ nil

Update a Webinar Poll Update a webinar’s [poll](support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars).
Scopes: ‘webinar:write:admin` `webinar:write`

Parameters:

  • webinar_id —

    The webinar ID.

  • poll_id —

    The poll ID

  • body —

    Webinar Poll

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


943
944
945
946
 
# File 'lib/zoom_us/webinars.rb', line 943

def webinar_poll_update(webinar_id, poll_id, body, opts = {})
  webinar_poll_update_with_http_info(webinar_id, poll_id, body, opts)
  nil
end

#webinar_poll_update_with_http_info(webinar_id, poll_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update a Webinar Poll Update a webinar&#39;s [poll](support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars).&lt;br&gt;&lt;br&gt; Scopes: &#x60;webinar:write:admin&#x60; &#x60;webinar:write&#x60;&lt;br&gt; &lt;br&gt;

Parameters:

  • webinar_id —

    The webinar ID.

  • poll_id —

    The poll ID

  • body —

    Webinar Poll

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'lib/zoom_us/webinars.rb', line 955

def webinar_poll_update_with_http_info(webinar_id, poll_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebinarsApi.webinar_poll_update ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling WebinarsApi.webinar_poll_update"
  end
  # verify the required parameter 'poll_id' is set
  if @api_client.config.client_side_validation && poll_id.nil?
    fail ArgumentError, "Missing the required parameter 'poll_id' when calling WebinarsApi.webinar_poll_update"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling WebinarsApi.webinar_poll_update"
  end
  # resource path
  local_var_path = '/webinars/{webinarId}/polls/{pollId}'.sub('{' + 'webinarId' + '}', webinar_id.to_s).sub('{' + 'pollId' + '}', poll_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebinarsApi#webinar_poll_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webinar_polls(webinar_id, opts = {}) ⇒ Object

List a Webinar’s Polls List all the [polls](support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) of a Webinar.
Scopes: ‘webinar:read:admin` `webinar:read`

Parameters:

  • webinar_id —

    The webinar ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


1006
1007
1008
1009
 
# File 'lib/zoom_us/webinars.rb', line 1006

def webinar_polls(webinar_id, opts = {})
  data, _status_code, _headers = webinar_polls_with_http_info(webinar_id, opts)
  data
end

#webinar_polls_with_http_info(webinar_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

List a Webinar&#39;s Polls List all the [polls](support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) of a Webinar.&lt;br&gt;&lt;br&gt; Scopes: &#x60;webinar:read:admin&#x60; &#x60;webinar:read&#x60;&lt;br&gt; &lt;br&gt;

Parameters:

  • webinar_id —

    The webinar ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Fixnum, Hash)>) —

    Object data, response status code and response headers



1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
 
# File 'lib/zoom_us/webinars.rb', line 1016

def webinar_polls_with_http_info(webinar_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebinarsApi.webinar_polls ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling WebinarsApi.webinar_polls"
  end
  # resource path
  local_var_path = '/webinars/{webinarId}/polls'.sub('{' + 'webinarId' + '}', webinar_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebinarsApi#webinar_polls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webinar_registrant_create(webinar_id, body, opts = {}) ⇒ InlineResponse20120

Add a Webinar Registrant Zoom users with a [Webinar Plan](zoom.us/webinar) 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](support.zoom.us/hc/en-us/articles/204619915-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 create and submit the registration of a user for a webinar.
Scopes: ‘webinar:write:admin` `webinar:write`

Prerequisites: * Pro or higher plan with a Webinar Add-on.

Parameters:

  • webinar_id —

    The webinar ID.

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :occurrence_ids (String) —

    Occurrence ID. Get this value from the webinar get API. Multiple values separated by a comma.

Returns:

  • (InlineResponse20120) 


1062
1063
1064
1065
 
# File 'lib/zoom_us/webinars.rb', line 1062

def webinar_registrant_create(webinar_id, body, opts = {})
  data, _status_code, _headers = webinar_registrant_create_with_http_info(webinar_id, body, opts)
  data
end

#webinar_registrant_create_with_http_info(webinar_id, body, opts = {}) ⇒ Array<(InlineResponse20120, Fixnum, Hash)>

Add a Webinar Registrant Zoom users with a [Webinar Plan](zoom.us/webinar) 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](support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form before receiving the link to join the Webinar.&lt;br&gt;Use this API to create and submit the registration of a user for a webinar.&lt;br&gt;&lt;br&gt; Scopes: &#x60;webinar:write:admin&#x60; &#x60;webinar:write&#x60;&lt;br&gt; &lt;br&gt; Prerequisites: * Pro or higher plan with a Webinar Add-on.

Parameters:

  • webinar_id —

    The webinar ID.

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :occurrence_ids (String) —

    Occurrence ID. Get this value from the webinar get API. Multiple values separated by a comma.

Returns:

  • (Array<(InlineResponse20120, Fixnum, Hash)>) —

    InlineResponse20120 data, response status code and response headers



1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
 
# File 'lib/zoom_us/webinars.rb', line 1074

def webinar_registrant_create_with_http_info(webinar_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebinarsApi.webinar_registrant_create ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling WebinarsApi.webinar_registrant_create"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling WebinarsApi.webinar_registrant_create"
  end
  # resource path
  local_var_path = '/webinars/{webinarId}/registrants'.sub('{' + 'webinarId' + '}', webinar_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'occurrence_ids'] = opts[:'occurrence_ids'] if !opts[:'occurrence_ids'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20120')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebinarsApi#webinar_registrant_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webinar_registrant_get(webinar_id, registrant_id, opts = {}) ⇒ WebianrRegistrant

Get a Webinar Registrant Zoom users with a [Webinar Plan](zoom.us/webinar) 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](support.zoom.us/hc/en-us/articles/204619915-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 get details on a specific user who has registered for the Webinar.
Scopes: ‘webinar:read:admin` `webinar:read`

Prerequisites:
* The account must have a Webinar plan.

Parameters:

  • webinar_id —

    The webinar ID.

  • registrant_id —

    The registrant ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :occurrence_id (String) —

    The meeting occurrence ID.

Returns:

  • (WebianrRegistrant) 


1125
1126
1127
1128
 
# File 'lib/zoom_us/webinars.rb', line 1125

def webinar_registrant_get(webinar_id, registrant_id, opts = {})
  data, _status_code, _headers = webinar_registrant_get_with_http_info(webinar_id, registrant_id, opts)
  data
end

#webinar_registrant_get_with_http_info(webinar_id, registrant_id, opts = {}) ⇒ Array<(WebianrRegistrant, Fixnum, Hash)>

Get a Webinar Registrant Zoom users with a [Webinar Plan](zoom.us/webinar) 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](support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form before receiving the link to join the Webinar.&lt;br&gt;Use this API to get details on a specific user who has registered for the Webinar.&lt;br&gt;&lt;br&gt; Scopes: &#x60;webinar:read:admin&#x60; &#x60;webinar:read&#x60;&lt;br&gt; &lt;br&gt; Prerequisites:&lt;br&gt; * The account must have a Webinar plan.

Parameters:

  • webinar_id —

    The webinar ID.

  • registrant_id —

    The registrant ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :occurrence_id (String) —

    The meeting occurrence ID.

Returns:

  • (Array<(WebianrRegistrant, Fixnum, Hash)>) —

    WebianrRegistrant data, response status code and response headers



1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
 
# File 'lib/zoom_us/webinars.rb', line 1137

def webinar_registrant_get_with_http_info(webinar_id, registrant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebinarsApi.webinar_registrant_get ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling WebinarsApi.webinar_registrant_get"
  end
  # verify the required parameter 'registrant_id' is set
  if @api_client.config.client_side_validation && registrant_id.nil?
    fail ArgumentError, "Missing the required parameter 'registrant_id' when calling WebinarsApi.webinar_registrant_get"
  end
  # resource path
  local_var_path = '/webinars/{webinarId}/registrants/{registrantId}'.sub('{' + 'webinarId' + '}', webinar_id.to_s).sub('{' + 'registrantId' + '}', registrant_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'occurrence_id'] = opts[:'occurrence_id'] if !opts[:'occurrence_id'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WebianrRegistrant')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebinarsApi#webinar_registrant_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webinar_registrant_question_update(webinar_id, body, opts = {}) ⇒ nil

Update Registration Questions Scheduling a [Webinar with registration](support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form with fields and questions before they can receive the link to join the Webinar.
Use this API to update registration questions and fields of a scheduled Webinar that are to be answered by users while registering for a Webinar.
Prerequisites:
* Pro or higher plan with a Webinar Add-on. * Registration option for Webinar should be set as required to use this API. Scopes: ‘webinar:write:admin` `webinar:write`

Parameters:

  • webinar_id —

    The webinar ID.

  • body —

    Webinar Registrant Questions

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1187
1188
1189
1190
 
# File 'lib/zoom_us/webinars.rb', line 1187

def webinar_registrant_question_update(webinar_id, body, opts = {})
  webinar_registrant_question_update_with_http_info(webinar_id, body, opts)
  nil
end

#webinar_registrant_question_update_with_http_info(webinar_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update Registration Questions Scheduling a [Webinar with registration](support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form with fields and questions before they can receive the link to join the Webinar.&lt;br&gt;Use this API to update registration questions and fields of a scheduled Webinar that are to be answered by users while registering for a Webinar.&lt;br&gt;&lt;br&gt; Prerequisites:&lt;br&gt; * Pro or higher plan with a Webinar Add-on. * Registration option for Webinar should be set as required to use this API. Scopes: &#x60;webinar:write:admin&#x60; &#x60;webinar:write&#x60;&lt;br&gt;

Parameters:

  • webinar_id —

    The webinar ID.

  • body —

    Webinar Registrant Questions

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
 
# File 'lib/zoom_us/webinars.rb', line 1198

def webinar_registrant_question_update_with_http_info(webinar_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebinarsApi.webinar_registrant_question_update ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling WebinarsApi.webinar_registrant_question_update"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling WebinarsApi.webinar_registrant_question_update"
  end
  # resource path
  local_var_path = '/webinars/{webinarId}/registrants/questions'.sub('{' + 'webinarId' + '}', webinar_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebinarsApi#webinar_registrant_question_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webinar_registrant_status(webinar_id, body, opts = {}) ⇒ nil

Update Webinar Registrant Status Update a webinar registrant’s status.
Scopes: ‘webinar:write:admin` `webinar:write`

Parameters:

  • webinar_id —

    The webinar ID.

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :occurrence_id (String) —

    The meeting occurrence ID.

Returns:

  • (nil) 


1247
1248
1249
1250
 
# File 'lib/zoom_us/webinars.rb', line 1247

def webinar_registrant_status(webinar_id, body, opts = {})
  webinar_registrant_status_with_http_info(webinar_id, body, opts)
  nil
end

#webinar_registrant_status_with_http_info(webinar_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update Webinar Registrant Status Update a webinar registrant&#39;s status.&lt;br&gt;&lt;br&gt; Scopes: &#x60;webinar:write:admin&#x60; &#x60;webinar:write&#x60;&lt;br&gt; &lt;br&gt;

Parameters:

  • webinar_id —

    The webinar ID.

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :occurrence_id (String) —

    The meeting occurrence ID.

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
 
# File 'lib/zoom_us/webinars.rb', line 1259

def webinar_registrant_status_with_http_info(webinar_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebinarsApi.webinar_registrant_status ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling WebinarsApi.webinar_registrant_status"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling WebinarsApi.webinar_registrant_status"
  end
  # resource path
  local_var_path = '/webinars/{webinarId}/registrants/status'.sub('{' + 'webinarId' + '}', webinar_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'occurrence_id'] = opts[:'occurrence_id'] if !opts[:'occurrence_id'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebinarsApi#webinar_registrant_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webinar_registrants(webinar_id, opts = {}) ⇒ RegistrationList

List Webinar Registrants Zoom users with a [Webinar Plan](zoom.us/webinar) 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](support.zoom.us/hc/en-us/articles/204619915-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`

Parameters:

  • webinar_id —

    The webinar ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :occurrence_id (String) —

    The meeting occurrence ID.

  • :status (String) —

    The registrant status:&lt;br&gt;&#x60;pending&#x60; - Registrant&#39;s status is pending.&lt;br&gt;&#x60;approved&#x60; - Registrant&#39;s status is approved.&lt;br&gt;&#x60;denied&#x60; - Registrant&#39;s status is denied. (default to approved)

  • :page_size (Integer) —

    The number of records returned within a single API call. (default to 30)

  • :page_number (Integer) —

    The current page number of returned records. (default to 1)

Returns:

  • (RegistrationList) 


1311
1312
1313
1314
 
# File 'lib/zoom_us/webinars.rb', line 1311

def webinar_registrants(webinar_id, opts = {})
  data, _status_code, _headers = webinar_registrants_with_http_info(webinar_id, opts)
  data
end

#webinar_registrants_questions_get(webinar_id, opts = {}) ⇒ InlineResponse20056

List Registration Questions Scheduling a [Webinar with registration](support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form with fields and questions before they can receive the link to join the Webinar.
Use this API to list registration questions and fields that are to be answered by users while registering for a Webinar.
Prerequisites:
* Pro or higher plan with a Webinar Add-on. Scopes: ‘webinar:read:admin` `webinar:read`

Parameters:

  • webinar_id —

    The webinar ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (InlineResponse20056) 


1380
1381
1382
1383
 
# File 'lib/zoom_us/webinars.rb', line 1380

def webinar_registrants_questions_get(webinar_id, opts = {})
  data, _status_code, _headers = webinar_registrants_questions_get_with_http_info(webinar_id, opts)
  data
end

#webinar_registrants_questions_get_with_http_info(webinar_id, opts = {}) ⇒ Array<(InlineResponse20056, Fixnum, Hash)>

List Registration Questions Scheduling a [Webinar with registration](support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form with fields and questions before they can receive the link to join the Webinar.&lt;br&gt;Use this API to list registration questions and fields that are to be answered by users while registering for a Webinar.&lt;br&gt; Prerequisites:&lt;br&gt; * Pro or higher plan with a Webinar Add-on. Scopes: &#x60;webinar:read:admin&#x60; &#x60;webinar:read&#x60;&lt;br&gt; &lt;br&gt;

Parameters:

  • webinar_id —

    The webinar ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20056, Fixnum, Hash)>) —

    InlineResponse20056 data, response status code and response headers



1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
 
# File 'lib/zoom_us/webinars.rb', line 1390

def webinar_registrants_questions_get_with_http_info(webinar_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebinarsApi.webinar_registrants_questions_get ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling WebinarsApi.webinar_registrants_questions_get"
  end
  # resource path
  local_var_path = '/webinars/{webinarId}/registrants/questions'.sub('{' + 'webinarId' + '}', webinar_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20056')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebinarsApi#webinar_registrants_questions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webinar_registrants_with_http_info(webinar_id, opts = {}) ⇒ Array<(RegistrationList, Fixnum, Hash)>

List Webinar Registrants Zoom users with a [Webinar Plan](zoom.us/webinar) 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](support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form before receiving the link to join the Webinar.&lt;br&gt; Use this API to list all the users that have registered for a webinar.&lt;br&gt;&lt;br&gt; Prerequisites: * Pro or higher plan with a Webinar Add-on.&lt;br&gt; Scopes: &#x60;webinar:read:admin&#x60; &#x60;webinar:read&#x60;&lt;br&gt; &lt;br&gt;

Parameters:

  • webinar_id —

    The webinar ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :occurrence_id (String) —

    The meeting occurrence ID.

  • :status (String) —

    The registrant status:&lt;br&gt;&#x60;pending&#x60; - Registrant&#39;s status is pending.&lt;br&gt;&#x60;approved&#x60; - Registrant&#39;s status is approved.&lt;br&gt;&#x60;denied&#x60; - Registrant&#39;s status is denied.

  • :page_size (Integer) —

    The number of records returned within a single API call.

  • :page_number (Integer) —

    The current page number of returned records.

Returns:

  • (Array<(RegistrationList, Fixnum, Hash)>) —

    RegistrationList data, response status code and response headers



1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
 
# File 'lib/zoom_us/webinars.rb', line 1325

def webinar_registrants_with_http_info(webinar_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebinarsApi.webinar_registrants ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling WebinarsApi.webinar_registrants"
  end
  if @api_client.config.client_side_validation && opts[:'status'] && !['pending', 'approved', 'denied'].include?(opts[:'status'])
    fail ArgumentError, 'invalid value for "status", must be one of pending, approved, denied'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 300
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling WebinarsApi.webinar_registrants, must be smaller than or equal to 300.'
  end

  # resource path
  local_var_path = '/webinars/{webinarId}/registrants'.sub('{' + 'webinarId' + '}', webinar_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'occurrence_id'] = opts[:'occurrence_id'] if !opts[:'occurrence_id'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page_number'] = opts[:'page_number'] if !opts[:'page_number'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RegistrationList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebinarsApi#webinar_registrants\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webinar_status(webinar_id, body, opts = {}) ⇒ nil

Update Webinar Status Update a webinar’s status. Use this API to end an ongoing webinar.
Scopes: ‘webinar:write:admin` `webinar:write`

Prerequisites:
* The account must hold a valid [Webinar plan](zoom.us/webinar).

Parameters:

  • webinar_id —

    The webinar ID.

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1435
1436
1437
1438
 
# File 'lib/zoom_us/webinars.rb', line 1435

def webinar_status(webinar_id, body, opts = {})
  webinar_status_with_http_info(webinar_id, body, opts)
  nil
end

#webinar_status_with_http_info(webinar_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update Webinar Status Update a webinar&#39;s status. Use this API to end an ongoing webinar.&lt;br&gt;&lt;br&gt; Scopes: &#x60;webinar:write:admin&#x60; &#x60;webinar:write&#x60;&lt;br&gt; &lt;br&gt; Prerequisites:&lt;br&gt; * The account must hold a valid [Webinar plan](zoom.us/webinar).

Parameters:

  • webinar_id —

    The webinar ID.

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
 
# File 'lib/zoom_us/webinars.rb', line 1446

def webinar_status_with_http_info(webinar_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebinarsApi.webinar_status ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling WebinarsApi.webinar_status"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling WebinarsApi.webinar_status"
  end
  # resource path
  local_var_path = '/webinars/{webinarId}/status'.sub('{' + 'webinarId' + '}', webinar_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebinarsApi#webinar_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webinar_update(webinar_id, body, opts = {}) ⇒ nil

Update a Webinar Zoom users with a [Webinar Plan](zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.
Use this API to make updates to a scheduled Webinar.
Scopes: ‘webinar:write:admin` `webinar:write`

Prerequisites:
* Pro or higher plan with a Webinar Add-on.

Parameters:

  • webinar_id —

    The webinar ID.

  • body —

    Webinar.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :occurrence_id (String) —

    Webinar occurrence id. Support change of agenda, start_time, duration, settings: panelist_video, hd_video, watermark, auto_recording

Returns:

  • (nil) 


1495
1496
1497
1498
 
# File 'lib/zoom_us/webinars.rb', line 1495

def webinar_update(webinar_id, body, opts = {})
  webinar_update_with_http_info(webinar_id, body, opts)
  nil
end

#webinar_update_with_http_info(webinar_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update a Webinar Zoom users with a [Webinar Plan](zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.&lt;br&gt; Use this API to make updates to a scheduled Webinar.&lt;br&gt;&lt;br&gt; Scopes: &#x60;webinar:write:admin&#x60; &#x60;webinar:write&#x60;&lt;br&gt; &lt;br&gt; Prerequisites:&lt;br&gt; * Pro or higher plan with a Webinar Add-on.

Parameters:

  • webinar_id —

    The webinar ID.

  • body —

    Webinar.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :occurrence_id (String) —

    Webinar occurrence id. Support change of agenda, start_time, duration, settings: panelist_video, hd_video, watermark, auto_recording

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
 
# File 'lib/zoom_us/webinars.rb', line 1507

def webinar_update_with_http_info(webinar_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebinarsApi.webinar_update ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling WebinarsApi.webinar_update"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling WebinarsApi.webinar_update"
  end
  # resource path
  local_var_path = '/webinars/{webinarId}'.sub('{' + 'webinarId' + '}', webinar_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'occurrence_id'] = opts[:'occurrence_id'] if !opts[:'occurrence_id'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebinarsApi#webinar_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webinar_with_http_info(webinar_id, opts = {}) ⇒ Array<(InlineResponse20054, Fixnum, Hash)>

Get a Webinar Zoom users with a [Webinar Plan](zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.&lt;br&gt;Use this API to get details of a scheduled webinar.&lt;br&gt;&lt;br&gt; Scopes: &#x60;webinar:read:admin&#x60; &#x60;webinar:read&#x60;&lt;br&gt; &lt;br&gt;Prerequisites: * Pro or higher plan with a Webinar Add-on.

Parameters:

  • webinar_id —

    The webinar ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(InlineResponse20054, Fixnum, Hash)>) —

    InlineResponse20054 data, response status code and response headers



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/zoom_us/webinars.rb', line 309

def webinar_with_http_info(webinar_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebinarsApi.webinar ...'
  end
  # verify the required parameter 'webinar_id' is set
  if @api_client.config.client_side_validation && webinar_id.nil?
    fail ArgumentError, "Missing the required parameter 'webinar_id' when calling WebinarsApi.webinar"
  end
  # resource path
  local_var_path = '/webinars/{webinarId}'.sub('{' + 'webinarId' + '}', webinar_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'occurrence_id'] = opts[:'occurrence_id'] if !opts[:'occurrence_id'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20054')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebinarsApi#webinar\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webinars(user_id, opts = {}) ⇒ UserList

List Webinars Zoom users with a [Webinar Plan](zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.
Use this API to list all the webinars that are scheduled by or on-behalf a user (Webinar host).
Scopes: ‘webinar:read:admin` `webinar:read`

Prerequisites: * Pro or higher plan with a Webinar Add-on.

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of records returned within a single API call. (default to 30)

  • :page_number (Integer) —

    The current page number of returned records. (default to 1)

Returns:

  • (UserList) 


1557
1558
1559
1560
 
# File 'lib/zoom_us/webinars.rb', line 1557

def webinars(user_id, opts = {})
  data, _status_code, _headers = webinars_with_http_info(user_id, opts)
  data
end

#webinars_with_http_info(user_id, opts = {}) ⇒ Array<(UserList, Fixnum, Hash)>

List Webinars Zoom users with a [Webinar Plan](zoom.us/webinar) have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.&lt;br&gt; Use this API to list all the webinars that are scheduled by or on-behalf a user (Webinar host).&lt;br&gt;&lt;br&gt; Scopes: &#x60;webinar:read:admin&#x60; &#x60;webinar:read&#x60;&lt;br&gt; &lt;br&gt; Prerequisites: * Pro or higher plan with a Webinar Add-on.

Parameters:

  • user_id —

    The user ID or email address of the user. For user-level apps, pass &#x60;me&#x60; as the value for userId.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of records returned within a single API call.

  • :page_number (Integer) —

    The current page number of returned records.

Returns:

  • (Array<(UserList, Fixnum, Hash)>) —

    UserList data, response status code and response headers



1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
 
# File 'lib/zoom_us/webinars.rb', line 1569

def webinars_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebinarsApi.webinars ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling WebinarsApi.webinars"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 300
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling WebinarsApi.webinars, must be smaller than or equal to 300.'
  end

  # resource path
  local_var_path = '/users/{userId}/webinars'.sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page_number'] = opts[:'page_number'] if !opts[:'page_number'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebinarsApi#webinars\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end