---
title: RecordingApi
---

## PureCloud::RecordingApi

All URIs are relative to *https://api.mypurecloud.com*

Method | HTTP request | Description
------------- | ------------- | -------------
|[**delete_conversation_id_recordings_recording_id_annotations_annotation_id**](RecordingApi.html#delete_conversation_id_recordings_recording_id_annotations_annotation_id) | **DELETE** /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId} | Delete annotation|
|[**delete_mediaretentionpolicies**](RecordingApi.html#delete_mediaretentionpolicies) | **DELETE** /api/v2/recording/mediaretentionpolicies | Delete media retention policies|
|[**delete_mediaretentionpolicies_policy_id**](RecordingApi.html#delete_mediaretentionpolicies_policy_id) | **DELETE** /api/v2/recording/mediaretentionpolicies/{policyId} | Delete a media retention policy|
|[**delete_orphan_id**](RecordingApi.html#delete_orphan_id) | **DELETE** /api/v2/orphanrecordings/{orphanId} |  deletes a single orphan recording|
|[**get_conversation_id_recordings**](RecordingApi.html#get_conversation_id_recordings) | **GET** /api/v2/conversations/{conversationId}/recordings | Get all of a Conversation's Recordings.|
|[**get_conversation_id_recordings_recording_id**](RecordingApi.html#get_conversation_id_recordings_recording_id) | **GET** /api/v2/conversations/{conversationId}/recordings/{recordingId} | Gets a specific recording.|
|[**get_conversation_id_recordings_recording_id_annotations**](RecordingApi.html#get_conversation_id_recordings_recording_id_annotations) | **GET** /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations | Get annotations for recording|
|[**get_conversation_id_recordings_recording_id_annotations_annotation_id**](RecordingApi.html#get_conversation_id_recordings_recording_id_annotations_annotation_id) | **GET** /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId} | Get annotation|
|[**get_mediaretentionpolicies**](RecordingApi.html#get_mediaretentionpolicies) | **GET** /api/v2/recording/mediaretentionpolicies | Gets media retention policy list with query options to filter on name and enabled.|
|[**get_mediaretentionpolicies_policy_id**](RecordingApi.html#get_mediaretentionpolicies_policy_id) | **GET** /api/v2/recording/mediaretentionpolicies/{policyId} | Get a media retention policy|
|[**get_orphan_id**](RecordingApi.html#get_orphan_id) | **GET** /api/v2/orphanrecordings/{orphanId} | Gets a single orphan recording|
|[**get_orphanrecordings**](RecordingApi.html#get_orphanrecordings) | **GET** /api/v2/orphanrecordings | Gets all orphan recordings|
|[**get_settings**](RecordingApi.html#get_settings) | **GET** /api/v2/recording/settings | Get the Recording Settings for the Organization|
|[**gets_screensessions**](RecordingApi.html#gets_screensessions) | **GET** /api/v2/recordings/screensessions | Retrieves a paged listing of screen recording sessions|
|[**patch_mediaretentionpolicies_policy_id**](RecordingApi.html#patch_mediaretentionpolicies_policy_id) | **PATCH** /api/v2/recording/mediaretentionpolicies/{policyId} | Patch a media retention policy|
|[**patchs_screensessions_recordingsession_id**](RecordingApi.html#patchs_screensessions_recordingsession_id) | **PATCH** /api/v2/recordings/screensessions/{recordingSessionId} | Update a screen recording session|
|[**post_conversation_id_recordings_recording_id_annotations**](RecordingApi.html#post_conversation_id_recordings_recording_id_annotations) | **POST** /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations | Create annotation|
|[**post_mediaretentionpolicies**](RecordingApi.html#post_mediaretentionpolicies) | **POST** /api/v2/recording/mediaretentionpolicies | Create media retention policy|
|[**put_conversation_id_recordings_recording_id**](RecordingApi.html#put_conversation_id_recordings_recording_id) | **PUT** /api/v2/conversations/{conversationId}/recordings/{recordingId} | Updates the retention records on a recording.|
|[**put_conversation_id_recordings_recording_id_annotations_annotation_id**](RecordingApi.html#put_conversation_id_recordings_recording_id_annotations_annotation_id) | **PUT** /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId} | Update annotation|
|[**put_mediaretentionpolicies_policy_id**](RecordingApi.html#put_mediaretentionpolicies_policy_id) | **PUT** /api/v2/recording/mediaretentionpolicies/{policyId} | Update a media retention policy|
|[**put_settings**](RecordingApi.html#put_settings) | **PUT** /api/v2/recording/settings | Update the Recording Settings for the Organization|
{: class="table table-striped"}

<a name="delete_conversation_id_recordings_recording_id_annotations_annotation_id"></a>

## - delete_conversation_id_recordings_recording_id_annotations_annotation_id(conversation_id, recording_id, annotation_id)

Delete annotation



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::RecordingApi.new

conversation_id = "conversation_id_example" # String | Conversation ID

recording_id = "recording_id_example" # String | Recording ID

annotation_id = "annotation_id_example" # String | Annotation ID


begin
  #Delete annotation
  api_instance.delete_conversation_id_recordings_recording_id_annotations_annotation_id(conversation_id, recording_id, annotation_id)
rescue PureCloud::ApiError => e
  puts "Exception when calling RecordingApi->delete_conversation_id_recordings_recording_id_annotations_annotation_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **conversation_id** | **String**| Conversation ID | 
 **recording_id** | **String**| Recording ID | 
 **annotation_id** | **String**| Annotation ID | 
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="delete_mediaretentionpolicies"></a>

## -String** delete_mediaretentionpolicies(ids)

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.

### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::RecordingApi.new

ids = "ids_example" # String | 


begin
  #Delete media retention policies
  result = api_instance.delete_mediaretentionpolicies(ids)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling RecordingApi->delete_mediaretentionpolicies: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ids** | **String**|  | 
{: class="table table-striped"}


### Return type

**String**

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="delete_mediaretentionpolicies_policy_id"></a>

## -String** delete_mediaretentionpolicies_policy_id(policy_id)

Delete a media retention policy



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::RecordingApi.new

policy_id = "policy_id_example" # String | Policy ID


begin
  #Delete a media retention policy
  result = api_instance.delete_mediaretentionpolicies_policy_id(policy_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling RecordingApi->delete_mediaretentionpolicies_policy_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **policy_id** | **String**| Policy ID | 
{: class="table table-striped"}


### Return type

**String**

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="delete_orphan_id"></a>

## -[**OrphanRecording**](OrphanRecording.html) delete_orphan_id(orphan_id)

 deletes a single orphan recording



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::RecordingApi.new

orphan_id = "orphan_id_example" # String | Orphan ID


begin
  # deletes a single orphan recording
  result = api_instance.delete_orphan_id(orphan_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling RecordingApi->delete_orphan_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **orphan_id** | **String**| Orphan ID | 
{: class="table table-striped"}


### Return type

[**OrphanRecording**](OrphanRecording.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_conversation_id_recordings"></a>

## -[**Array&lt;Recording&gt;**](Recording.html) get_conversation_id_recordings(conversation_id, opts)

Get all of a Conversation's Recordings.



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::RecordingApi.new

conversation_id = "conversation_id_example" # String | Conversation ID

opts = { 
  max_wait_ms: 5000, # Integer | The maximum number of milliseconds to wait for the recording to be ready.
  format_id: "WEBM" # String | The desired media format
}

begin
  #Get all of a Conversation's Recordings.
  result = api_instance.get_conversation_id_recordings(conversation_id, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling RecordingApi->get_conversation_id_recordings: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **conversation_id** | **String**| Conversation ID | 
 **max_wait_ms** | **Integer**| The maximum number of milliseconds to wait for the recording to be ready. | [optional] [default to 5000]
 **format_id** | **String**| The desired media format | [optional] [default to WEBM]
{: class="table table-striped"}


### Return type

[**Array&lt;Recording&gt;**](Recording.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_conversation_id_recordings_recording_id"></a>

## - get_conversation_id_recordings_recording_id(conversation_id, recording_id, opts)

Gets a specific recording.



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::RecordingApi.new

conversation_id = "conversation_id_example" # String | Conversation ID

recording_id = "recording_id_example" # String | Recording ID

opts = { 
  format_id: "WEBM", # String | The desired media format.
  download: false, # BOOLEAN | requesting a download format of the recording
  file_name: "file_name_example" # String | the name of the downloaded fileName
}

begin
  #Gets a specific recording.
  api_instance.get_conversation_id_recordings_recording_id(conversation_id, recording_id, opts)
rescue PureCloud::ApiError => e
  puts "Exception when calling RecordingApi->get_conversation_id_recordings_recording_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **conversation_id** | **String**| Conversation ID | 
 **recording_id** | **String**| Recording ID | 
 **format_id** | **String**| The desired media format. | [optional] [default to WEBM]
 **download** | **BOOLEAN**| requesting a download format of the recording | [optional] [default to false]
 **file_name** | **String**| the name of the downloaded fileName | [optional] 
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_conversation_id_recordings_recording_id_annotations"></a>

## -[**Array&lt;Annotation&gt;**](Annotation.html) get_conversation_id_recordings_recording_id_annotations(conversation_id, recording_id)

Get annotations for recording



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::RecordingApi.new

conversation_id = "conversation_id_example" # String | Conversation ID

recording_id = "recording_id_example" # String | Recording ID


begin
  #Get annotations for recording
  result = api_instance.get_conversation_id_recordings_recording_id_annotations(conversation_id, recording_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling RecordingApi->get_conversation_id_recordings_recording_id_annotations: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **conversation_id** | **String**| Conversation ID | 
 **recording_id** | **String**| Recording ID | 
{: class="table table-striped"}


### Return type

[**Array&lt;Annotation&gt;**](Annotation.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_conversation_id_recordings_recording_id_annotations_annotation_id"></a>

## -[**Annotation**](Annotation.html) get_conversation_id_recordings_recording_id_annotations_annotation_id(conversation_id, recording_id, annotation_id)

Get annotation



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::RecordingApi.new

conversation_id = "conversation_id_example" # String | Conversation ID

recording_id = "recording_id_example" # String | Recording ID

annotation_id = "annotation_id_example" # String | Annotation ID


begin
  #Get annotation
  result = api_instance.get_conversation_id_recordings_recording_id_annotations_annotation_id(conversation_id, recording_id, annotation_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling RecordingApi->get_conversation_id_recordings_recording_id_annotations_annotation_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **conversation_id** | **String**| Conversation ID | 
 **recording_id** | **String**| Recording ID | 
 **annotation_id** | **String**| Annotation ID | 
{: class="table table-striped"}


### Return type

[**Annotation**](Annotation.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_mediaretentionpolicies"></a>

## -[**PolicyEntityListing**](PolicyEntityListing.html) get_mediaretentionpolicies(opts)

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

### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::RecordingApi.new

opts = { 
  page_size: 25, # Integer | The total page size requested
  page_number: 1, # Integer | The page number requested
  sort_by: "sort_by_example", # String | variable name requested to sort by
  expand: nil, # Array<Object> | variable name requested by expand list
  next_page: "next_page_example", # String | next page token
  previous_page: "previous_page_example", # String | Previous page token
  name: "name_example", # String | the policy name - used for filtering results in searches.
  enabled: true, # BOOLEAN | checks to see if policy is enabled - use enabled = true or enabled = false
  summary: false, # BOOLEAN | provides a less verbose response of policy lists.
  has_errors: true # BOOLEAN | provides a way to fetch all policies with errors or policies that do not have errors
}

begin
  #Gets media retention policy list with query options to filter on name and enabled.
  result = api_instance.get_mediaretentionpolicies(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling RecordingApi->get_mediaretentionpolicies: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **page_size** | **Integer**| The total page size requested | [optional] [default to 25]
 **page_number** | **Integer**| The page number requested | [optional] [default to 1]
 **sort_by** | **String**| variable name requested to sort by | [optional] 
 **expand** | [**Array&lt;Object&gt;**](Object.html)| variable name requested by expand list | [optional] 
 **next_page** | **String**| next page token | [optional] 
 **previous_page** | **String**| Previous page token | [optional] 
 **name** | **String**| the policy name - used for filtering results in searches. | [optional] 
 **enabled** | **BOOLEAN**| checks to see if policy is enabled - use enabled = true or enabled = false | [optional] 
 **summary** | **BOOLEAN**| provides a less verbose response of policy lists. | [optional] [default to false]
 **has_errors** | **BOOLEAN**| provides a way to fetch all policies with errors or policies that do not have errors | [optional] 
{: class="table table-striped"}


### Return type

[**PolicyEntityListing**](PolicyEntityListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_mediaretentionpolicies_policy_id"></a>

## -[**Policy**](Policy.html) get_mediaretentionpolicies_policy_id(policy_id)

Get a media retention policy



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::RecordingApi.new

policy_id = "policy_id_example" # String | Policy ID


begin
  #Get a media retention policy
  result = api_instance.get_mediaretentionpolicies_policy_id(policy_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling RecordingApi->get_mediaretentionpolicies_policy_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **policy_id** | **String**| Policy ID | 
{: class="table table-striped"}


### Return type

[**Policy**](Policy.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_orphan_id"></a>

## -[**OrphanRecording**](OrphanRecording.html) get_orphan_id(orphan_id)

Gets a single orphan recording



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::RecordingApi.new

orphan_id = "orphan_id_example" # String | Orphan ID


begin
  #Gets a single orphan recording
  result = api_instance.get_orphan_id(orphan_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling RecordingApi->get_orphan_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **orphan_id** | **String**| Orphan ID | 
{: class="table table-striped"}


### Return type

[**OrphanRecording**](OrphanRecording.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_orphanrecordings"></a>

## -[**OrphanRecordingListing**](OrphanRecordingListing.html) get_orphanrecordings(opts)

Gets all orphan recordings



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::RecordingApi.new

opts = { 
  page_size: 25, # Integer | The total page size requested
  page_number: 1, # Integer | The page number requested
  sort_by: "sort_by_example", # String | variable name requested to sort by
  expand: nil, # Array<Object> | variable name requested by expand list
  next_page: "next_page_example", # String | next page token
  previous_page: "previous_page_example" # String | Previous page token
}

begin
  #Gets all orphan recordings
  result = api_instance.get_orphanrecordings(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling RecordingApi->get_orphanrecordings: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **page_size** | **Integer**| The total page size requested | [optional] [default to 25]
 **page_number** | **Integer**| The page number requested | [optional] [default to 1]
 **sort_by** | **String**| variable name requested to sort by | [optional] 
 **expand** | [**Array&lt;Object&gt;**](Object.html)| variable name requested by expand list | [optional] 
 **next_page** | **String**| next page token | [optional] 
 **previous_page** | **String**| Previous page token | [optional] 
{: class="table table-striped"}


### Return type

[**OrphanRecordingListing**](OrphanRecordingListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_settings"></a>

## -[**RecordingSettings**](RecordingSettings.html) get_settings(opts)

Get the Recording Settings for the Organization



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::RecordingApi.new

opts = { 
  create_default: false # BOOLEAN | If no settings are found, a new one is created with default values
}

begin
  #Get the Recording Settings for the Organization
  result = api_instance.get_settings(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling RecordingApi->get_settings: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **create_default** | **BOOLEAN**| If no settings are found, a new one is created with default values | [optional] [default to false]
{: class="table table-striped"}


### Return type

[**RecordingSettings**](RecordingSettings.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="gets_screensessions"></a>

## -[**ScreenRecordingSessionListing**](ScreenRecordingSessionListing.html) gets_screensessions(opts)

Retrieves a paged listing of screen recording sessions



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::RecordingApi.new

opts = { 
  page_size: 25, # Integer | Page size
  page_number: 1 # Integer | Page number
}

begin
  #Retrieves a paged listing of screen recording sessions
  result = api_instance.gets_screensessions(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling RecordingApi->gets_screensessions: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **page_size** | **Integer**| Page size | [optional] [default to 25]
 **page_number** | **Integer**| Page number | [optional] [default to 1]
{: class="table table-striped"}


### Return type

[**ScreenRecordingSessionListing**](ScreenRecordingSessionListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="patch_mediaretentionpolicies_policy_id"></a>

## -[**Policy**](Policy.html) patch_mediaretentionpolicies_policy_id(policy_id, body)

Patch a media retention policy



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::RecordingApi.new

policy_id = "policy_id_example" # String | Policy ID

body = PureCloud::Policy.new # Policy | Policy


begin
  #Patch a media retention policy
  result = api_instance.patch_mediaretentionpolicies_policy_id(policy_id, body)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling RecordingApi->patch_mediaretentionpolicies_policy_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **policy_id** | **String**| Policy ID | 
 **body** | [**Policy**](Policy.html)| Policy | 
{: class="table table-striped"}


### Return type

[**Policy**](Policy.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="patchs_screensessions_recordingsession_id"></a>

## - patchs_screensessions_recordingsession_id(recording_session_id, opts)

Update a screen recording session



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::RecordingApi.new

recording_session_id = "recording_session_id_example" # String | Screen recording session ID

opts = { 
  body: PureCloud::ScreenRecordingSessionRequest.new # ScreenRecordingSessionRequest | 
}

begin
  #Update a screen recording session
  api_instance.patchs_screensessions_recordingsession_id(recording_session_id, opts)
rescue PureCloud::ApiError => e
  puts "Exception when calling RecordingApi->patchs_screensessions_recordingsession_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **recording_session_id** | **String**| Screen recording session ID | 
 **body** | [**ScreenRecordingSessionRequest**](ScreenRecordingSessionRequest.html)|  | [optional] 
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_conversation_id_recordings_recording_id_annotations"></a>

## -[**Annotation**](Annotation.html) post_conversation_id_recordings_recording_id_annotations(conversation_id, recording_id, body)

Create annotation



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::RecordingApi.new

conversation_id = "conversation_id_example" # String | Conversation ID

recording_id = "recording_id_example" # String | Recording ID

body = PureCloud::Annotation.new # Annotation | annotation


begin
  #Create annotation
  result = api_instance.post_conversation_id_recordings_recording_id_annotations(conversation_id, recording_id, body)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling RecordingApi->post_conversation_id_recordings_recording_id_annotations: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **conversation_id** | **String**| Conversation ID | 
 **recording_id** | **String**| Recording ID | 
 **body** | [**Annotation**](Annotation.html)| annotation | 
{: class="table table-striped"}


### Return type

[**Annotation**](Annotation.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_mediaretentionpolicies"></a>

## -[**Policy**](Policy.html) post_mediaretentionpolicies(body)

Create media retention policy



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::RecordingApi.new

body = PureCloud::PolicyCreate.new # PolicyCreate | Policy


begin
  #Create media retention policy
  result = api_instance.post_mediaretentionpolicies(body)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling RecordingApi->post_mediaretentionpolicies: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**PolicyCreate**](PolicyCreate.html)| Policy | 
{: class="table table-striped"}


### Return type

[**Policy**](Policy.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="put_conversation_id_recordings_recording_id"></a>

## - put_conversation_id_recordings_recording_id(conversation_id, recording_id, body)

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. 

### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::RecordingApi.new

conversation_id = "conversation_id_example" # String | Conversation ID

recording_id = "recording_id_example" # String | Recording ID

body = PureCloud::Recording.new # Recording | recording


begin
  #Updates the retention records on a recording.
  api_instance.put_conversation_id_recordings_recording_id(conversation_id, recording_id, body)
rescue PureCloud::ApiError => e
  puts "Exception when calling RecordingApi->put_conversation_id_recordings_recording_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **conversation_id** | **String**| Conversation ID | 
 **recording_id** | **String**| Recording ID | 
 **body** | [**Recording**](Recording.html)| recording | 
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="put_conversation_id_recordings_recording_id_annotations_annotation_id"></a>

## -[**Annotation**](Annotation.html) put_conversation_id_recordings_recording_id_annotations_annotation_id(conversation_id, recording_id, annotation_id, body)

Update annotation



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::RecordingApi.new

conversation_id = "conversation_id_example" # String | Conversation ID

recording_id = "recording_id_example" # String | Recording ID

annotation_id = "annotation_id_example" # String | Annotation ID

body = PureCloud::Annotation.new # Annotation | annotation


begin
  #Update annotation
  result = api_instance.put_conversation_id_recordings_recording_id_annotations_annotation_id(conversation_id, recording_id, annotation_id, body)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling RecordingApi->put_conversation_id_recordings_recording_id_annotations_annotation_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **conversation_id** | **String**| Conversation ID | 
 **recording_id** | **String**| Recording ID | 
 **annotation_id** | **String**| Annotation ID | 
 **body** | [**Annotation**](Annotation.html)| annotation | 
{: class="table table-striped"}


### Return type

[**Annotation**](Annotation.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="put_mediaretentionpolicies_policy_id"></a>

## -[**Policy**](Policy.html) put_mediaretentionpolicies_policy_id(policy_id, body)

Update a media retention policy



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::RecordingApi.new

policy_id = "policy_id_example" # String | Policy ID

body = PureCloud::Policy.new # Policy | Policy


begin
  #Update a media retention policy
  result = api_instance.put_mediaretentionpolicies_policy_id(policy_id, body)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling RecordingApi->put_mediaretentionpolicies_policy_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **policy_id** | **String**| Policy ID | 
 **body** | [**Policy**](Policy.html)| Policy | 
{: class="table table-striped"}


### Return type

[**Policy**](Policy.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="put_settings"></a>

## -[**RecordingSettings**](RecordingSettings.html) put_settings(body)

Update the Recording Settings for the Organization



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::RecordingApi.new

body = PureCloud::RecordingSettings.new # RecordingSettings | Recording settings


begin
  #Update the Recording Settings for the Organization
  result = api_instance.put_settings(body)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling RecordingApi->put_settings: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**RecordingSettings**](RecordingSettings.html)| Recording settings | 
{: class="table table-striped"}


### Return type

[**RecordingSettings**](RecordingSettings.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json