--- 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**](RecordingApi.html#get) | **GET** /api/v2/orphanrecordings | Gets all orphan recordings| |[**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_localkeys_settings**](RecordingApi.html#get_localkeys_settings) | **GET** /api/v2/recording/localkeys/settings | gets a list local key settings data| |[**get_localkeys_settings_settings_id**](RecordingApi.html#get_localkeys_settings_settings_id) | **GET** /api/v2/recording/localkeys/settings/{settingsId} | Get the local encryption settings| |[**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_orphan_id_media**](RecordingApi.html#get_orphan_id_media) | **GET** /api/v2/orphanrecordings/{orphanId}/media | Gets the media of a single orphan recording| |[**get_recordingkeys**](RecordingApi.html#get_recordingkeys) | **GET** /api/v2/recording/recordingkeys | Get encryption key list| |[**get_recordingkeys_rotationschedule**](RecordingApi.html#get_recordingkeys_rotationschedule) | **GET** /api/v2/recording/recordingkeys/rotationschedule | Get key rotation schedule| |[**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_localkeys**](RecordingApi.html#post_localkeys) | **POST** /api/v2/recording/localkeys | create a local recording key| |[**post_localkeys_settings**](RecordingApi.html#post_localkeys_settings) | **POST** /api/v2/recording/localkeys/settings | create settings for local key creation| |[**post_mediaretentionpolicies**](RecordingApi.html#post_mediaretentionpolicies) | **POST** /api/v2/recording/mediaretentionpolicies | Create media retention policy| |[**post_recordingkeys**](RecordingApi.html#post_recordingkeys) | **POST** /api/v2/recording/recordingkeys | Create encryption key| |[**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_localkeys_settings_settings_id**](RecordingApi.html#put_localkeys_settings_settings_id) | **PUT** /api/v2/recording/localkeys/settings/{settingsId} | Update the local encryption settings| |[**put_mediaretentionpolicies_policy_id**](RecordingApi.html#put_mediaretentionpolicies_policy_id) | **PUT** /api/v2/recording/mediaretentionpolicies/{policyId} | Update a media retention policy| |[**put_orphan_id**](RecordingApi.html#put_orphan_id) | **PUT** /api/v2/orphanrecordings/{orphanId} | Updates an orphan recording to a regular recording with retention values| |[**put_recordingkeys_rotationschedule**](RecordingApi.html#put_recordingkeys_rotationschedule) | **PUT** /api/v2/recording/recordingkeys/rotationschedule | Update key rotation schedule| |[**put_settings**](RecordingApi.html#put_settings) | **PUT** /api/v2/recording/settings | Update the Recording Settings for the Organization| {: class="table table-striped"} ## - 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 ## -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 ## -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 ## -[**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 ## -[**OrphanRecordingListing**](OrphanRecordingListing.html) get(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 | variable name requested by expand list next_page: "next_page_example", # String | next page token previous_page: "previous_page_example", # String | Previous page token has_conversation: false # BOOLEAN | Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization. } begin #Gets all orphan recordings result = api_instance.get(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling RecordingApi->get: #{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<Object>**](Object.html)| variable name requested by expand list | [optional] **next_page** | **String**| next page token | [optional] **previous_page** | **String**| Previous page token | [optional] **has_conversation** | **BOOLEAN**| Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization. | [optional] [default to false] {: class="table table-striped"} ### Return type [**OrphanRecordingListing**](OrphanRecordingListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Array<Recording>**](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. Must be a positive value. 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. Must be a positive value. | [optional] [default to 5000] **format_id** | **String**| The desired media format | [optional] [default to WEBM] {: class="table table-striped"} ### Return type [**Array<Recording>**](Recording.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Recording**](Recording.html) 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. result = api_instance.get_conversation_id_recordings_recording_id(conversation_id, recording_id, opts) p result 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 [**Recording**](Recording.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Array<Annotation>**](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<Annotation>**](Annotation.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**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 ## -[**LocalEncryptionConfigurationListing**](LocalEncryptionConfigurationListing.html) get_localkeys_settings gets a list local key settings data ### 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 begin #gets a list local key settings data result = api_instance.get_localkeys_settings p result rescue PureCloud::ApiError => e puts "Exception when calling RecordingApi->get_localkeys_settings: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type [**LocalEncryptionConfigurationListing**](LocalEncryptionConfigurationListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**LocalEncryptionConfiguration**](LocalEncryptionConfiguration.html) get_localkeys_settings_settings_id(settings_id) Get the local encryption settings ### 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 settings_id = "settings_id_example" # String | Settings Id begin #Get the local encryption settings result = api_instance.get_localkeys_settings_settings_id(settings_id) p result rescue PureCloud::ApiError => e puts "Exception when calling RecordingApi->get_localkeys_settings_settings_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settings_id** | **String**| Settings Id | {: class="table table-striped"} ### Return type [**LocalEncryptionConfiguration**](LocalEncryptionConfiguration.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**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 | 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<Object>**](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 ## -[**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 ## -[**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 ## -[**Recording**](Recording.html) get_orphan_id_media(orphan_id, opts) 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. ### 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 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 the media of a single orphan recording result = api_instance.get_orphan_id_media(orphan_id, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling RecordingApi->get_orphan_id_media: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orphan_id** | **String**| Orphan 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 [**Recording**](Recording.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**EncryptionKeyEntityListing**](EncryptionKeyEntityListing.html) get_recordingkeys(opts) Get encryption key list ### 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 #Get encryption key list result = api_instance.get_recordingkeys(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling RecordingApi->get_recordingkeys: #{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 [**EncryptionKeyEntityListing**](EncryptionKeyEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**KeyRotationSchedule**](KeyRotationSchedule.html) get_recordingkeys_rotationschedule Get key rotation schedule ### 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 begin #Get key rotation schedule result = api_instance.get_recordingkeys_rotationschedule p result rescue PureCloud::ApiError => e puts "Exception when calling RecordingApi->get_recordingkeys_rotationschedule: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type [**KeyRotationSchedule**](KeyRotationSchedule.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**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 ## -[**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 ## -[**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 ## - 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 ## -[**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 ## -[**EncryptionKey**](EncryptionKey.html) post_localkeys(body) create a local recording key ### 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::LocalEncryptionKeyRequest.new # LocalEncryptionKeyRequest | Local Encryption body begin #create a local recording key result = api_instance.post_localkeys(body) p result rescue PureCloud::ApiError => e puts "Exception when calling RecordingApi->post_localkeys: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**LocalEncryptionKeyRequest**](LocalEncryptionKeyRequest.html)| Local Encryption body | {: class="table table-striped"} ### Return type [**EncryptionKey**](EncryptionKey.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**LocalEncryptionConfiguration**](LocalEncryptionConfiguration.html) post_localkeys_settings(body) create settings for local key creation ### 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::LocalEncryptionConfiguration.new # LocalEncryptionConfiguration | Local Encryption Configuration begin #create settings for local key creation result = api_instance.post_localkeys_settings(body) p result rescue PureCloud::ApiError => e puts "Exception when calling RecordingApi->post_localkeys_settings: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**LocalEncryptionConfiguration**](LocalEncryptionConfiguration.html)| Local Encryption Configuration | {: class="table table-striped"} ### Return type [**LocalEncryptionConfiguration**](LocalEncryptionConfiguration.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**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 ## -[**EncryptionKey**](EncryptionKey.html) post_recordingkeys Create encryption key ### 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 begin #Create encryption key result = api_instance.post_recordingkeys p result rescue PureCloud::ApiError => e puts "Exception when calling RecordingApi->post_recordingkeys: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type [**EncryptionKey**](EncryptionKey.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Recording**](Recording.html) 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. result = api_instance.put_conversation_id_recordings_recording_id(conversation_id, recording_id, body) p result 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 [**Recording**](Recording.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**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 ## -[**LocalEncryptionConfiguration**](LocalEncryptionConfiguration.html) put_localkeys_settings_settings_id(settings_id, body) Update the local encryption settings ### 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 settings_id = "settings_id_example" # String | Settings Id body = PureCloud::LocalEncryptionConfiguration.new # LocalEncryptionConfiguration | Local Encryption metadata begin #Update the local encryption settings result = api_instance.put_localkeys_settings_settings_id(settings_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling RecordingApi->put_localkeys_settings_settings_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settings_id** | **String**| Settings Id | **body** | [**LocalEncryptionConfiguration**](LocalEncryptionConfiguration.html)| Local Encryption metadata | {: class="table table-striped"} ### Return type [**LocalEncryptionConfiguration**](LocalEncryptionConfiguration.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**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 ## -[**Recording**](Recording.html) put_orphan_id(orphan_id, opts) 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. ### 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 opts = { body: PureCloud::OrphanUpdateRequest.new # OrphanUpdateRequest | } begin #Updates an orphan recording to a regular recording with retention values result = api_instance.put_orphan_id(orphan_id, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling RecordingApi->put_orphan_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orphan_id** | **String**| Orphan ID | **body** | [**OrphanUpdateRequest**](OrphanUpdateRequest.html)| | [optional] {: class="table table-striped"} ### Return type [**Recording**](Recording.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**KeyRotationSchedule**](KeyRotationSchedule.html) put_recordingkeys_rotationschedule(body) Update key rotation schedule ### 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::KeyRotationSchedule.new # KeyRotationSchedule | KeyRotationSchedule begin #Update key rotation schedule result = api_instance.put_recordingkeys_rotationschedule(body) p result rescue PureCloud::ApiError => e puts "Exception when calling RecordingApi->put_recordingkeys_rotationschedule: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**KeyRotationSchedule**](KeyRotationSchedule.html)| KeyRotationSchedule | {: class="table table-striped"} ### Return type [**KeyRotationSchedule**](KeyRotationSchedule.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**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