class PureCloud::RecordingApi
Attributes
Public Class Methods
# File lib/purecloud/api/recording_api.rb, line 23 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Delete annotation
@param conversation_id Conversation
ID @param recording_id Recording
ID @param annotation_id Annotation
ID @param [Hash] opts the optional parameters @return [nil]
# File lib/purecloud/api/recording_api.rb, line 34 def delete_conversation_id_recordings_recording_id_annotations_annotation_id(conversation_id, recording_id, annotation_id, opts = {}) delete_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts) return nil end
Delete annotation
@param conversation_id Conversation
ID @param recording_id Recording
ID @param annotation_id Annotation
ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 46 def delete_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#delete_conversation_id_recordings_recording_id_annotations_annotation_id ..." end # verify the required parameter 'conversation_id' is set fail "Missing the required parameter 'conversation_id' when calling delete_conversation_id_recordings_recording_id_annotations_annotation_id" if conversation_id.nil? # verify the required parameter 'recording_id' is set fail "Missing the required parameter 'recording_id' when calling delete_conversation_id_recordings_recording_id_annotations_annotation_id" if recording_id.nil? # verify the required parameter 'annotation_id' is set fail "Missing the required parameter 'annotation_id' when calling delete_conversation_id_recordings_recording_id_annotations_annotation_id" if annotation_id.nil? # resource path local_var_path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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: RecordingApi#delete_conversation_id_recordings_recording_id_annotations_annotation_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete media retention policies Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param. @param ids @param [Hash] opts the optional parameters @return [String]
# File lib/purecloud/api/recording_api.rb, line 101 def delete_mediaretentionpolicies(ids, opts = {}) data, status_code, headers = delete_mediaretentionpolicies_with_http_info(ids, opts) return data end
Delete a media retention policy
@param policy_id Policy
ID @param [Hash] opts the optional parameters @return [String]
# File lib/purecloud/api/recording_api.rb, line 162 def delete_mediaretentionpolicies_policy_id(policy_id, opts = {}) data, status_code, headers = delete_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts) return data end
Delete a media retention policy
@param policy_id Policy
ID @param [Hash] opts the optional parameters @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 172 def delete_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#delete_mediaretentionpolicies_policy_id ..." end # verify the required parameter 'policy_id' is set fail "Missing the required parameter 'policy_id' when calling delete_mediaretentionpolicies_policy_id" if policy_id.nil? # resource path local_var_path = "/api/v2/recording/mediaretentionpolicies/{policyId}".sub('{format}','json').sub('{' + 'policyId' + '}', policy_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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, :return_type => 'String') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#delete_mediaretentionpolicies_policy_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete media retention policies Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param. @param ids @param [Hash] opts the optional parameters @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 111 def delete_mediaretentionpolicies_with_http_info(ids, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#delete_mediaretentionpolicies ..." end # verify the required parameter 'ids' is set fail "Missing the required parameter 'ids' when calling delete_mediaretentionpolicies" if ids.nil? # resource path local_var_path = "/api/v2/recording/mediaretentionpolicies".sub('{format}','json') # query parameters query_params = {} query_params[:'ids'] = ids # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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, :return_type => 'String') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#delete_mediaretentionpolicies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Deletes a single orphan recording
@param orphan_id Orphan ID @param [Hash] opts the optional parameters @return [OrphanRecording]
# File lib/purecloud/api/recording_api.rb, line 222 def delete_orphan_id(orphan_id, opts = {}) data, status_code, headers = delete_orphan_id_with_http_info(orphan_id, opts) return data end
Deletes a single orphan recording
@param orphan_id Orphan ID @param [Hash] opts the optional parameters @return [Array<(OrphanRecording
, Fixnum, Hash)>] OrphanRecording
data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 232 def delete_orphan_id_with_http_info(orphan_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#delete_orphan_id ..." end # verify the required parameter 'orphan_id' is set fail "Missing the required parameter 'orphan_id' when calling delete_orphan_id" if orphan_id.nil? # resource path local_var_path = "/api/v2/orphanrecordings/{orphanId}".sub('{format}','json').sub('{' + 'orphanId' + '}', orphan_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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, :return_type => 'OrphanRecording') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#delete_orphan_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get all of a Conversation's Recordings.
@param conversation_id Conversation
ID @param [Hash] opts the optional parameters @option opts [Integer] :max_wait_ms The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value. (default to 5000) @option opts [String] :format_id The desired media format (default to WEBM) @return [Array<Recording>]
# File lib/purecloud/api/recording_api.rb, line 284 def get_conversation_id_recordings(conversation_id, opts = {}) data, status_code, headers = get_conversation_id_recordings_with_http_info(conversation_id, opts) return data end
Gets a specific recording.
@param conversation_id Conversation
ID @param recording_id Recording
ID @param [Hash] opts the optional parameters @option opts [String] :format_id The desired media format. (default to WEBM) @option opts [BOOLEAN] :download requesting a download format of the recording (default to false) @option opts [String] :file_name the name of the downloaded fileName @return [Recording]
# File lib/purecloud/api/recording_api.rb, line 356 def get_conversation_id_recordings_recording_id(conversation_id, recording_id, opts = {}) data, status_code, headers = get_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, opts) return data end
Get annotations for recording
@param conversation_id Conversation
ID @param recording_id Recording
ID @param [Hash] opts the optional parameters @return [Array<Annotation>]
# File lib/purecloud/api/recording_api.rb, line 431 def get_conversation_id_recordings_recording_id_annotations(conversation_id, recording_id, opts = {}) data, status_code, headers = get_conversation_id_recordings_recording_id_annotations_with_http_info(conversation_id, recording_id, opts) return data end
Get annotation
@param conversation_id Conversation
ID @param recording_id Recording
ID @param annotation_id Annotation
ID @param [Hash] opts the optional parameters @return [Annotation]
# File lib/purecloud/api/recording_api.rb, line 497 def get_conversation_id_recordings_recording_id_annotations_annotation_id(conversation_id, recording_id, annotation_id, opts = {}) data, status_code, headers = get_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts) return data end
Get annotation
@param conversation_id Conversation
ID @param recording_id Recording
ID @param annotation_id Annotation
ID @param [Hash] opts the optional parameters @return [Array<(Annotation
, Fixnum, Hash)>] Annotation
data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 509 def get_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#get_conversation_id_recordings_recording_id_annotations_annotation_id ..." end # verify the required parameter 'conversation_id' is set fail "Missing the required parameter 'conversation_id' when calling get_conversation_id_recordings_recording_id_annotations_annotation_id" if conversation_id.nil? # verify the required parameter 'recording_id' is set fail "Missing the required parameter 'recording_id' when calling get_conversation_id_recordings_recording_id_annotations_annotation_id" if recording_id.nil? # verify the required parameter 'annotation_id' is set fail "Missing the required parameter 'annotation_id' when calling get_conversation_id_recordings_recording_id_annotations_annotation_id" if annotation_id.nil? # resource path local_var_path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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 => 'Annotation') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#get_conversation_id_recordings_recording_id_annotations_annotation_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get annotations for recording
@param conversation_id Conversation
ID @param recording_id Recording
ID @param [Hash] opts the optional parameters @return [Array<(Array<Annotation>, Fixnum, Hash)>] Array<Annotation> data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 442 def get_conversation_id_recordings_recording_id_annotations_with_http_info(conversation_id, recording_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#get_conversation_id_recordings_recording_id_annotations ..." end # verify the required parameter 'conversation_id' is set fail "Missing the required parameter 'conversation_id' when calling get_conversation_id_recordings_recording_id_annotations" if conversation_id.nil? # verify the required parameter 'recording_id' is set fail "Missing the required parameter 'recording_id' when calling get_conversation_id_recordings_recording_id_annotations" if recording_id.nil? # resource path local_var_path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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 => 'Array<Annotation>') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#get_conversation_id_recordings_recording_id_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Gets a specific recording.
@param conversation_id Conversation
ID @param recording_id Recording
ID @param [Hash] opts the optional parameters @option opts [String] :format_id The desired media format. @option opts [BOOLEAN] :download requesting a download format of the recording @option opts [String] :file_name the name of the downloaded fileName @return [Array<(Recording
, Fixnum, Hash)>] Recording
data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 370 def get_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#get_conversation_id_recordings_recording_id ..." end # verify the required parameter 'conversation_id' is set fail "Missing the required parameter 'conversation_id' when calling get_conversation_id_recordings_recording_id" if conversation_id.nil? # verify the required parameter 'recording_id' is set fail "Missing the required parameter 'recording_id' when calling get_conversation_id_recordings_recording_id" if recording_id.nil? if opts[:'format_id'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'NONE'].include?(opts[:'format_id']) fail 'invalid value for "format_id", must be one of WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, NONE' end # resource path local_var_path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s) # query parameters query_params = {} query_params[:'formatId'] = opts[:'format_id'] if opts[:'format_id'] query_params[:'download'] = opts[:'download'] if opts[:'download'] query_params[:'fileName'] = opts[:'file_name'] if opts[:'file_name'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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 => 'Recording') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#get_conversation_id_recordings_recording_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get all of a Conversation's Recordings.
@param conversation_id Conversation
ID @param [Hash] opts the optional parameters @option opts [Integer] :max_wait_ms The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value. @option opts [String] :format_id The desired media format @return [Array<(Array<Recording>, Fixnum, Hash)>] Array<Recording> data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 296 def get_conversation_id_recordings_with_http_info(conversation_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#get_conversation_id_recordings ..." end # verify the required parameter 'conversation_id' is set fail "Missing the required parameter 'conversation_id' when calling get_conversation_id_recordings" if conversation_id.nil? if opts[:'format_id'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'NONE'].include?(opts[:'format_id']) fail 'invalid value for "format_id", must be one of WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, NONE' end # resource path local_var_path = "/api/v2/conversations/{conversationId}/recordings".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s) # query parameters query_params = {} query_params[:'maxWaitMs'] = opts[:'max_wait_ms'] if opts[:'max_wait_ms'] query_params[:'formatId'] = opts[:'format_id'] if opts[:'format_id'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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 => 'Array<Recording>') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#get_conversation_id_recordings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
gets a list local key settings data
@param [Hash] opts the optional parameters @return [LocalEncryptionConfigurationListing]
# File lib/purecloud/api/recording_api.rb, line 564 def get_localkeys_settings(opts = {}) data, status_code, headers = get_localkeys_settings_with_http_info(opts) return data end
Get the local encryption settings
@param settings_id Settings Id @param [Hash] opts the optional parameters @return [LocalEncryptionConfiguration]
# File lib/purecloud/api/recording_api.rb, line 620 def get_localkeys_settings_settings_id(settings_id, opts = {}) data, status_code, headers = get_localkeys_settings_settings_id_with_http_info(settings_id, opts) return data end
Get the local encryption settings
@param settings_id Settings Id @param [Hash] opts the optional parameters @return [Array<(LocalEncryptionConfiguration
, Fixnum, Hash)>] LocalEncryptionConfiguration
data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 630 def get_localkeys_settings_settings_id_with_http_info(settings_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#get_localkeys_settings_settings_id ..." end # verify the required parameter 'settings_id' is set fail "Missing the required parameter 'settings_id' when calling get_localkeys_settings_settings_id" if settings_id.nil? # resource path local_var_path = "/api/v2/recording/localkeys/settings/{settingsId}".sub('{format}','json').sub('{' + 'settingsId' + '}', settings_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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 => 'LocalEncryptionConfiguration') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#get_localkeys_settings_settings_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
gets a list local key settings data
@param [Hash] opts the optional parameters @return [Array<(LocalEncryptionConfigurationListing
, Fixnum, Hash)>] LocalEncryptionConfigurationListing
data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 573 def get_localkeys_settings_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#get_localkeys_settings ..." end # resource path local_var_path = "/api/v2/recording/localkeys/settings".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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 => 'LocalEncryptionConfigurationListing') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#get_localkeys_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Gets media retention policy list with query options to filter on name and enabled. for a less verbose response, add summary=true to this endpoint @param [Hash] opts the optional parameters @option opts [Integer] :page_size The total page size requested (default to 25) @option opts [Integer] :page_number The page number requested (default to 1) @option opts [String] :sort_by variable name requested to sort by @option opts [Array<Object>] :expand variable name requested by expand list @option opts [String] :next_page next page token @option opts [String] :previous_page Previous page token @option opts [String] :name the policy name - used for filtering results in searches. @option opts [BOOLEAN] :enabled checks to see if policy is enabled - use enabled = true or enabled = false @option opts [BOOLEAN] :summary provides a less verbose response of policy lists. (default to false) @option opts [BOOLEAN] :has_errors provides a way to fetch all policies with errors or policies that do not have errors @return [PolicyEntityListing]
# File lib/purecloud/api/recording_api.rb, line 689 def get_mediaretentionpolicies(opts = {}) data, status_code, headers = get_mediaretentionpolicies_with_http_info(opts) return data end
Get a media retention policy
@param policy_id Policy
ID @param [Hash] opts the optional parameters @return [Policy]
# File lib/purecloud/api/recording_api.rb, line 765 def get_mediaretentionpolicies_policy_id(policy_id, opts = {}) data, status_code, headers = get_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts) return data end
Get a media retention policy
@param policy_id Policy
ID @param [Hash] opts the optional parameters @return [Array<(Policy
, Fixnum, Hash)>] Policy
data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 775 def get_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#get_mediaretentionpolicies_policy_id ..." end # verify the required parameter 'policy_id' is set fail "Missing the required parameter 'policy_id' when calling get_mediaretentionpolicies_policy_id" if policy_id.nil? # resource path local_var_path = "/api/v2/recording/mediaretentionpolicies/{policyId}".sub('{format}','json').sub('{' + 'policyId' + '}', policy_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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 => 'Policy') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#get_mediaretentionpolicies_policy_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Gets media retention policy list with query options to filter on name and enabled. for a less verbose response, add summary=true to this endpoint @param [Hash] opts the optional parameters @option opts [Integer] :page_size The total page size requested @option opts [Integer] :page_number The page number requested @option opts [String] :sort_by variable name requested to sort by @option opts [Array<Object>] :expand variable name requested by expand list @option opts [String] :next_page next page token @option opts [String] :previous_page Previous page token @option opts [String] :name the policy name - used for filtering results in searches. @option opts [BOOLEAN] :enabled checks to see if policy is enabled - use enabled = true or enabled = false @option opts [BOOLEAN] :summary provides a less verbose response of policy lists. @option opts [BOOLEAN] :has_errors provides a way to fetch all policies with errors or policies that do not have errors @return [Array<(PolicyEntityListing
, Fixnum, Hash)>] PolicyEntityListing
data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 708 def get_mediaretentionpolicies_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#get_mediaretentionpolicies ..." end # resource path local_var_path = "/api/v2/recording/mediaretentionpolicies".sub('{format}','json') # query parameters query_params = {} query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size'] query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number'] query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by'] query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page'] query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page'] query_params[:'name'] = opts[:'name'] if opts[:'name'] query_params[:'enabled'] = opts[:'enabled'] if opts[:'enabled'] query_params[:'summary'] = opts[:'summary'] if opts[:'summary'] query_params[:'hasErrors'] = opts[:'has_errors'] if opts[:'has_errors'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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 => 'PolicyEntityListing') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#get_mediaretentionpolicies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Gets a single orphan recording
@param orphan_id Orphan ID @param [Hash] opts the optional parameters @return [OrphanRecording]
# File lib/purecloud/api/recording_api.rb, line 825 def get_orphan_id(orphan_id, opts = {}) data, status_code, headers = get_orphan_id_with_http_info(orphan_id, opts) return data end
Gets the media of a single orphan recording A 202 response means the orphaned media is currently transcoding and will be available shortly.A 200 response denotes the transcoded orphan media is available now and is contained in the response body. @param orphan_id Orphan ID @param [Hash] opts the optional parameters @option opts [String] :format_id The desired media format. (default to WEBM) @option opts [BOOLEAN] :download requesting a download format of the recording (default to false) @option opts [String] :file_name the name of the downloaded fileName @return [Recording]
# File lib/purecloud/api/recording_api.rb, line 888 def get_orphan_id_media(orphan_id, opts = {}) data, status_code, headers = get_orphan_id_media_with_http_info(orphan_id, opts) return data end
Gets the media of a single orphan recording A 202 response means the orphaned media is currently transcoding and will be available shortly.A 200 response denotes the transcoded orphan media is available now and is contained in the response body. @param orphan_id Orphan ID @param [Hash] opts the optional parameters @option opts [String] :format_id The desired media format. @option opts [BOOLEAN] :download requesting a download format of the recording @option opts [String] :file_name the name of the downloaded fileName @return [Array<(Recording
, Fixnum, Hash)>] Recording
data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 901 def get_orphan_id_media_with_http_info(orphan_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#get_orphan_id_media ..." end # verify the required parameter 'orphan_id' is set fail "Missing the required parameter 'orphan_id' when calling get_orphan_id_media" if orphan_id.nil? if opts[:'format_id'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'NONE'].include?(opts[:'format_id']) fail 'invalid value for "format_id", must be one of WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, NONE' end # resource path local_var_path = "/api/v2/orphanrecordings/{orphanId}/media".sub('{format}','json').sub('{' + 'orphanId' + '}', orphan_id.to_s) # query parameters query_params = {} query_params[:'formatId'] = opts[:'format_id'] if opts[:'format_id'] query_params[:'download'] = opts[:'download'] if opts[:'download'] query_params[:'fileName'] = opts[:'file_name'] if opts[:'file_name'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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 => 'Recording') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#get_orphan_id_media\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Gets a single orphan recording
@param orphan_id Orphan ID @param [Hash] opts the optional parameters @return [Array<(OrphanRecording
, Fixnum, Hash)>] OrphanRecording
data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 835 def get_orphan_id_with_http_info(orphan_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#get_orphan_id ..." end # verify the required parameter 'orphan_id' is set fail "Missing the required parameter 'orphan_id' when calling get_orphan_id" if orphan_id.nil? # resource path local_var_path = "/api/v2/orphanrecordings/{orphanId}".sub('{format}','json').sub('{' + 'orphanId' + '}', orphan_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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 => 'OrphanRecording') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#get_orphan_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Gets all orphan recordings
@param [Hash] opts the optional parameters @option opts [Integer] :page_size The total page size requested (default to 25) @option opts [Integer] :page_number The page number requested (default to 1) @option opts [String] :sort_by variable name requested to sort by @option opts [Array<Object>] :expand variable name requested by expand list @option opts [String] :next_page next page token @option opts [String] :previous_page Previous page token @option opts [BOOLEAN] :has_conversation Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization. (default to false) @return [OrphanRecordingListing]
# File lib/purecloud/api/recording_api.rb, line 964 def get_orphanrecordings(opts = {}) data, status_code, headers = get_orphanrecordings_with_http_info(opts) return data end
Gets all orphan recordings
@param [Hash] opts the optional parameters @option opts [Integer] :page_size The total page size requested @option opts [Integer] :page_number The page number requested @option opts [String] :sort_by variable name requested to sort by @option opts [Array<Object>] :expand variable name requested by expand list @option opts [String] :next_page next page token @option opts [String] :previous_page Previous page token @option opts [BOOLEAN] :has_conversation Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization. @return [Array<(OrphanRecordingListing
, Fixnum, Hash)>] OrphanRecordingListing
data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 980 def get_orphanrecordings_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#get_orphanrecordings ..." end # resource path local_var_path = "/api/v2/orphanrecordings".sub('{format}','json') # query parameters query_params = {} query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size'] query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number'] query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by'] query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page'] query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page'] query_params[:'hasConversation'] = opts[:'has_conversation'] if opts[:'has_conversation'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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 => 'OrphanRecordingListing') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#get_orphanrecordings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get encryption key list
@param [Hash] opts the optional parameters @option opts [Integer] :page_size Page
size (default to 25) @option opts [Integer] :page_number Page
number (default to 1) @return [EncryptionKeyEntityListing]
# File lib/purecloud/api/recording_api.rb, line 1035 def get_recordingkeys(opts = {}) data, status_code, headers = get_recordingkeys_with_http_info(opts) return data end
Get key rotation schedule
@param [Hash] opts the optional parameters @return [KeyRotationSchedule]
# File lib/purecloud/api/recording_api.rb, line 1094 def get_recordingkeys_rotationschedule(opts = {}) data, status_code, headers = get_recordingkeys_rotationschedule_with_http_info(opts) return data end
Get key rotation schedule
@param [Hash] opts the optional parameters @return [Array<(KeyRotationSchedule
, Fixnum, Hash)>] KeyRotationSchedule
data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 1103 def get_recordingkeys_rotationschedule_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#get_recordingkeys_rotationschedule ..." end # resource path local_var_path = "/api/v2/recording/recordingkeys/rotationschedule".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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 => 'KeyRotationSchedule') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#get_recordingkeys_rotationschedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get encryption key list
@param [Hash] opts the optional parameters @option opts [Integer] :page_size Page
size @option opts [Integer] :page_number Page
number @return [Array<(EncryptionKeyEntityListing
, Fixnum, Hash)>] EncryptionKeyEntityListing
data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 1046 def get_recordingkeys_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#get_recordingkeys ..." end # resource path local_var_path = "/api/v2/recording/recordingkeys".sub('{format}','json') # query parameters query_params = {} query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size'] query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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 => 'EncryptionKeyEntityListing') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#get_recordingkeys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get the Recording
Settings for the Organization
@param [Hash] opts the optional parameters @option opts [BOOLEAN] :create_default If no settings are found, a new one is created with default values (default to false) @return [RecordingSettings]
# File lib/purecloud/api/recording_api.rb, line 1150 def get_settings(opts = {}) data, status_code, headers = get_settings_with_http_info(opts) return data end
Get the Recording
Settings for the Organization
@param [Hash] opts the optional parameters @option opts [BOOLEAN] :create_default If no settings are found, a new one is created with default values @return [Array<(RecordingSettings
, Fixnum, Hash)>] RecordingSettings
data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 1160 def get_settings_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#get_settings ..." end # resource path local_var_path = "/api/v2/recording/settings".sub('{format}','json') # query parameters query_params = {} query_params[:'createDefault'] = opts[:'create_default'] if opts[:'create_default'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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: RecordingApi#get_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Retrieves a paged listing of screen recording sessions
@param [Hash] opts the optional parameters @option opts [Integer] :page_size Page
size (default to 25) @option opts [Integer] :page_number Page
number (default to 1) @return [ScreenRecordingSessionListing]
# File lib/purecloud/api/recording_api.rb, line 1209 def gets_screensessions(opts = {}) data, status_code, headers = gets_screensessions_with_http_info(opts) return data end
Retrieves a paged listing of screen recording sessions
@param [Hash] opts the optional parameters @option opts [Integer] :page_size Page
size @option opts [Integer] :page_number Page
number @return [Array<(ScreenRecordingSessionListing
, Fixnum, Hash)>] ScreenRecordingSessionListing
data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 1220 def gets_screensessions_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#gets_screensessions ..." end # resource path local_var_path = "/api/v2/recordings/screensessions".sub('{format}','json') # query parameters query_params = {} query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size'] query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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 => 'ScreenRecordingSessionListing') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#gets_screensessions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Patch a media retention policy
@param policy_id Policy
ID @param body Policy
@param [Hash] opts the optional parameters @return [Policy]
# File lib/purecloud/api/recording_api.rb, line 1270 def patch_mediaretentionpolicies_policy_id(policy_id, body, opts = {}) data, status_code, headers = patch_mediaretentionpolicies_policy_id_with_http_info(policy_id, body, opts) return data end
Patch a media retention policy
@param policy_id Policy
ID @param body Policy
@param [Hash] opts the optional parameters @return [Array<(Policy
, Fixnum, Hash)>] Policy
data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 1281 def patch_mediaretentionpolicies_policy_id_with_http_info(policy_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#patch_mediaretentionpolicies_policy_id ..." end # verify the required parameter 'policy_id' is set fail "Missing the required parameter 'policy_id' when calling patch_mediaretentionpolicies_policy_id" if policy_id.nil? # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling patch_mediaretentionpolicies_policy_id" if body.nil? # resource path local_var_path = "/api/v2/recording/mediaretentionpolicies/{policyId}".sub('{format}','json').sub('{' + 'policyId' + '}', policy_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] 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, :return_type => 'Policy') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#patch_mediaretentionpolicies_policy_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update a screen recording session
@param recording_session_id Screen recording session ID @param [Hash] opts the optional parameters @option opts [ScreenRecordingSessionRequest] :body @return [nil]
# File lib/purecloud/api/recording_api.rb, line 1335 def patch_screensessions_recordingsession_id(recording_session_id, opts = {}) patch_screensessions_recordingsession_id_with_http_info(recording_session_id, opts) return nil end
Update a screen recording session
@param recording_session_id Screen recording session ID @param [Hash] opts the optional parameters @option opts [ScreenRecordingSessionRequest] :body @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 1346 def patch_screensessions_recordingsession_id_with_http_info(recording_session_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#patch_screensessions_recordingsession_id ..." end # verify the required parameter 'recording_session_id' is set fail "Missing the required parameter 'recording_session_id' when calling patch_screensessions_recordingsession_id" if recording_session_id.nil? # resource path local_var_path = "/api/v2/recordings/screensessions/{recordingSessionId}".sub('{format}','json').sub('{' + 'recordingSessionId' + '}', recording_session_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'body']) auth_names = ['PureCloud Auth'] 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: RecordingApi#patch_screensessions_recordingsession_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create annotation
@param conversation_id Conversation
ID @param recording_id Recording
ID @param body annotation @param [Hash] opts the optional parameters @return [Annotation]
# File lib/purecloud/api/recording_api.rb, line 1397 def post_conversation_id_recordings_recording_id_annotations(conversation_id, recording_id, body, opts = {}) data, status_code, headers = post_conversation_id_recordings_recording_id_annotations_with_http_info(conversation_id, recording_id, body, opts) return data end
Create annotation
@param conversation_id Conversation
ID @param recording_id Recording
ID @param body annotation @param [Hash] opts the optional parameters @return [Array<(Annotation
, Fixnum, Hash)>] Annotation
data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 1409 def post_conversation_id_recordings_recording_id_annotations_with_http_info(conversation_id, recording_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#post_conversation_id_recordings_recording_id_annotations ..." end # verify the required parameter 'conversation_id' is set fail "Missing the required parameter 'conversation_id' when calling post_conversation_id_recordings_recording_id_annotations" if conversation_id.nil? # verify the required parameter 'recording_id' is set fail "Missing the required parameter 'recording_id' when calling post_conversation_id_recordings_recording_id_annotations" if recording_id.nil? # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling post_conversation_id_recordings_recording_id_annotations" if body.nil? # resource path local_var_path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] 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 => 'Annotation') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#post_conversation_id_recordings_recording_id_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
create a local recording key
@param body Local Encryption body @param [Hash] opts the optional parameters @return [EncryptionKey]
# File lib/purecloud/api/recording_api.rb, line 1465 def post_localkeys(body, opts = {}) data, status_code, headers = post_localkeys_with_http_info(body, opts) return data end
create settings for local key creation
@param body Local Encryption Configuration
@param [Hash] opts the optional parameters @return [LocalEncryptionConfiguration]
# File lib/purecloud/api/recording_api.rb, line 1525 def post_localkeys_settings(body, opts = {}) data, status_code, headers = post_localkeys_settings_with_http_info(body, opts) return data end
create settings for local key creation
@param body Local Encryption Configuration
@param [Hash] opts the optional parameters @return [Array<(LocalEncryptionConfiguration
, Fixnum, Hash)>] LocalEncryptionConfiguration
data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 1535 def post_localkeys_settings_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#post_localkeys_settings ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling post_localkeys_settings" if body.nil? # resource path local_var_path = "/api/v2/recording/localkeys/settings".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] 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 => 'LocalEncryptionConfiguration') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#post_localkeys_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
create a local recording key
@param body Local Encryption body @param [Hash] opts the optional parameters @return [Array<(EncryptionKey
, Fixnum, Hash)>] EncryptionKey
data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 1475 def post_localkeys_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#post_localkeys ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling post_localkeys" if body.nil? # resource path local_var_path = "/api/v2/recording/localkeys".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] 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 => 'EncryptionKey') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#post_localkeys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create media retention policy
@param body Policy
@param [Hash] opts the optional parameters @return [Policy]
# File lib/purecloud/api/recording_api.rb, line 1585 def post_mediaretentionpolicies(body, opts = {}) data, status_code, headers = post_mediaretentionpolicies_with_http_info(body, opts) return data end
Create media retention policy
@param body Policy
@param [Hash] opts the optional parameters @return [Array<(Policy
, Fixnum, Hash)>] Policy
data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 1595 def post_mediaretentionpolicies_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#post_mediaretentionpolicies ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling post_mediaretentionpolicies" if body.nil? # resource path local_var_path = "/api/v2/recording/mediaretentionpolicies".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] 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 => 'Policy') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#post_mediaretentionpolicies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create encryption key
@param [Hash] opts the optional parameters @return [EncryptionKey]
# File lib/purecloud/api/recording_api.rb, line 1644 def post_recordingkeys(opts = {}) data, status_code, headers = post_recordingkeys_with_http_info(opts) return data end
Create encryption key
@param [Hash] opts the optional parameters @return [Array<(EncryptionKey
, Fixnum, Hash)>] EncryptionKey
data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 1653 def post_recordingkeys_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#post_recordingkeys ..." end # resource path local_var_path = "/api/v2/recording/recordingkeys".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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 => 'EncryptionKey') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#post_recordingkeys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Updates the retention records on a recording. Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. @param conversation_id Conversation
ID @param recording_id Recording
ID @param body recording @param [Hash] opts the optional parameters @return [Recording]
# File lib/purecloud/api/recording_api.rb, line 1702 def put_conversation_id_recordings_recording_id(conversation_id, recording_id, body, opts = {}) data, status_code, headers = put_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, body, opts) return data end
Update annotation
@param conversation_id Conversation
ID @param recording_id Recording
ID @param annotation_id Annotation
ID @param body annotation @param [Hash] opts the optional parameters @return [Annotation]
# File lib/purecloud/api/recording_api.rb, line 1773 def put_conversation_id_recordings_recording_id_annotations_annotation_id(conversation_id, recording_id, annotation_id, body, opts = {}) data, status_code, headers = put_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, body, opts) return data end
Update annotation
@param conversation_id Conversation
ID @param recording_id Recording
ID @param annotation_id Annotation
ID @param body annotation @param [Hash] opts the optional parameters @return [Array<(Annotation
, Fixnum, Hash)>] Annotation
data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 1786 def put_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#put_conversation_id_recordings_recording_id_annotations_annotation_id ..." end # verify the required parameter 'conversation_id' is set fail "Missing the required parameter 'conversation_id' when calling put_conversation_id_recordings_recording_id_annotations_annotation_id" if conversation_id.nil? # verify the required parameter 'recording_id' is set fail "Missing the required parameter 'recording_id' when calling put_conversation_id_recordings_recording_id_annotations_annotation_id" if recording_id.nil? # verify the required parameter 'annotation_id' is set fail "Missing the required parameter 'annotation_id' when calling put_conversation_id_recordings_recording_id_annotations_annotation_id" if annotation_id.nil? # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling put_conversation_id_recordings_recording_id_annotations_annotation_id" if body.nil? # resource path local_var_path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] 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, :return_type => 'Annotation') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#put_conversation_id_recordings_recording_id_annotations_annotation_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Updates the retention records on a recording. Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. @param conversation_id Conversation
ID @param recording_id Recording
ID @param body recording @param [Hash] opts the optional parameters @return [Array<(Recording
, Fixnum, Hash)>] Recording
data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 1714 def put_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#put_conversation_id_recordings_recording_id ..." end # verify the required parameter 'conversation_id' is set fail "Missing the required parameter 'conversation_id' when calling put_conversation_id_recordings_recording_id" if conversation_id.nil? # verify the required parameter 'recording_id' is set fail "Missing the required parameter 'recording_id' when calling put_conversation_id_recordings_recording_id" if recording_id.nil? # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling put_conversation_id_recordings_recording_id" if body.nil? # resource path local_var_path = "/api/v2/conversations/{conversationId}/recordings/{recordingId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] 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, :return_type => 'Recording') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#put_conversation_id_recordings_recording_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update the local encryption settings
@param settings_id Settings Id @param body Local Encryption metadata @param [Hash] opts the optional parameters @return [LocalEncryptionConfiguration]
# File lib/purecloud/api/recording_api.rb, line 1846 def put_localkeys_settings_settings_id(settings_id, body, opts = {}) data, status_code, headers = put_localkeys_settings_settings_id_with_http_info(settings_id, body, opts) return data end
Update the local encryption settings
@param settings_id Settings Id @param body Local Encryption metadata @param [Hash] opts the optional parameters @return [Array<(LocalEncryptionConfiguration
, Fixnum, Hash)>] LocalEncryptionConfiguration
data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 1857 def put_localkeys_settings_settings_id_with_http_info(settings_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#put_localkeys_settings_settings_id ..." end # verify the required parameter 'settings_id' is set fail "Missing the required parameter 'settings_id' when calling put_localkeys_settings_settings_id" if settings_id.nil? # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling put_localkeys_settings_settings_id" if body.nil? # resource path local_var_path = "/api/v2/recording/localkeys/settings/{settingsId}".sub('{format}','json').sub('{' + 'settingsId' + '}', settings_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] 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, :return_type => 'LocalEncryptionConfiguration') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#put_localkeys_settings_settings_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update a media retention policy
@param policy_id Policy
ID @param body Policy
@param [Hash] opts the optional parameters @return [Policy]
# File lib/purecloud/api/recording_api.rb, line 1911 def put_mediaretentionpolicies_policy_id(policy_id, body, opts = {}) data, status_code, headers = put_mediaretentionpolicies_policy_id_with_http_info(policy_id, body, opts) return data end
Update a media retention policy
@param policy_id Policy
ID @param body Policy
@param [Hash] opts the optional parameters @return [Array<(Policy
, Fixnum, Hash)>] Policy
data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 1922 def put_mediaretentionpolicies_policy_id_with_http_info(policy_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#put_mediaretentionpolicies_policy_id ..." end # verify the required parameter 'policy_id' is set fail "Missing the required parameter 'policy_id' when calling put_mediaretentionpolicies_policy_id" if policy_id.nil? # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling put_mediaretentionpolicies_policy_id" if body.nil? # resource path local_var_path = "/api/v2/recording/mediaretentionpolicies/{policyId}".sub('{format}','json').sub('{' + 'policyId' + '}', policy_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] 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, :return_type => 'Policy') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#put_mediaretentionpolicies_policy_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Updates an orphan recording to a regular recording with retention values If this operation is successful the orphan will no longer exist. It will be replaced by the resulting recording in the response. This replacement recording is accessible by the normal Recording
api. @param orphan_id Orphan ID @param [Hash] opts the optional parameters @option opts [OrphanUpdateRequest] :body @return [Recording]
# File lib/purecloud/api/recording_api.rb, line 1976 def put_orphan_id(orphan_id, opts = {}) data, status_code, headers = put_orphan_id_with_http_info(orphan_id, opts) return data end
Updates an orphan recording to a regular recording with retention values If this operation is successful the orphan will no longer exist. It will be replaced by the resulting recording in the response. This replacement recording is accessible by the normal Recording
api. @param orphan_id Orphan ID @param [Hash] opts the optional parameters @option opts [OrphanUpdateRequest] :body @return [Array<(Recording
, Fixnum, Hash)>] Recording
data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 1987 def put_orphan_id_with_http_info(orphan_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#put_orphan_id ..." end # verify the required parameter 'orphan_id' is set fail "Missing the required parameter 'orphan_id' when calling put_orphan_id" if orphan_id.nil? # resource path local_var_path = "/api/v2/orphanrecordings/{orphanId}".sub('{format}','json').sub('{' + 'orphanId' + '}', orphan_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'body']) auth_names = ['PureCloud Auth'] 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, :return_type => 'Recording') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#put_orphan_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update key rotation schedule
@param body KeyRotationSchedule
@param [Hash] opts the optional parameters @return [KeyRotationSchedule]
# File lib/purecloud/api/recording_api.rb, line 2037 def put_recordingkeys_rotationschedule(body, opts = {}) data, status_code, headers = put_recordingkeys_rotationschedule_with_http_info(body, opts) return data end
Update key rotation schedule
@param body KeyRotationSchedule
@param [Hash] opts the optional parameters @return [Array<(KeyRotationSchedule
, Fixnum, Hash)>] KeyRotationSchedule
data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 2047 def put_recordingkeys_rotationschedule_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#put_recordingkeys_rotationschedule ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling put_recordingkeys_rotationschedule" if body.nil? # resource path local_var_path = "/api/v2/recording/recordingkeys/rotationschedule".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] 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, :return_type => 'KeyRotationSchedule') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#put_recordingkeys_rotationschedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update the Recording
Settings for the Organization
@param body Recording
settings @param [Hash] opts the optional parameters @return [RecordingSettings]
# File lib/purecloud/api/recording_api.rb, line 2097 def put_settings(body, opts = {}) data, status_code, headers = put_settings_with_http_info(body, opts) return data end
Update the Recording
Settings for the Organization
@param body Recording
settings @param [Hash] opts the optional parameters @return [Array<(RecordingSettings
, Fixnum, Hash)>] RecordingSettings
data, response status code and response headers
# File lib/purecloud/api/recording_api.rb, line 2107 def put_settings_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RecordingApi#put_settings ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling put_settings" if body.nil? # resource path local_var_path = "/api/v2/recording/settings".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] 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, :return_type => 'RecordingSettings') if @api_client.config.debugging @api_client.config.logger.debug "API called: RecordingApi#put_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end