Class: ZoomUs::CloudRecording

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CloudRecording

Returns a new instance of CloudRecording.



19
20
21
 
# File 'lib/zoom_us/cloud_recording.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/cloud_recording.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_account_cloud_recording(account_id, opts = {}) ⇒ InlineResponse20073

List Recordings of an Account List [Cloud Recordings](support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) available on an Account. Prerequisites:
* A Pro or a higher paid plan with Cloud Recording option enabled.
Scopes: ‘recording:read:admin` or `account:read:admin` If the scope `recording:read:admin` is used, the Account ID of the Account must be provided in the `accountId` path parameter to list recordings that belong to the Account. This scope only works for Sub Accounts. To list recordings of a Master Account, the scope must be `account:read:admin` and the value of `accountId` should be `me`.

Parameters:

  • account_id
  • 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)

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

  • :from (DateTime) —

    The start date for the monthly range for which you would like to retrieve recordings. The maximum range can be a month. The month should fall within the past six months period from the date of query.

  • :to (DateTime) —

    The end date for the monthly range for which you would like to retrieve recordings. The maximum range can be a month. The month should fall within the past six months period from the date of query.

Returns:

  • (InlineResponse20073) 


31
32
33
34
 
# File 'lib/zoom_us/cloud_recording.rb', line 31

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

#get_account_cloud_recording_with_http_info(account_id, opts = {}) ⇒ Array<(InlineResponse20073, Fixnum, Hash)>

List Recordings of an Account List [Cloud Recordings](support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) available on an Account. Prerequisites:&lt;br&gt; * A Pro or a higher paid plan with Cloud Recording option enabled.&lt;br&gt; Scopes: &#x60;recording:read:admin&#x60; or &#x60;account:read:admin&#x60; If the scope &#x60;recording:read:admin&#x60; is used, the Account ID of the Account must be provided in the &#x60;accountId&#x60; path parameter to list recordings that belong to the Account. This scope only works for Sub Accounts. To list recordings of a Master Account, the scope must be &#x60;account:read:admin&#x60; and the value of &#x60;accountId&#x60; should be &#x60;me&#x60;.&lt;br&gt; &lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

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

  • :from (DateTime) —

    The start date for the monthly range for which you would like to retrieve recordings. The maximum range can be a month. The month should fall within the past six months period from the date of query.

  • :to (DateTime) —

    The end date for the monthly range for which you would like to retrieve recordings. The maximum range can be a month. The month should fall within the past six months period from the date of query.

Returns:

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

    InlineResponse20073 data, response status code and response headers



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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/zoom_us/cloud_recording.rb', line 45

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudRecordingApi.get_account_cloud_recording ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling CloudRecordingApi.get_account_cloud_recording"
  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 CloudRecordingApi.get_account_cloud_recording, must be smaller than or equal to 300.'
  end

  # resource path
  local_var_path = '/accounts/{accountId}/recordings'.sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}
  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?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].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 => 'InlineResponse20073')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudRecordingApi#get_account_cloud_recording\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#meeting_recording_registrant_create(meeting_id, body, opts = {}) ⇒ InlineResponse20113

Create a Recording Registrant Cloud Recordings of past Zoom Meetings can be made [on-demand](support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings). Users should be [registered](marketplace.zoom.us/docs/api-reference/zoom-api/cloud-recording/meetingrecordingregistrantcreate) to view these recordings. Use this API to register a user to gain access to **On-demand Cloud Recordings** of a past meeting.
Scopes: ‘recording:write:admin`, `recording:write`.

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Returns:

  • (InlineResponse20113) 


98
99
100
101
 
# File 'lib/zoom_us/cloud_recording.rb', line 98

def meeting_recording_registrant_create(meeting_id, body, opts = {})
  data, _status_code, _headers = meeting_recording_registrant_create_with_http_info(meeting_id, body, opts)
  data
end

#meeting_recording_registrant_create_with_http_info(meeting_id, body, opts = {}) ⇒ Array<(InlineResponse20113, Fixnum, Hash)>

Create a Recording Registrant Cloud Recordings of past Zoom Meetings can be made [on-demand](support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings). Users should be [registered](marketplace.zoom.us/docs/api-reference/zoom-api/cloud-recording/meetingrecordingregistrantcreate) to view these recordings. Use this API to register a user to gain access to **On-demand Cloud Recordings** of a past meeting.&lt;br&gt; Scopes: &#x60;recording:write:admin&#x60;, &#x60;recording:write&#x60;.&lt;br&gt;

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Returns:

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

    InlineResponse20113 data, response status code and response headers



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/zoom_us/cloud_recording.rb', line 109

def meeting_recording_registrant_create_with_http_info(meeting_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudRecordingApi.meeting_recording_registrant_create ...'
  end
  # verify the required parameter 'meeting_id' is set
  if @api_client.config.client_side_validation && meeting_id.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_id' when calling CloudRecordingApi.meeting_recording_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 CloudRecordingApi.meeting_recording_registrant_create"
  end
  # resource path
  local_var_path = '/meetings/{meetingId}/recordings/registrants'.sub('{' + 'meetingId' + '}', meeting_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 => 'InlineResponse20113')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudRecordingApi#meeting_recording_registrant_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#meeting_recording_registrant_status(meeting_id, body, opts = {}) ⇒ nil

Update Recording Registrant’s Status A registrant can either be approved or denied from viewing the [on-demand](support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) recording. Use this API to update a registrant’s status. Scopes: ‘recording:write:admin`, `recording:write`

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Returns:

  • (nil) 


158
159
160
161
 
# File 'lib/zoom_us/cloud_recording.rb', line 158

def meeting_recording_registrant_status(meeting_id, body, opts = {})
  meeting_recording_registrant_status_with_http_info(meeting_id, body, opts)
  nil
end

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

Update Recording Registrant&#39;s Status A registrant can either be approved or denied from viewing the [on-demand](support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) recording. Use this API to update a registrant&#39;s status. Scopes: &#x60;recording:write:admin&#x60;, &#x60;recording:write&#x60;&lt;br&gt;

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/zoom_us/cloud_recording.rb', line 169

def meeting_recording_registrant_status_with_http_info(meeting_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudRecordingApi.meeting_recording_registrant_status ...'
  end
  # verify the required parameter 'meeting_id' is set
  if @api_client.config.client_side_validation && meeting_id.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_id' when calling CloudRecordingApi.meeting_recording_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 CloudRecordingApi.meeting_recording_registrant_status"
  end
  # resource path
  local_var_path = '/meetings/{meetingId}/recordings/registrants/status'.sub('{' + 'meetingId' + '}', meeting_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: CloudRecordingApi#meeting_recording_registrant_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#meeting_recording_registrants(meeting_id, opts = {}) ⇒ RegistrationList1

List Recording Registrants Cloud Recordings of past Zoom Meetings can be made [on-demand](support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings). Users should be [registered](marketplace.zoom.us/docs/api-reference/zoom-api/cloud-recording/meetingrecordingregistrantcreate) to view these recordings. Use this API to list registrants of **On-demand Cloud Recordings** of a past meeting.
Scopes: ‘recording:read:admin`, `recording:read`.

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Options Hash (opts):

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

  • (RegistrationList1) 


219
220
221
222
 
# File 'lib/zoom_us/cloud_recording.rb', line 219

def meeting_recording_registrants(meeting_id, opts = {})
  data, _status_code, _headers = meeting_recording_registrants_with_http_info(meeting_id, opts)
  data
end

#meeting_recording_registrants_with_http_info(meeting_id, opts = {}) ⇒ Array<(RegistrationList1, Fixnum, Hash)>

List Recording Registrants Cloud Recordings of past Zoom Meetings can be made [on-demand](support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings). Users should be [registered](marketplace.zoom.us/docs/api-reference/zoom-api/cloud-recording/meetingrecordingregistrantcreate) to view these recordings. Use this API to list registrants of **On-demand Cloud Recordings** of a past meeting.&lt;br&gt; Scopes: &#x60;recording:read:admin&#x60;, &#x60;recording:read&#x60;.&lt;br&gt;

Parameters:

  • meeting_id —

    The meeting ID.

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

    the optional parameters

Options Hash (opts):

  • :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<(RegistrationList1, Fixnum, Hash)>) —

    RegistrationList1 data, response status code and response headers



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
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
 
# File 'lib/zoom_us/cloud_recording.rb', line 232

def meeting_recording_registrants_with_http_info(meeting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudRecordingApi.meeting_recording_registrants ...'
  end
  # verify the required parameter 'meeting_id' is set
  if @api_client.config.client_side_validation && meeting_id.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_id' when calling CloudRecordingApi.meeting_recording_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 CloudRecordingApi.meeting_recording_registrants, must be smaller than or equal to 300.'
  end

  # resource path
  local_var_path = '/meetings/{meetingId}/recordings/registrants'.sub('{' + 'meetingId' + '}', meeting_id.to_s)

  # query parameters
  query_params = {}
  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 => 'RegistrationList1')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudRecordingApi#meeting_recording_registrants\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#recording_delete(meeting_id, opts = {}) ⇒ nil

Delete Meeting Recordings Delete all recording files of a meeting.
Scopes: ‘recording:write:admin` `recording:write`

Prerequisites: * Cloud Recording should be enabled on the user’s account.

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. If a UUID starts with &quot;/&quot; or contains &quot;//&quot; (example: &quot;/ajXp112QmuoKj4854875&#x3D;&#x3D;&quot;), you must **double encode** the UUID before making an API request.

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

    the optional parameters

Options Hash (opts):

  • :action (String) —

    The recording delete actions:&lt;br&gt;&#x60;trash&#x60; - Move recording to trash.&lt;br&gt;&#x60;delete&#x60; - Delete recording permanently. (default to trash)

Returns:

  • (nil) 


287
288
289
290
 
# File 'lib/zoom_us/cloud_recording.rb', line 287

def recording_delete(meeting_id, opts = {})
  recording_delete_with_http_info(meeting_id, opts)
  nil
end

#recording_delete_one(meeting_id, recording_id, opts = {}) ⇒ nil

Delete a Meeting Recording File Delete a sprecific recording file from a meeting.
Scopes: ‘recording:write:admin` `recording:write`

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. If a UUID starts with &quot;/&quot; or contains &quot;//&quot; (example: &quot;/ajXp112QmuoKj4854875&#x3D;&#x3D;&quot;), you must **double encode** the UUID before making an API request.

  • recording_id —

    The recording ID.

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

    the optional parameters

Options Hash (opts):

  • :action (String) —

    The recording delete actions:&lt;br&gt;&#x60;trash&#x60; - Move recording to trash.&lt;br&gt;&#x60;delete&#x60; - Delete recording permanently. (default to trash)

Returns:

  • (nil) 


347
348
349
350
 
# File 'lib/zoom_us/cloud_recording.rb', line 347

def recording_delete_one(meeting_id, recording_id, opts = {})
  recording_delete_one_with_http_info(meeting_id, recording_id, opts)
  nil
end

#recording_delete_one_with_http_info(meeting_id, recording_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a Meeting Recording File Delete a sprecific recording file from a meeting.&lt;br&gt;&lt;br&gt; Scopes: &#x60;recording:write:admin&#x60; &#x60;recording:write&#x60;&lt;br&gt; &lt;br&gt;

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. If a UUID starts with &quot;/&quot; or contains &quot;//&quot; (example: &quot;/ajXp112QmuoKj4854875&#x3D;&#x3D;&quot;), you must **double encode** the UUID before making an API request.

  • recording_id —

    The recording ID.

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

    the optional parameters

Options Hash (opts):

  • :action (String) —

    The recording delete actions:&lt;br&gt;&#x60;trash&#x60; - Move recording to trash.&lt;br&gt;&#x60;delete&#x60; - Delete recording permanently.

Returns:

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

    nil, response status code and response headers



359
360
361
362
363
364
365
366
367
368
369
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
 
# File 'lib/zoom_us/cloud_recording.rb', line 359

def recording_delete_one_with_http_info(meeting_id, recording_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudRecordingApi.recording_delete_one ...'
  end
  # verify the required parameter 'meeting_id' is set
  if @api_client.config.client_side_validation && meeting_id.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_id' when calling CloudRecordingApi.recording_delete_one"
  end
  # verify the required parameter 'recording_id' is set
  if @api_client.config.client_side_validation && recording_id.nil?
    fail ArgumentError, "Missing the required parameter 'recording_id' when calling CloudRecordingApi.recording_delete_one"
  end
  if @api_client.config.client_side_validation && opts[:'action'] && !['trash', 'delete'].include?(opts[:'action'])
    fail ArgumentError, 'invalid value for "action", must be one of trash, delete'
  end
  # resource path
  local_var_path = '/meetings/{meetingId}/recordings/{recordingId}'.sub('{' + 'meetingId' + '}', meeting_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'action'] = opts[:'action'] if !opts[:'action'].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: CloudRecordingApi#recording_delete_one\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#recording_delete_with_http_info(meeting_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete Meeting Recordings Delete all recording files of a meeting.&lt;br&gt;&lt;br&gt; Scopes: &#x60;recording:write:admin&#x60; &#x60;recording:write&#x60;&lt;br&gt; &lt;br&gt; Prerequisites: * Cloud Recording should be enabled on the user&#39;s account.&lt;br&gt;

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. If a UUID starts with &quot;/&quot; or contains &quot;//&quot; (example: &quot;/ajXp112QmuoKj4854875&#x3D;&#x3D;&quot;), you must **double encode** the UUID before making an API request.

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

    the optional parameters

Options Hash (opts):

  • :action (String) —

    The recording delete actions:&lt;br&gt;&#x60;trash&#x60; - Move recording to trash.&lt;br&gt;&#x60;delete&#x60; - Delete recording permanently.

Returns:

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

    nil, response status code and response headers



298
299
300
301
302
303
304
305
306
307
308
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
 
# File 'lib/zoom_us/cloud_recording.rb', line 298

def recording_delete_with_http_info(meeting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudRecordingApi.recording_delete ...'
  end
  # verify the required parameter 'meeting_id' is set
  if @api_client.config.client_side_validation && meeting_id.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_id' when calling CloudRecordingApi.recording_delete"
  end
  if @api_client.config.client_side_validation && opts[:'action'] && !['trash', 'delete'].include?(opts[:'action'])
    fail ArgumentError, 'invalid value for "action", must be one of trash, delete'
  end
  # resource path
  local_var_path = '/meetings/{meetingId}/recordings'.sub('{' + 'meetingId' + '}', meeting_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'action'] = opts[:'action'] if !opts[:'action'].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: CloudRecordingApi#recording_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#recording_get(meeting_id, opts = {}) ⇒ Object

Get Meeting Recordings Get all the [recordings](support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording#h_7420acb5-1897-4061-87b4-5b76e99c03b4) from a meeting.
Scopes: ‘recording:read:admin` `recording:read`

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. If a UUID starts with &quot;/&quot; or contains &quot;//&quot; (example: &quot;/ajXp112QmuoKj4854875&#x3D;&#x3D;&quot;), you must **double encode** the UUID before making an API request.

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

    the optional parameters

Returns:

  • (Object) 


410
411
412
413
 
# File 'lib/zoom_us/cloud_recording.rb', line 410

def recording_get(meeting_id, opts = {})
  data, _status_code, _headers = recording_get_with_http_info(meeting_id, opts)
  data
end

#recording_get_with_http_info(meeting_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Get Meeting Recordings Get all the [recordings](support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording#h_7420acb5-1897-4061-87b4-5b76e99c03b4) from a meeting.&lt;br&gt;&lt;br&gt; Scopes: &#x60;recording:read:admin&#x60; &#x60;recording:read&#x60;&lt;br&gt;

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. If a UUID starts with &quot;/&quot; or contains &quot;//&quot; (example: &quot;/ajXp112QmuoKj4854875&#x3D;&#x3D;&quot;), you must **double encode** the UUID before making an API request.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



420
421
422
423
424
425
426
427
428
429
430
431
432
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
 
# File 'lib/zoom_us/cloud_recording.rb', line 420

def recording_get_with_http_info(meeting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudRecordingApi.recording_get ...'
  end
  # verify the required parameter 'meeting_id' is set
  if @api_client.config.client_side_validation && meeting_id.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_id' when calling CloudRecordingApi.recording_get"
  end
  # resource path
  local_var_path = '/meetings/{meetingId}/recordings'.sub('{' + 'meetingId' + '}', meeting_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: CloudRecordingApi#recording_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#recording_registrant_question_update(meeting_id, body, opts = {}) ⇒ nil

Update Registration Questions For [on-demand](support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) meeting recordings, you can include fields with questions that will be shown to registrants when they register to view the recording. Use this API to update registration questions that are to be answered by users while registering to view a recording.
Scopes: ‘recording:write:admin`, `recording:write`

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. If a UUID starts with &quot;/&quot; or contains &quot;//&quot; (example: &quot;/ajXp112QmuoKj4854875&#x3D;&#x3D;&quot;), you must **double encode** the UUID before making an API request.

  • body —

    Recording Registrant Questions

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

    the optional parameters

Returns:

  • (nil) 


465
466
467
468
 
# File 'lib/zoom_us/cloud_recording.rb', line 465

def recording_registrant_question_update(meeting_id, body, opts = {})
  recording_registrant_question_update_with_http_info(meeting_id, body, opts)
  nil
end

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

Update Registration Questions For [on-demand](support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) meeting recordings, you can include fields with questions that will be shown to registrants when they register to view the recording. Use this API to update registration questions that are to be answered by users while registering to view a recording.&lt;br&gt; Scopes: &#x60;recording:write:admin&#x60;, &#x60;recording:write&#x60;&lt;br&gt; &lt;br&gt;

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. If a UUID starts with &quot;/&quot; or contains &quot;//&quot; (example: &quot;/ajXp112QmuoKj4854875&#x3D;&#x3D;&quot;), you must **double encode** the UUID before making an API request.

  • body —

    Recording Registrant Questions

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
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
 
# File 'lib/zoom_us/cloud_recording.rb', line 476

def recording_registrant_question_update_with_http_info(meeting_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudRecordingApi.recording_registrant_question_update ...'
  end
  # verify the required parameter 'meeting_id' is set
  if @api_client.config.client_side_validation && meeting_id.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_id' when calling CloudRecordingApi.recording_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 CloudRecordingApi.recording_registrant_question_update"
  end
  # resource path
  local_var_path = '/meetings/{meetingId}/recordings/registrants/questions'.sub('{' + 'meetingId' + '}', meeting_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: CloudRecordingApi#recording_registrant_question_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#recording_registrants_questions_get(meeting_id, opts = {}) ⇒ RecordingRegistrantQuestions

Get Registration Questions For [on-demand](support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) meeting recordings, you can include fields with questions that will be shown to registrants when they register to view the recording. Use this API to retrieve a list of questions that are displayed for users to complete when registering to view the recording of a specific meeting.
Scopes: ‘recording:read:admin`, `recording:read`

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. If a UUID starts with &quot;/&quot; or contains &quot;//&quot; (example: &quot;/ajXp112QmuoKj4854875&#x3D;&#x3D;&quot;), you must **double encode** the UUID before making an API request.

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

    the optional parameters

Returns:

  • (RecordingRegistrantQuestions) 


523
524
525
526
 
# File 'lib/zoom_us/cloud_recording.rb', line 523

def recording_registrants_questions_get(meeting_id, opts = {})
  data, _status_code, _headers = recording_registrants_questions_get_with_http_info(meeting_id, opts)
  data
end

#recording_registrants_questions_get_with_http_info(meeting_id, opts = {}) ⇒ Array<(RecordingRegistrantQuestions, Fixnum, Hash)>

Get Registration Questions For [on-demand](support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) meeting recordings, you can include fields with questions that will be shown to registrants when they register to view the recording. Use this API to retrieve a list of questions that are displayed for users to complete when registering to view the recording of a specific meeting.&lt;br&gt; Scopes: &#x60;recording:read:admin&#x60;, &#x60;recording:read&#x60;&lt;br&gt;

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. If a UUID starts with &quot;/&quot; or contains &quot;//&quot; (example: &quot;/ajXp112QmuoKj4854875&#x3D;&#x3D;&quot;), you must **double encode** the UUID before making an API request.

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

    the optional parameters

Returns:

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

    RecordingRegistrantQuestions data, response status code and response headers



533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'lib/zoom_us/cloud_recording.rb', line 533

def recording_registrants_questions_get_with_http_info(meeting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudRecordingApi.recording_registrants_questions_get ...'
  end
  # verify the required parameter 'meeting_id' is set
  if @api_client.config.client_side_validation && meeting_id.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_id' when calling CloudRecordingApi.recording_registrants_questions_get"
  end
  # resource path
  local_var_path = '/meetings/{meetingId}/recordings/registrants/questions'.sub('{' + 'meetingId' + '}', meeting_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 => 'RecordingRegistrantQuestions')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudRecordingApi#recording_registrants_questions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#recording_setting_update(meeting_id, opts = {}) ⇒ RecordingSettings

Get Meeting Recording Settings Retrieve settings applied to a meeting’s [Cloud Recording](support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording).
Scopes: ‘recording:read:admin` `recording:read`

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. If a UUID starts with &quot;/&quot; or contains &quot;//&quot; (example: &quot;/ajXp112QmuoKj4854875&#x3D;&#x3D;&quot;), you must **double encode** the UUID before making an API request.

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

    the optional parameters

Returns:

  • (RecordingSettings) 


577
578
579
580
 
# File 'lib/zoom_us/cloud_recording.rb', line 577

def recording_setting_update(meeting_id, opts = {})
  data, _status_code, _headers = recording_setting_update_with_http_info(meeting_id, opts)
  data
end

#recording_setting_update_with_http_info(meeting_id, opts = {}) ⇒ Array<(RecordingSettings, Fixnum, Hash)>

Get Meeting Recording Settings Retrieve settings applied to a meeting&#39;s [Cloud Recording](support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording).&lt;br&gt;&lt;br&gt; Scopes: &#x60;recording:read:admin&#x60; &#x60;recording:read&#x60;&lt;br&gt; &lt;br&gt;

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. If a UUID starts with &quot;/&quot; or contains &quot;//&quot; (example: &quot;/ajXp112QmuoKj4854875&#x3D;&#x3D;&quot;), you must **double encode** the UUID before making an API request.

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

    the optional parameters

Returns:

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

    RecordingSettings data, response status code and response headers



587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/zoom_us/cloud_recording.rb', line 587

def recording_setting_update_with_http_info(meeting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudRecordingApi.recording_setting_update ...'
  end
  # verify the required parameter 'meeting_id' is set
  if @api_client.config.client_side_validation && meeting_id.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_id' when calling CloudRecordingApi.recording_setting_update"
  end
  # resource path
  local_var_path = '/meetings/{meetingId}/recordings/settings'.sub('{' + 'meetingId' + '}', meeting_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 => 'RecordingSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudRecordingApi#recording_setting_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#recording_settings_update(meeting_id, body, opts = {}) ⇒ nil

Update Meeting Recording Settings Update settings applied to a meeting’s [Cloud Recording](support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording)
Scopes: ‘recording:write:admin` `recording:write`

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. If a UUID starts with &quot;/&quot; or contains &quot;//&quot; (example: &quot;/ajXp112QmuoKj4854875&#x3D;&#x3D;&quot;), you must **double encode** the UUID before making an API request.

  • body —

    Meeting recording Settings

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

    the optional parameters

Returns:

  • (nil) 


632
633
634
635
 
# File 'lib/zoom_us/cloud_recording.rb', line 632

def recording_settings_update(meeting_id, body, opts = {})
  recording_settings_update_with_http_info(meeting_id, body, opts)
  nil
end

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

Update Meeting Recording Settings Update settings applied to a meeting&#39;s [Cloud Recording](support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording)&lt;br&gt;&lt;br&gt; Scopes: &#x60;recording:write:admin&#x60; &#x60;recording:write&#x60;&lt;br&gt; &lt;br&gt;

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. If a UUID starts with &quot;/&quot; or contains &quot;//&quot; (example: &quot;/ajXp112QmuoKj4854875&#x3D;&#x3D;&quot;), you must **double encode** the UUID before making an API request.

  • body —

    Meeting recording Settings

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
 
# File 'lib/zoom_us/cloud_recording.rb', line 643

def recording_settings_update_with_http_info(meeting_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudRecordingApi.recording_settings_update ...'
  end
  # verify the required parameter 'meeting_id' is set
  if @api_client.config.client_side_validation && meeting_id.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_id' when calling CloudRecordingApi.recording_settings_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 CloudRecordingApi.recording_settings_update"
  end
  # resource path
  local_var_path = '/meetings/{meetingId}/recordings/settings'.sub('{' + 'meetingId' + '}', meeting_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: CloudRecordingApi#recording_settings_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#recording_status_update(meeting_id, body, opts = {}) ⇒ nil

Recover Meeting Recordings Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use this API to recover all deleted [Cloud Recordings](support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) of a specific meeting.
Scopes: ‘recording:write:admin` `recording:write`

Prerequisites:
* A Pro user with Cloud Recording enabled.

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. If a UUID starts with &quot;/&quot; or contains &quot;//&quot; (example: &quot;/ajXp112QmuoKj4854875&#x3D;&#x3D;&quot;), you must **double encode** the UUID before making an API request.

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

    the optional parameters

Returns:

  • (nil) 


691
692
693
694
 
# File 'lib/zoom_us/cloud_recording.rb', line 691

def recording_status_update(meeting_id, body, opts = {})
  recording_status_update_with_http_info(meeting_id, body, opts)
  nil
end

#recording_status_update_one(meeting_id, recording_id, body, opts = {}) ⇒ nil

Recover a Single Recording Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use this API to recover a single recording file from the meeting.
Scopes: ‘recording:write:admin` `recording:write`

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. If a UUID starts with &quot;/&quot; or contains &quot;//&quot; (example: &quot;/ajXp112QmuoKj4854875&#x3D;&#x3D;&quot;), you must **double encode** the UUID before making an API request.

  • recording_id —

    The recording ID.

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

    the optional parameters

Returns:

  • (nil) 


751
752
753
754
 
# File 'lib/zoom_us/cloud_recording.rb', line 751

def recording_status_update_one(meeting_id, recording_id, body, opts = {})
  recording_status_update_one_with_http_info(meeting_id, recording_id, body, opts)
  nil
end

#recording_status_update_one_with_http_info(meeting_id, recording_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Recover a Single Recording Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use this API to recover a single recording file from the meeting.&lt;br&gt; Scopes: &#x60;recording:write:admin&#x60; &#x60;recording:write&#x60;&lt;br&gt; &lt;br&gt;

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. If a UUID starts with &quot;/&quot; or contains &quot;//&quot; (example: &quot;/ajXp112QmuoKj4854875&#x3D;&#x3D;&quot;), you must **double encode** the UUID before making an API request.

  • recording_id —

    The recording ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



763
764
765
766
767
768
769
770
771
772
773
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
 
# File 'lib/zoom_us/cloud_recording.rb', line 763

def recording_status_update_one_with_http_info(meeting_id, recording_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudRecordingApi.recording_status_update_one ...'
  end
  # verify the required parameter 'meeting_id' is set
  if @api_client.config.client_side_validation && meeting_id.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_id' when calling CloudRecordingApi.recording_status_update_one"
  end
  # verify the required parameter 'recording_id' is set
  if @api_client.config.client_side_validation && recording_id.nil?
    fail ArgumentError, "Missing the required parameter 'recording_id' when calling CloudRecordingApi.recording_status_update_one"
  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 CloudRecordingApi.recording_status_update_one"
  end
  # resource path
  local_var_path = '/meetings/{meetingId}/recordings/{recordingId}/status'.sub('{' + 'meetingId' + '}', meeting_id.to_s).sub('{' + 'recordingId' + '}', recording_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: CloudRecordingApi#recording_status_update_one\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Recover Meeting Recordings Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use this API to recover all deleted [Cloud Recordings](support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) of a specific meeting.&lt;br&gt;&lt;br&gt; Scopes: &#x60;recording:write:admin&#x60; &#x60;recording:write&#x60;&lt;br&gt; &lt;br&gt; Prerequisites:&lt;br&gt; * A Pro user with Cloud Recording enabled.

Parameters:

  • meeting_id —

    The meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. If a UUID starts with &quot;/&quot; or contains &quot;//&quot; (example: &quot;/ajXp112QmuoKj4854875&#x3D;&#x3D;&quot;), you must **double encode** the UUID before making an API request.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
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
 
# File 'lib/zoom_us/cloud_recording.rb', line 702

def recording_status_update_with_http_info(meeting_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudRecordingApi.recording_status_update ...'
  end
  # verify the required parameter 'meeting_id' is set
  if @api_client.config.client_side_validation && meeting_id.nil?
    fail ArgumentError, "Missing the required parameter 'meeting_id' when calling CloudRecordingApi.recording_status_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 CloudRecordingApi.recording_status_update"
  end
  # resource path
  local_var_path = '/meetings/{meetingId}/recordings/status'.sub('{' + 'meetingId' + '}', meeting_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: CloudRecordingApi#recording_status_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#recordings_list(user_id, opts = {}) ⇒ RecordingList

List All Recordings When a user records a meeting by choosing the **Record to the Cloud** option, the video, audio, and chat text are recorded in the Zoom cloud. Use this API to list all [Cloud recordings](support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) of a user.
Scopes: ‘recording:read:admin` `recording:read`

Prerequisites: * Pro or a higher plan. * Cloud Recording must be enabled on the user’s account.

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)

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

  • :mc (String) —

    Query Metadata of Recording if an On-Premise Meeting Connector was used for the meeting. (default to false)

  • :trash (BOOLEAN) —

    Query trash. &#x60;true&#x60;: List recordings from trash.&lt;br&gt; &#x60;false&#x60;: Do not list recordings from the trash.&lt;br&gt; The default value is &#x60;false&#x60;. If you set it to &#x60;true&#x60;, you can use the &#x60;trash_type&#x60; property to indicate the type of Cloud recording that you need to retrieve. (default to false)

  • :from (Date) —

    Start date in &#39;yyyy-mm-dd&#39; format. (Within 6 month range)

  • :to (Date) —

    End date in &#39;yyyy-mm-dd&#39; format. (Within 6 month range)

  • :trash_type (String) —

    The type of Cloud recording that you would like to retrieve from the trash. The value can be one of the following:&lt;br&gt; &#x60;meeting_recordings&#x60;: List all meeting recordings from the trash.&lt;br&gt; &#x60;recording_file&#x60;: List all individual recording files from the trash. (default to meeting_recordings)

Returns:

  • (RecordingList) 


821
822
823
824
 
# File 'lib/zoom_us/cloud_recording.rb', line 821

def recordings_list(user_id, opts = {})
  data, _status_code, _headers = recordings_list_with_http_info(user_id, opts)
  data
end

#recordings_list_with_http_info(user_id, opts = {}) ⇒ Array<(RecordingList, Fixnum, Hash)>

List All Recordings When a user records a meeting by choosing the **Record to the Cloud** option, the video, audio, and chat text are recorded in the Zoom cloud. Use this API to list all [Cloud recordings](support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) of a user.&lt;br&gt;&lt;br&gt; Scopes: &#x60;recording:read:admin&#x60; &#x60;recording:read&#x60;&lt;br&gt; &lt;br&gt; Prerequisites: * Pro or a higher plan. * Cloud Recording must be enabled on the user&#39;s account.

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.

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

  • :mc (String) —

    Query Metadata of Recording if an On-Premise Meeting Connector was used for the meeting.

  • :trash (BOOLEAN) —

    Query trash. &#x60;true&#x60;: List recordings from trash.&lt;br&gt; &#x60;false&#x60;: Do not list recordings from the trash.&lt;br&gt; The default value is &#x60;false&#x60;. If you set it to &#x60;true&#x60;, you can use the &#x60;trash_type&#x60; property to indicate the type of Cloud recording that you need to retrieve.

  • :from (Date) —

    Start date in &#39;yyyy-mm-dd&#39; format. (Within 6 month range)

  • :to (Date) —

    End date in &#39;yyyy-mm-dd&#39; format. (Within 6 month range)

  • :trash_type (String) —

    The type of Cloud recording that you would like to retrieve from the trash. The value can be one of the following:&lt;br&gt; &#x60;meeting_recordings&#x60;: List all meeting recordings from the trash.&lt;br&gt; &#x60;recording_file&#x60;: List all individual recording files from the trash.

Returns:

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

    RecordingList data, response status code and response headers



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
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/zoom_us/cloud_recording.rb', line 838

def recordings_list_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CloudRecordingApi.recordings_list ...'
  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 CloudRecordingApi.recordings_list"
  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 CloudRecordingApi.recordings_list, must be smaller than or equal to 300.'
  end

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

  # query parameters
  query_params = {}
  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?
  query_params[:'mc'] = opts[:'mc'] if !opts[:'mc'].nil?
  query_params[:'trash'] = opts[:'trash'] if !opts[:'trash'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'trash_type'] = opts[:'trash_type'] if !opts[:'trash_type'].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 => 'RecordingList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CloudRecordingApi#recordings_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end