Package com.mypurecloud.sdk.v2.api
Class RecordingApi
java.lang.Object
com.mypurecloud.sdk.v2.api.RecordingApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidDelete annotationDelete annotationvoiddeleteConversationRecordingAnnotation(String conversationId, String recordingId, String annotationId) Delete annotationdeleteConversationRecordingAnnotationWithHttpInfo(String conversationId, String recordingId, String annotationId) Delete annotationDeletes a single orphan recordingdeleteOrphanrecording(ApiRequest<Void> request) Deletes a single orphan recordingdeleteOrphanrecording(String orphanId) Deletes a single orphan recordingdeleteOrphanrecordingWithHttpInfo(String orphanId) Deletes a single orphan recordingvoiddeleteRecordingCrossplatformMediaretentionpolicies(DeleteRecordingCrossplatformMediaretentionpoliciesRequest request) 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.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.voidDelete media retention policies Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.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.voiddeleteRecordingCrossplatformMediaretentionpolicy(DeleteRecordingCrossplatformMediaretentionpolicyRequest request) Delete a media retention policyDelete a media retention policyvoidDelete a media retention policyDelete a media retention policyvoidDelete the recording bulk jobdeleteRecordingJob(ApiRequest<Void> request) Delete the recording bulk jobvoiddeleteRecordingJob(String jobId) Delete the recording bulk jobDelete the recording bulk jobvoidDelete media retention policies Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.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.voidDelete media retention policies Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.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.voidDelete a media retention policyDelete a media retention policyvoiddeleteRecordingMediaretentionpolicy(String policyId) Delete a media retention policyDelete a media retention policyGets a specific recording.getConversationRecording(ApiRequest<Void> request) Gets a specific recording.getConversationRecording(String conversationId, String recordingId, String formatId, String emailFormatId, String chatFormatId, String messageFormatId, Boolean download, String fileName, String locale, List<String> mediaFormats) Gets a specific recording.Get annotationgetConversationRecordingAnnotation(ApiRequest<Void> request) Get annotationgetConversationRecordingAnnotation(String conversationId, String recordingId, String annotationId) Get annotationGet annotations for recordingGet annotations for recordinggetConversationRecordingAnnotations(String conversationId, String recordingId) Get annotations for recordinggetConversationRecordingAnnotationsWithHttpInfo(String conversationId, String recordingId) Get annotations for recordinggetConversationRecordingAnnotationWithHttpInfo(String conversationId, String recordingId, String annotationId) Get annotationGet recording metadata for a conversation.getConversationRecordingmetadata(ApiRequest<Void> request) Get recording metadata for a conversation.getConversationRecordingmetadata(String conversationId) Get recording metadata for a conversation.getConversationRecordingmetadataRecordingId(GetConversationRecordingmetadataRecordingIdRequest request) Get metadata for a specific recording.Get metadata for a specific recording.getConversationRecordingmetadataRecordingId(String conversationId, String recordingId) Get metadata for a specific recording.getConversationRecordingmetadataRecordingIdWithHttpInfo(String conversationId, String recordingId) Get metadata for a specific recording.getConversationRecordingmetadataWithHttpInfo(String conversationId) Get recording metadata for a conversation.Get all of a Conversation's Recordings.getConversationRecordings(ApiRequest<Void> request) Get all of a Conversation's Recordings.getConversationRecordings(String conversationId, Integer maxWaitMs, String formatId, List<String> mediaFormats, String locale, Boolean includePauseAnnotationsForScreenRecordings) Get all of a Conversation's Recordings.getConversationRecordingsWithHttpInfo(String conversationId, Integer maxWaitMs, String formatId, List<String> mediaFormats, String locale, Boolean includePauseAnnotationsForScreenRecordings) Get all of a Conversation's Recordings.getConversationRecordingWithHttpInfo(String conversationId, String recordingId, String formatId, String emailFormatId, String chatFormatId, String messageFormatId, Boolean download, String fileName, String locale, List<String> mediaFormats) Gets a specific recording.Gets a single orphan recordinggetOrphanrecording(ApiRequest<Void> request) Gets a single orphan recordinggetOrphanrecording(String orphanId) Gets a single orphan recordingGets 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.getOrphanrecordingMedia(ApiRequest<Void> request) 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.getOrphanrecordingMedia(String orphanId, String formatId, String emailFormatId, String chatFormatId, String messageFormatId, Boolean download, String fileName, String locale, List<String> mediaFormats) 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.getOrphanrecordingMediaWithHttpInfo(String orphanId, String formatId, String emailFormatId, String chatFormatId, String messageFormatId, Boolean download, String fileName, String locale, List<String> mediaFormats) 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.Gets all orphan recordingsgetOrphanrecordings(ApiRequest<Void> request) Gets all orphan recordingsgetOrphanrecordings(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, Boolean hasConversation, String media) Gets all orphan recordingsgetOrphanrecordingsWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, Boolean hasConversation, String media) Gets all orphan recordingsgetOrphanrecordingWithHttpInfo(String orphanId) Gets a single orphan recordingGet the status and results for a batch request job, only the user that submitted the job may retrieve results.getRecordingBatchrequest(ApiRequest<Void> request) Get the status and results for a batch request job, only the user that submitted the job may retrieve results.getRecordingBatchrequest(String jobId) Get the status and results for a batch request job, only the user that submitted the job may retrieve results.Get the status and results for a batch request job, only the user that submitted the job may retrieve results.getRecordingCrossplatformMediaretentionpolicies(GetRecordingCrossplatformMediaretentionpoliciesRequest request) Gets media retention policy list with query options to filter on name and enabled.Gets media retention policy list with query options to filter on name and enabled.getRecordingCrossplatformMediaretentionpolicies(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, String name, Boolean enabled, Boolean summary, Boolean hasErrors, Integer deleteDaysThreshold) Gets media retention policy list with query options to filter on name and enabled.getRecordingCrossplatformMediaretentionpoliciesWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, String name, Boolean enabled, Boolean summary, Boolean hasErrors, Integer deleteDaysThreshold) Gets media retention policy list with query options to filter on name and enabled.getRecordingCrossplatformMediaretentionpolicy(GetRecordingCrossplatformMediaretentionpolicyRequest request) Get a media retention policyGet a media retention policyGet a media retention policyGet a media retention policygetRecordingJob(GetRecordingJobRequest request) Get the status of the job associated with the job id.getRecordingJob(ApiRequest<Void> request) Get the status of the job associated with the job id.getRecordingJob(String jobId) Get the status of the job associated with the job id.Get IDs of recordings that the bulk job failed forgetRecordingJobFailedrecordings(ApiRequest<Void> request) Get IDs of recordings that the bulk job failed forgetRecordingJobFailedrecordings(String jobId, Integer pageSize, Integer pageNumber, Boolean includeTotal, String cursor) Get IDs of recordings that the bulk job failed forgetRecordingJobFailedrecordingsWithHttpInfo(String jobId, Integer pageSize, Integer pageNumber, Boolean includeTotal, String cursor) Get IDs of recordings that the bulk job failed forgetRecordingJobs(GetRecordingJobsRequest request) Get the status of all jobs within the user's organizationgetRecordingJobs(ApiRequest<Void> request) Get the status of all jobs within the user's organizationgetRecordingJobs(Integer pageSize, Integer pageNumber, String sortBy, String state, Boolean showOnlyMyJobs, String jobType, Boolean includeTotal, String cursor) Get the status of all jobs within the user's organizationgetRecordingJobsWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, String state, Boolean showOnlyMyJobs, String jobType, Boolean includeTotal, String cursor) Get the status of all jobs within the user's organizationGet the status of the job associated with the job id.Get the encryption key configurationsgetRecordingKeyconfiguration(ApiRequest<Void> request) Get the encryption key configurationsgetRecordingKeyconfiguration(String keyConfigurationId) Get the encryption key configurationsGet a list of key configurations dataGet a list of key configurations datagetRecordingKeyconfigurations(ApiRequest<Void> request) Get a list of key configurations dataGet a list of key configurations datagetRecordingKeyconfigurationWithHttpInfo(String keyConfigurationId) Get the encryption key configurationsGets media retention policy list with query options to filter on name and enabled.getRecordingMediaretentionpolicies(ApiRequest<Void> request) Gets media retention policy list with query options to filter on name and enabled.getRecordingMediaretentionpolicies(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, String name, Boolean enabled, Boolean summary, Boolean hasErrors, Integer deleteDaysThreshold) Gets media retention policy list with query options to filter on name and enabled.getRecordingMediaretentionpoliciesWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, String name, Boolean enabled, Boolean summary, Boolean hasErrors, Integer deleteDaysThreshold) Gets media retention policy list with query options to filter on name and enabled.Get a media retention policygetRecordingMediaretentionpolicy(ApiRequest<Void> request) Get a media retention policygetRecordingMediaretentionpolicy(String policyId) Get a media retention policyGet a media retention policyGet encryption key listgetRecordingRecordingkeys(ApiRequest<Void> request) Get encryption key listgetRecordingRecordingkeys(Integer pageSize, Integer pageNumber) Get encryption key listGet key rotation scheduleGet key rotation scheduleGet key rotation scheduleGet key rotation schedulegetRecordingRecordingkeysWithHttpInfo(Integer pageSize, Integer pageNumber) Get encryption key listGet the Recording Settings for the OrganizationgetRecordingSettings(ApiRequest<Void> request) Get the Recording Settings for the OrganizationgetRecordingSettings(Boolean createDefault) Get the Recording Settings for the OrganizationgetRecordingSettingsWithHttpInfo(Boolean createDefault) Get the Recording Settings for the OrganizationQuery for recording retention datagetRecordingsRetentionQuery(ApiRequest<Void> request) Query for recording retention datagetRecordingsRetentionQuery(Integer retentionThresholdDays, String cursor, Integer pageSize) Query for recording retention datagetRecordingsRetentionQueryWithHttpInfo(Integer retentionThresholdDays, String cursor, Integer pageSize) Query for recording retention dataRetrieves an object containing the total number of concurrent active screen recordingsRetrieves an object containing the total number of concurrent active screen recordingsgetRecordingsScreensessionsDetails(ApiRequest<Void> request) Retrieves an object containing the total number of concurrent active screen recordingsRetrieves an object containing the total number of concurrent active screen recordingsGet the status of a recording upload status reportgetRecordingUploadsReport(ApiRequest<Void> request) Get the status of a recording upload status reportgetRecordingUploadsReport(String reportId) Get the status of a recording upload status reportgetRecordingUploadsReportWithHttpInfo(String reportId) Get the status of a recording upload status reportpatchRecordingCrossplatformMediaretentionpolicy(PatchRecordingCrossplatformMediaretentionpolicyRequest request) Patch a media retention policyPatch a media retention policyPatch a media retention policypatchRecordingCrossplatformMediaretentionpolicyWithHttpInfo(String policyId, CrossPlatformPolicyUpdate body) Patch a media retention policyPatch a media retention policyPatch a media retention policypatchRecordingMediaretentionpolicy(String policyId, PolicyUpdate body) Patch a media retention policypatchRecordingMediaretentionpolicyWithHttpInfo(String policyId, PolicyUpdate body) Patch a media retention policyCreate annotation If the annotation does not exist on the recording, it is created.Create annotation If the annotation does not exist on the recording, it is created.postConversationRecordingAnnotations(String conversationId, String recordingId, Annotation body) Create annotation If the annotation does not exist on the recording, it is created.postConversationRecordingAnnotationsWithHttpInfo(String conversationId, String recordingId, Annotation body) Create annotation If the annotation does not exist on the recording, it is created.Submit a batch download request for recordings.Submit a batch download request for recordings.Submit a batch download request for recordings.Submit a batch download request for recordings.postRecordingCrossplatformMediaretentionpolicies(PostRecordingCrossplatformMediaretentionpoliciesRequest request) Create media retention policy Policy does not work retroactivelyCreate media retention policy Policy does not work retroactivelyCreate media retention policy Policy does not work retroactivelyCreate media retention policy Policy does not work retroactivelyCreate a recording bulk job.postRecordingJobs(ApiRequest<RecordingJobsQuery> request) Create a recording bulk job.Create a recording bulk job.Create a recording bulk job.Setup configurations for encryption key creationSetup configurations for encryption key creationSetup configurations for encryption key creationValidate encryption key configurations without saving itValidate encryption key configurations without saving itValidate encryption key configurations without saving itValidate encryption key configurations without saving itSetup configurations for encryption key creationcreate a local key management recording keycreate a local key management recording keycreate a local key management recording keycreate a local key management recording keyCreate media retention policy Policy does not work retroactivelyCreate media retention policy Policy does not work retroactivelyCreate media retention policy Policy does not work retroactivelyCreate media retention policy Policy does not work retroactivelyCreate encryption keyCreate encryption keypostRecordingRecordingkeys(ApiRequest<Void> request) Create encryption keyCreate encryption keyGet a list of conversations with protected recordingsGet a list of conversations with protected recordingsGet a list of conversations with protected recordingsGet a list of conversations with protected recordingsvoidAcknowledge a screen recording.Acknowledge a screen recording.voidAcknowledge a screen recording.Acknowledge a screen recording.voidProvide meta-data a screen recording.Provide meta-data a screen recording.voidProvide meta-data a screen recording.Provide meta-data a screen recording.Creates a recording upload status reportCreates a recording upload status reportCreates a recording upload status reportCreates a recording upload status reportUpdates the retention records on a recording.putConversationRecording(ApiRequest<Recording> request) Updates the retention records on a recording.putConversationRecording(String conversationId, String recordingId, Recording body, Boolean clearExport) Updates the retention records on a recording.Update annotation If the annotation does not exist on the recording, it is created.Update annotation If the annotation does not exist on the recording, it is created.putConversationRecordingAnnotation(String conversationId, String recordingId, String annotationId, Annotation body) Update annotation If the annotation does not exist on the recording, it is created.putConversationRecordingAnnotationWithHttpInfo(String conversationId, String recordingId, String annotationId, Annotation body) Update annotation If the annotation does not exist on the recording, it is created.putConversationRecordingWithHttpInfo(String conversationId, String recordingId, Recording body, Boolean clearExport) Updates the retention records on a recording.Updates an orphan recording to a regular recording with retention values If this operation is successful the orphan will no longer exist.putOrphanrecording(ApiRequest<OrphanUpdateRequest> request) Updates an orphan recording to a regular recording with retention values If this operation is successful the orphan will no longer exist.putOrphanrecording(String orphanId, OrphanUpdateRequest body) Updates an orphan recording to a regular recording with retention values If this operation is successful the orphan will no longer exist.putOrphanrecordingWithHttpInfo(String orphanId, OrphanUpdateRequest body) Updates an orphan recording to a regular recording with retention values If this operation is successful the orphan will no longer exist.putRecordingCrossplatformMediaretentionpolicy(PutRecordingCrossplatformMediaretentionpolicyRequest request) Update a media retention policy Policy does not work retroactivelyUpdate a media retention policy Policy does not work retroactivelyputRecordingCrossplatformMediaretentionpolicy(String policyId, CrossPlatformPolicy body) Update a media retention policy Policy does not work retroactivelyputRecordingCrossplatformMediaretentionpolicyWithHttpInfo(String policyId, CrossPlatformPolicy body) Update a media retention policy Policy does not work retroactivelyputRecordingJob(PutRecordingJobRequest request) Execute the recording bulk job.Execute the recording bulk job.putRecordingJob(String jobId, ExecuteRecordingJobsQuery body) Execute the recording bulk job.putRecordingJobWithHttpInfo(String jobId, ExecuteRecordingJobsQuery body) Execute the recording bulk job.Update the encryption key configurationsUpdate the encryption key configurationsputRecordingKeyconfiguration(String keyConfigurationId, RecordingEncryptionConfiguration body) Update the encryption key configurationsputRecordingKeyconfigurationWithHttpInfo(String keyConfigurationId, RecordingEncryptionConfiguration body) Update the encryption key configurationsUpdate a media retention policy Policy does not work retroactively.putRecordingMediaretentionpolicy(ApiRequest<Policy> request) Update a media retention policy Policy does not work retroactively.putRecordingMediaretentionpolicy(String policyId, Policy body) Update a media retention policy Policy does not work retroactively.putRecordingMediaretentionpolicyWithHttpInfo(String policyId, Policy body) Update a media retention policy Policy does not work retroactively.Update key rotation scheduleUpdate key rotation scheduleUpdate key rotation scheduleUpdate key rotation schedulevoidApply or revoke recording protection for conversationsApply or revoke recording protection for conversationsvoidApply or revoke recording protection for conversationsputRecordingsDeletionprotectionWithHttpInfo(Boolean protect, ConversationDeletionProtectionQuery body) Apply or revoke recording protection for conversationsUpdate the Recording Settings for the OrganizationputRecordingSettings(ApiRequest<RecordingSettings> request) Update the Recording Settings for the OrganizationUpdate the Recording Settings for the OrganizationUpdate the Recording Settings for the Organization
-
Constructor Details
-
RecordingApi
public RecordingApi() -
RecordingApi
-
-
Method Details
-
deleteConversationRecordingAnnotation
public void deleteConversationRecordingAnnotation(String conversationId, String recordingId, String annotationId) throws IOException, ApiException Delete annotation- Parameters:
conversationId- Conversation ID (required)recordingId- Recording ID (required)annotationId- Annotation ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteConversationRecordingAnnotationWithHttpInfo
public ApiResponse<Void> deleteConversationRecordingAnnotationWithHttpInfo(String conversationId, String recordingId, String annotationId) throws IOException Delete annotation- Parameters:
conversationId- Conversation ID (required)recordingId- Recording ID (required)annotationId- Annotation ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteConversationRecordingAnnotation
public void deleteConversationRecordingAnnotation(DeleteConversationRecordingAnnotationRequest request) throws IOException, ApiException Delete annotation- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteConversationRecordingAnnotation
public ApiResponse<Void> deleteConversationRecordingAnnotation(ApiRequest<Void> request) throws IOException Delete annotation- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteOrphanrecording
Deletes a single orphan recording- Parameters:
orphanId- Orphan ID (required)- Returns:
- OrphanRecording
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteOrphanrecordingWithHttpInfo
public ApiResponse<OrphanRecording> deleteOrphanrecordingWithHttpInfo(String orphanId) throws IOException Deletes a single orphan recording- Parameters:
orphanId- Orphan ID (required)- Returns:
- OrphanRecording
- Throws:
IOException- if the request fails to be processed
-
deleteOrphanrecording
public OrphanRecording deleteOrphanrecording(DeleteOrphanrecordingRequest request) throws IOException, ApiException Deletes a single orphan recording- Parameters:
request- The request object- Returns:
- OrphanRecording
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteOrphanrecording
public ApiResponse<OrphanRecording> deleteOrphanrecording(ApiRequest<Void> request) throws IOException Deletes a single orphan recording- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRecordingCrossplatformMediaretentionpolicies
public void deleteRecordingCrossplatformMediaretentionpolicies(String ids) throws IOException, ApiException 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.- Parameters:
ids- (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRecordingCrossplatformMediaretentionpoliciesWithHttpInfo
public ApiResponse<Void> deleteRecordingCrossplatformMediaretentionpoliciesWithHttpInfo(String ids) throws IOException 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.- Parameters:
ids- (required)- Throws:
IOException- if the request fails to be processed
-
deleteRecordingCrossplatformMediaretentionpolicies
public void deleteRecordingCrossplatformMediaretentionpolicies(DeleteRecordingCrossplatformMediaretentionpoliciesRequest request) throws IOException, ApiException 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.- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRecordingCrossplatformMediaretentionpolicies
public ApiResponse<Void> deleteRecordingCrossplatformMediaretentionpolicies(ApiRequest<Void> request) throws IOException 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.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRecordingCrossplatformMediaretentionpolicy
public void deleteRecordingCrossplatformMediaretentionpolicy(String policyId) throws IOException, ApiException Delete a media retention policy- Parameters:
policyId- Policy ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRecordingCrossplatformMediaretentionpolicyWithHttpInfo
public ApiResponse<Void> deleteRecordingCrossplatformMediaretentionpolicyWithHttpInfo(String policyId) throws IOException Delete a media retention policy- Parameters:
policyId- Policy ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteRecordingCrossplatformMediaretentionpolicy
public void deleteRecordingCrossplatformMediaretentionpolicy(DeleteRecordingCrossplatformMediaretentionpolicyRequest request) throws IOException, ApiException Delete a media retention policy- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRecordingCrossplatformMediaretentionpolicy
public ApiResponse<Void> deleteRecordingCrossplatformMediaretentionpolicy(ApiRequest<Void> request) throws IOException Delete a media retention policy- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRecordingJob
Delete the recording bulk job- Parameters:
jobId- jobId (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRecordingJobWithHttpInfo
Delete the recording bulk job- Parameters:
jobId- jobId (required)- Throws:
IOException- if the request fails to be processed
-
deleteRecordingJob
Delete the recording bulk job- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRecordingJob
Delete the recording bulk job- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRecordingMediaretentionpolicies
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.- Parameters:
ids- (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRecordingMediaretentionpoliciesWithHttpInfo
public ApiResponse<Void> deleteRecordingMediaretentionpoliciesWithHttpInfo(String ids) throws IOException 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.- Parameters:
ids- (required)- Throws:
IOException- if the request fails to be processed
-
deleteRecordingMediaretentionpolicies
public void deleteRecordingMediaretentionpolicies(DeleteRecordingMediaretentionpoliciesRequest request) throws IOException, ApiException 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.- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRecordingMediaretentionpolicies
public ApiResponse<Void> deleteRecordingMediaretentionpolicies(ApiRequest<Void> request) throws IOException 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.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRecordingMediaretentionpolicy
Delete a media retention policy- Parameters:
policyId- Policy ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRecordingMediaretentionpolicyWithHttpInfo
public ApiResponse<Void> deleteRecordingMediaretentionpolicyWithHttpInfo(String policyId) throws IOException Delete a media retention policy- Parameters:
policyId- Policy ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteRecordingMediaretentionpolicy
public void deleteRecordingMediaretentionpolicy(DeleteRecordingMediaretentionpolicyRequest request) throws IOException, ApiException Delete a media retention policy- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRecordingMediaretentionpolicy
public ApiResponse<Void> deleteRecordingMediaretentionpolicy(ApiRequest<Void> request) throws IOException Delete a media retention policy- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getConversationRecording
public Recording getConversationRecording(String conversationId, String recordingId, String formatId, String emailFormatId, String chatFormatId, String messageFormatId, Boolean download, String fileName, String locale, List<String> mediaFormats) throws IOException, ApiException Gets a specific recording. Bookmark annotations will be excluded if recording:annotation:view permission is missing. If the recording:recording:viewSensitiveData permission is missing and the organization has sensitive data redaction enabled, recordings with sensitive data will be redacted.- Parameters:
conversationId- Conversation ID (required)recordingId- Recording ID (required)formatId- The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE (optional, default to WEBM)emailFormatId- The desired media format when downloading an email recording. Valid values:EML,NONE (optional, default to EML)chatFormatId- The desired media format when downloading a chat recording. Valid values:ZIP,NONE (optional, default to ZIP)messageFormatId- The desired media format when downloading a message recording. Valid values:ZIP,NONE (optional, default to ZIP)download- requesting a download format of the recording. Valid values:true,false (optional, default to false)fileName- the name of the downloaded fileName (optional)locale- The locale for the requested file when downloading or for redacting sensitive information in requested files, as an ISO 639-1 code (optional)mediaFormats- All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3 (optional)- Returns:
- Recording
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getConversationRecordingWithHttpInfo
public ApiResponse<Recording> getConversationRecordingWithHttpInfo(String conversationId, String recordingId, String formatId, String emailFormatId, String chatFormatId, String messageFormatId, Boolean download, String fileName, String locale, List<String> mediaFormats) throws IOException Gets a specific recording. Bookmark annotations will be excluded if recording:annotation:view permission is missing. If the recording:recording:viewSensitiveData permission is missing and the organization has sensitive data redaction enabled, recordings with sensitive data will be redacted.- Parameters:
conversationId- Conversation ID (required)recordingId- Recording ID (required)formatId- The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE (optional, default to WEBM)emailFormatId- The desired media format when downloading an email recording. Valid values:EML,NONE (optional, default to EML)chatFormatId- The desired media format when downloading a chat recording. Valid values:ZIP,NONE (optional, default to ZIP)messageFormatId- The desired media format when downloading a message recording. Valid values:ZIP,NONE (optional, default to ZIP)download- requesting a download format of the recording. Valid values:true,false (optional, default to false)fileName- the name of the downloaded fileName (optional)locale- The locale for the requested file when downloading or for redacting sensitive information in requested files, as an ISO 639-1 code (optional)mediaFormats- All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3 (optional)- Returns:
- Recording
- Throws:
IOException- if the request fails to be processed
-
getConversationRecording
public Recording getConversationRecording(GetConversationRecordingRequest request) throws IOException, ApiException Gets a specific recording. Bookmark annotations will be excluded if recording:annotation:view permission is missing. If the recording:recording:viewSensitiveData permission is missing and the organization has sensitive data redaction enabled, recordings with sensitive data will be redacted.- Parameters:
request- The request object- Returns:
- Recording
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getConversationRecording
Gets a specific recording. Bookmark annotations will be excluded if recording:annotation:view permission is missing. If the recording:recording:viewSensitiveData permission is missing and the organization has sensitive data redaction enabled, recordings with sensitive data will be redacted.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getConversationRecordingAnnotation
public Annotation getConversationRecordingAnnotation(String conversationId, String recordingId, String annotationId) throws IOException, ApiException Get annotation- Parameters:
conversationId- Conversation ID (required)recordingId- Recording ID (required)annotationId- Annotation ID (required)- Returns:
- Annotation
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getConversationRecordingAnnotationWithHttpInfo
public ApiResponse<Annotation> getConversationRecordingAnnotationWithHttpInfo(String conversationId, String recordingId, String annotationId) throws IOException Get annotation- Parameters:
conversationId- Conversation ID (required)recordingId- Recording ID (required)annotationId- Annotation ID (required)- Returns:
- Annotation
- Throws:
IOException- if the request fails to be processed
-
getConversationRecordingAnnotation
public Annotation getConversationRecordingAnnotation(GetConversationRecordingAnnotationRequest request) throws IOException, ApiException Get annotation- Parameters:
request- The request object- Returns:
- Annotation
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getConversationRecordingAnnotation
public ApiResponse<Annotation> getConversationRecordingAnnotation(ApiRequest<Void> request) throws IOException Get annotation- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getConversationRecordingAnnotations
public List<Annotation> getConversationRecordingAnnotations(String conversationId, String recordingId) throws IOException, ApiException Get annotations for recording- Parameters:
conversationId- Conversation ID (required)recordingId- Recording ID (required)- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getConversationRecordingAnnotationsWithHttpInfo
public ApiResponse<List<Annotation>> getConversationRecordingAnnotationsWithHttpInfo(String conversationId, String recordingId) throws IOException Get annotations for recording- Parameters:
conversationId- Conversation ID (required)recordingId- Recording ID (required)- Returns:
- List
- Throws:
IOException- if the request fails to be processed
-
getConversationRecordingAnnotations
public List<Annotation> getConversationRecordingAnnotations(GetConversationRecordingAnnotationsRequest request) throws IOException, ApiException Get annotations for recording- Parameters:
request- The request object- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getConversationRecordingAnnotations
public ApiResponse<List<Annotation>> getConversationRecordingAnnotations(ApiRequest<Void> request) throws IOException Get annotations for recording- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getConversationRecordingmetadata
public List<RecordingMetadata> getConversationRecordingmetadata(String conversationId) throws IOException, ApiException Get recording metadata for a conversation. Does not return playable media nor system annotations. Bookmark annotations will be excluded if either recording:recording:view or recording:annotation:view permission is missing.- Parameters:
conversationId- Conversation ID (required)- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getConversationRecordingmetadataWithHttpInfo
public ApiResponse<List<RecordingMetadata>> getConversationRecordingmetadataWithHttpInfo(String conversationId) throws IOException Get recording metadata for a conversation. Does not return playable media nor system annotations. Bookmark annotations will be excluded if either recording:recording:view or recording:annotation:view permission is missing.- Parameters:
conversationId- Conversation ID (required)- Returns:
- List
- Throws:
IOException- if the request fails to be processed
-
getConversationRecordingmetadata
public List<RecordingMetadata> getConversationRecordingmetadata(GetConversationRecordingmetadataRequest request) throws IOException, ApiException Get recording metadata for a conversation. Does not return playable media nor system annotations. Bookmark annotations will be excluded if either recording:recording:view or recording:annotation:view permission is missing.- Parameters:
request- The request object- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getConversationRecordingmetadata
public ApiResponse<List<RecordingMetadata>> getConversationRecordingmetadata(ApiRequest<Void> request) throws IOException Get recording metadata for a conversation. Does not return playable media nor system annotations. Bookmark annotations will be excluded if either recording:recording:view or recording:annotation:view permission is missing.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getConversationRecordingmetadataRecordingId
public RecordingMetadata getConversationRecordingmetadataRecordingId(String conversationId, String recordingId) throws IOException, ApiException Get metadata for a specific recording. Does not return playable media. Bookmark annotations will be excluded if either recording:recording:view or recording:annotation:view permission is missing.- Parameters:
conversationId- Conversation ID (required)recordingId- Recording ID (required)- Returns:
- RecordingMetadata
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getConversationRecordingmetadataRecordingIdWithHttpInfo
public ApiResponse<RecordingMetadata> getConversationRecordingmetadataRecordingIdWithHttpInfo(String conversationId, String recordingId) throws IOException Get metadata for a specific recording. Does not return playable media. Bookmark annotations will be excluded if either recording:recording:view or recording:annotation:view permission is missing.- Parameters:
conversationId- Conversation ID (required)recordingId- Recording ID (required)- Returns:
- RecordingMetadata
- Throws:
IOException- if the request fails to be processed
-
getConversationRecordingmetadataRecordingId
public RecordingMetadata getConversationRecordingmetadataRecordingId(GetConversationRecordingmetadataRecordingIdRequest request) throws IOException, ApiException Get metadata for a specific recording. Does not return playable media. Bookmark annotations will be excluded if either recording:recording:view or recording:annotation:view permission is missing.- Parameters:
request- The request object- Returns:
- RecordingMetadata
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getConversationRecordingmetadataRecordingId
public ApiResponse<RecordingMetadata> getConversationRecordingmetadataRecordingId(ApiRequest<Void> request) throws IOException Get metadata for a specific recording. Does not return playable media. Bookmark annotations will be excluded if either recording:recording:view or recording:annotation:view permission is missing.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getConversationRecordings
public List<Recording> getConversationRecordings(String conversationId, Integer maxWaitMs, String formatId, List<String> mediaFormats, String locale, Boolean includePauseAnnotationsForScreenRecordings) throws IOException, ApiException Get all of a Conversation's Recordings. Bookmark annotations will be excluded if recording:annotation:view permission is missing. If the recording:recording:viewSensitiveData permission is missing and the organization has sensitive data redaction enabled, recordings with sensitive data will be redacted.- Parameters:
conversationId- Conversation ID (required)maxWaitMs- The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value. (optional, default to 5000)formatId- The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. (optional, default to WEBM)mediaFormats- All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3. (optional)locale- The locale used for redacting sensitive information in requested files, as an ISO 639-1 code (optional)includePauseAnnotationsForScreenRecordings- Include applicable Secure Pause annotations from all audio recordings to all screen recordings (optional, default to false)- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getConversationRecordingsWithHttpInfo
public ApiResponse<List<Recording>> getConversationRecordingsWithHttpInfo(String conversationId, Integer maxWaitMs, String formatId, List<String> mediaFormats, String locale, Boolean includePauseAnnotationsForScreenRecordings) throws IOException Get all of a Conversation's Recordings. Bookmark annotations will be excluded if recording:annotation:view permission is missing. If the recording:recording:viewSensitiveData permission is missing and the organization has sensitive data redaction enabled, recordings with sensitive data will be redacted.- Parameters:
conversationId- Conversation ID (required)maxWaitMs- The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value. (optional, default to 5000)formatId- The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. (optional, default to WEBM)mediaFormats- All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3. (optional)locale- The locale used for redacting sensitive information in requested files, as an ISO 639-1 code (optional)includePauseAnnotationsForScreenRecordings- Include applicable Secure Pause annotations from all audio recordings to all screen recordings (optional, default to false)- Returns:
- List
- Throws:
IOException- if the request fails to be processed
-
getConversationRecordings
public List<Recording> getConversationRecordings(GetConversationRecordingsRequest request) throws IOException, ApiException Get all of a Conversation's Recordings. Bookmark annotations will be excluded if recording:annotation:view permission is missing. If the recording:recording:viewSensitiveData permission is missing and the organization has sensitive data redaction enabled, recordings with sensitive data will be redacted.- Parameters:
request- The request object- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getConversationRecordings
public ApiResponse<List<Recording>> getConversationRecordings(ApiRequest<Void> request) throws IOException Get all of a Conversation's Recordings. Bookmark annotations will be excluded if recording:annotation:view permission is missing. If the recording:recording:viewSensitiveData permission is missing and the organization has sensitive data redaction enabled, recordings with sensitive data will be redacted.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getOrphanrecording
Gets a single orphan recording- Parameters:
orphanId- Orphan ID (required)- Returns:
- OrphanRecording
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getOrphanrecordingWithHttpInfo
public ApiResponse<OrphanRecording> getOrphanrecordingWithHttpInfo(String orphanId) throws IOException Gets a single orphan recording- Parameters:
orphanId- Orphan ID (required)- Returns:
- OrphanRecording
- Throws:
IOException- if the request fails to be processed
-
getOrphanrecording
public OrphanRecording getOrphanrecording(GetOrphanrecordingRequest request) throws IOException, ApiException Gets a single orphan recording- Parameters:
request- The request object- Returns:
- OrphanRecording
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getOrphanrecording
Gets a single orphan recording- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getOrphanrecordingMedia
public Recording getOrphanrecordingMedia(String orphanId, String formatId, String emailFormatId, String chatFormatId, String messageFormatId, Boolean download, String fileName, String locale, List<String> mediaFormats) throws IOException, ApiException 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.- Parameters:
orphanId- Orphan ID (required)formatId- The desired media format. (optional, default to WEBM)emailFormatId- The desired media format when downloading an email recording. (optional, default to EML)chatFormatId- The desired media format when downloading a chat recording. (optional, default to ZIP)messageFormatId- The desired media format when downloading a message recording. (optional, default to ZIP)download- requesting a download format of the recording (optional, default to false)fileName- the name of the downloaded fileName (optional)locale- The locale for the requested file when downloading, as an ISO 639-1 code (optional)mediaFormats- All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3 (optional)- Returns:
- Recording
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getOrphanrecordingMediaWithHttpInfo
public ApiResponse<Recording> getOrphanrecordingMediaWithHttpInfo(String orphanId, String formatId, String emailFormatId, String chatFormatId, String messageFormatId, Boolean download, String fileName, String locale, List<String> mediaFormats) throws IOException 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.- Parameters:
orphanId- Orphan ID (required)formatId- The desired media format. (optional, default to WEBM)emailFormatId- The desired media format when downloading an email recording. (optional, default to EML)chatFormatId- The desired media format when downloading a chat recording. (optional, default to ZIP)messageFormatId- The desired media format when downloading a message recording. (optional, default to ZIP)download- requesting a download format of the recording (optional, default to false)fileName- the name of the downloaded fileName (optional)locale- The locale for the requested file when downloading, as an ISO 639-1 code (optional)mediaFormats- All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3 (optional)- Returns:
- Recording
- Throws:
IOException- if the request fails to be processed
-
getOrphanrecordingMedia
public Recording getOrphanrecordingMedia(GetOrphanrecordingMediaRequest request) throws IOException, ApiException 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.- Parameters:
request- The request object- Returns:
- Recording
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getOrphanrecordingMedia
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.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getOrphanrecordings
public OrphanRecordingListing getOrphanrecordings(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, Boolean hasConversation, String media) throws IOException, ApiException Gets all orphan recordings- Parameters:
pageSize- The total page size requested (optional, default to 25)pageNumber- The page number requested (optional, default to 1)sortBy- variable name requested to sort by (optional)expand- variable name requested by expand list (optional)nextPage- next page token (optional)previousPage- Previous page token (optional)hasConversation- Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization. (optional, default to false)media- Filter resulting orphans based on their media type (optional)- Returns:
- OrphanRecordingListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getOrphanrecordingsWithHttpInfo
public ApiResponse<OrphanRecordingListing> getOrphanrecordingsWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, Boolean hasConversation, String media) throws IOException Gets all orphan recordings- Parameters:
pageSize- The total page size requested (optional, default to 25)pageNumber- The page number requested (optional, default to 1)sortBy- variable name requested to sort by (optional)expand- variable name requested by expand list (optional)nextPage- next page token (optional)previousPage- Previous page token (optional)hasConversation- Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization. (optional, default to false)media- Filter resulting orphans based on their media type (optional)- Returns:
- OrphanRecordingListing
- Throws:
IOException- if the request fails to be processed
-
getOrphanrecordings
public OrphanRecordingListing getOrphanrecordings(GetOrphanrecordingsRequest request) throws IOException, ApiException Gets all orphan recordings- Parameters:
request- The request object- Returns:
- OrphanRecordingListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getOrphanrecordings
public ApiResponse<OrphanRecordingListing> getOrphanrecordings(ApiRequest<Void> request) throws IOException Gets all orphan recordings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRecordingBatchrequest
public BatchDownloadJobStatusResult getRecordingBatchrequest(String jobId) throws IOException, ApiException Get the status and results for a batch request job, only the user that submitted the job may retrieve results. Each result may contain either a URL to a recording or an error; additionally, a recording could be associated with multiple results.- Parameters:
jobId- jobId (required)- Returns:
- BatchDownloadJobStatusResult
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingBatchrequestWithHttpInfo
public ApiResponse<BatchDownloadJobStatusResult> getRecordingBatchrequestWithHttpInfo(String jobId) throws IOException Get the status and results for a batch request job, only the user that submitted the job may retrieve results. Each result may contain either a URL to a recording or an error; additionally, a recording could be associated with multiple results.- Parameters:
jobId- jobId (required)- Returns:
- BatchDownloadJobStatusResult
- Throws:
IOException- if the request fails to be processed
-
getRecordingBatchrequest
public BatchDownloadJobStatusResult getRecordingBatchrequest(GetRecordingBatchrequestRequest request) throws IOException, ApiException Get the status and results for a batch request job, only the user that submitted the job may retrieve results. Each result may contain either a URL to a recording or an error; additionally, a recording could be associated with multiple results.- Parameters:
request- The request object- Returns:
- BatchDownloadJobStatusResult
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingBatchrequest
public ApiResponse<BatchDownloadJobStatusResult> getRecordingBatchrequest(ApiRequest<Void> request) throws IOException Get the status and results for a batch request job, only the user that submitted the job may retrieve results. Each result may contain either a URL to a recording or an error; additionally, a recording could be associated with multiple results.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRecordingCrossplatformMediaretentionpolicies
public PolicyEntityListing getRecordingCrossplatformMediaretentionpolicies(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, String name, Boolean enabled, Boolean summary, Boolean hasErrors, Integer deleteDaysThreshold) throws IOException, ApiException 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- Parameters:
pageSize- The total page size requested (optional, default to 25)pageNumber- The page number requested (optional, default to 1)sortBy- variable name requested to sort by (optional)expand- variable name requested by expand list (optional)nextPage- next page token (optional)previousPage- Previous page token (optional)name- the policy name - used for filtering results in searches. (optional)enabled- checks to see if policy is enabled - use enabled = true or enabled = false (optional)summary- provides a less verbose response of policy lists. (optional, default to false)hasErrors- provides a way to fetch all policies with errors or policies that do not have errors (optional)deleteDaysThreshold- provides a way to fetch all policies with any actions having deleteDays exceeding the provided value (optional)- Returns:
- PolicyEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingCrossplatformMediaretentionpoliciesWithHttpInfo
public ApiResponse<PolicyEntityListing> getRecordingCrossplatformMediaretentionpoliciesWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, String name, Boolean enabled, Boolean summary, Boolean hasErrors, Integer deleteDaysThreshold) throws IOException 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- Parameters:
pageSize- The total page size requested (optional, default to 25)pageNumber- The page number requested (optional, default to 1)sortBy- variable name requested to sort by (optional)expand- variable name requested by expand list (optional)nextPage- next page token (optional)previousPage- Previous page token (optional)name- the policy name - used for filtering results in searches. (optional)enabled- checks to see if policy is enabled - use enabled = true or enabled = false (optional)summary- provides a less verbose response of policy lists. (optional, default to false)hasErrors- provides a way to fetch all policies with errors or policies that do not have errors (optional)deleteDaysThreshold- provides a way to fetch all policies with any actions having deleteDays exceeding the provided value (optional)- Returns:
- PolicyEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRecordingCrossplatformMediaretentionpolicies
public PolicyEntityListing getRecordingCrossplatformMediaretentionpolicies(GetRecordingCrossplatformMediaretentionpoliciesRequest request) throws IOException, ApiException 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- Parameters:
request- The request object- Returns:
- PolicyEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingCrossplatformMediaretentionpolicies
public ApiResponse<PolicyEntityListing> getRecordingCrossplatformMediaretentionpolicies(ApiRequest<Void> request) throws IOException 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- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRecordingCrossplatformMediaretentionpolicy
public CrossPlatformPolicy getRecordingCrossplatformMediaretentionpolicy(String policyId) throws IOException, ApiException Get a media retention policy- Parameters:
policyId- Policy ID (required)- Returns:
- CrossPlatformPolicy
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingCrossplatformMediaretentionpolicyWithHttpInfo
public ApiResponse<CrossPlatformPolicy> getRecordingCrossplatformMediaretentionpolicyWithHttpInfo(String policyId) throws IOException Get a media retention policy- Parameters:
policyId- Policy ID (required)- Returns:
- CrossPlatformPolicy
- Throws:
IOException- if the request fails to be processed
-
getRecordingCrossplatformMediaretentionpolicy
public CrossPlatformPolicy getRecordingCrossplatformMediaretentionpolicy(GetRecordingCrossplatformMediaretentionpolicyRequest request) throws IOException, ApiException Get a media retention policy- Parameters:
request- The request object- Returns:
- CrossPlatformPolicy
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingCrossplatformMediaretentionpolicy
public ApiResponse<CrossPlatformPolicy> getRecordingCrossplatformMediaretentionpolicy(ApiRequest<Void> request) throws IOException Get a media retention policy- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRecordingJob
Get the status of the job associated with the job id.- Parameters:
jobId- jobId (required)- Returns:
- RecordingJob
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingJobWithHttpInfo
Get the status of the job associated with the job id.- Parameters:
jobId- jobId (required)- Returns:
- RecordingJob
- Throws:
IOException- if the request fails to be processed
-
getRecordingJob
public RecordingJob getRecordingJob(GetRecordingJobRequest request) throws IOException, ApiException Get the status of the job associated with the job id.- Parameters:
request- The request object- Returns:
- RecordingJob
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingJob
Get the status of the job associated with the job id.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRecordingJobFailedrecordings
public FailedRecordingEntityListing getRecordingJobFailedrecordings(String jobId, Integer pageSize, Integer pageNumber, Boolean includeTotal, String cursor) throws IOException, ApiException Get IDs of recordings that the bulk job failed for- Parameters:
jobId- jobId (required)pageSize- Page size. Maximum is 100. (optional, default to 25)pageNumber- Page number (optional, default to 1)includeTotal- If false, cursor will be used to locate the page instead of pageNumber. It is recommended to set it to false for improved performance. (optional)cursor- Indicates where to resume query results (not required for first page) (optional)- Returns:
- FailedRecordingEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingJobFailedrecordingsWithHttpInfo
public ApiResponse<FailedRecordingEntityListing> getRecordingJobFailedrecordingsWithHttpInfo(String jobId, Integer pageSize, Integer pageNumber, Boolean includeTotal, String cursor) throws IOException Get IDs of recordings that the bulk job failed for- Parameters:
jobId- jobId (required)pageSize- Page size. Maximum is 100. (optional, default to 25)pageNumber- Page number (optional, default to 1)includeTotal- If false, cursor will be used to locate the page instead of pageNumber. It is recommended to set it to false for improved performance. (optional)cursor- Indicates where to resume query results (not required for first page) (optional)- Returns:
- FailedRecordingEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRecordingJobFailedrecordings
public FailedRecordingEntityListing getRecordingJobFailedrecordings(GetRecordingJobFailedrecordingsRequest request) throws IOException, ApiException Get IDs of recordings that the bulk job failed for- Parameters:
request- The request object- Returns:
- FailedRecordingEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingJobFailedrecordings
public ApiResponse<FailedRecordingEntityListing> getRecordingJobFailedrecordings(ApiRequest<Void> request) throws IOException Get IDs of recordings that the bulk job failed for- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRecordingJobs
public RecordingJobEntityListing getRecordingJobs(Integer pageSize, Integer pageNumber, String sortBy, String state, Boolean showOnlyMyJobs, String jobType, Boolean includeTotal, String cursor) throws IOException, ApiException Get the status of all jobs within the user's organization- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)sortBy- Sort by (optional, default to userId)state- Filter by state (optional)showOnlyMyJobs- Show only my jobs (optional)jobType- Job Type (Can be left empty for both) (optional)includeTotal- If false, cursor will be used to locate the page instead of pageNumber. It is recommended to set it to false for improved performance. (optional)cursor- Indicates where to resume query results (not required for first page) (optional)- Returns:
- RecordingJobEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingJobsWithHttpInfo
public ApiResponse<RecordingJobEntityListing> getRecordingJobsWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, String state, Boolean showOnlyMyJobs, String jobType, Boolean includeTotal, String cursor) throws IOException Get the status of all jobs within the user's organization- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)sortBy- Sort by (optional, default to userId)state- Filter by state (optional)showOnlyMyJobs- Show only my jobs (optional)jobType- Job Type (Can be left empty for both) (optional)includeTotal- If false, cursor will be used to locate the page instead of pageNumber. It is recommended to set it to false for improved performance. (optional)cursor- Indicates where to resume query results (not required for first page) (optional)- Returns:
- RecordingJobEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRecordingJobs
public RecordingJobEntityListing getRecordingJobs(GetRecordingJobsRequest request) throws IOException, ApiException Get the status of all jobs within the user's organization- Parameters:
request- The request object- Returns:
- RecordingJobEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingJobs
public ApiResponse<RecordingJobEntityListing> getRecordingJobs(ApiRequest<Void> request) throws IOException Get the status of all jobs within the user's organization- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRecordingKeyconfiguration
public RecordingEncryptionConfiguration getRecordingKeyconfiguration(String keyConfigurationId) throws IOException, ApiException Get the encryption key configurations- Parameters:
keyConfigurationId- Key Configurations Id (required)- Returns:
- RecordingEncryptionConfiguration
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingKeyconfigurationWithHttpInfo
public ApiResponse<RecordingEncryptionConfiguration> getRecordingKeyconfigurationWithHttpInfo(String keyConfigurationId) throws IOException Get the encryption key configurations- Parameters:
keyConfigurationId- Key Configurations Id (required)- Returns:
- RecordingEncryptionConfiguration
- Throws:
IOException- if the request fails to be processed
-
getRecordingKeyconfiguration
public RecordingEncryptionConfiguration getRecordingKeyconfiguration(GetRecordingKeyconfigurationRequest request) throws IOException, ApiException Get the encryption key configurations- Parameters:
request- The request object- Returns:
- RecordingEncryptionConfiguration
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingKeyconfiguration
public ApiResponse<RecordingEncryptionConfiguration> getRecordingKeyconfiguration(ApiRequest<Void> request) throws IOException Get the encryption key configurations- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRecordingKeyconfigurations
public RecordingEncryptionConfigurationListing getRecordingKeyconfigurations() throws IOException, ApiExceptionGet a list of key configurations data- Returns:
- RecordingEncryptionConfigurationListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingKeyconfigurationsWithHttpInfo
public ApiResponse<RecordingEncryptionConfigurationListing> getRecordingKeyconfigurationsWithHttpInfo() throws IOExceptionGet a list of key configurations data- Returns:
- RecordingEncryptionConfigurationListing
- Throws:
IOException- if the request fails to be processed
-
getRecordingKeyconfigurations
public RecordingEncryptionConfigurationListing getRecordingKeyconfigurations(GetRecordingKeyconfigurationsRequest request) throws IOException, ApiException Get a list of key configurations data- Parameters:
request- The request object- Returns:
- RecordingEncryptionConfigurationListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingKeyconfigurations
public ApiResponse<RecordingEncryptionConfigurationListing> getRecordingKeyconfigurations(ApiRequest<Void> request) throws IOException Get a list of key configurations data- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRecordingMediaretentionpolicies
public PolicyEntityListing getRecordingMediaretentionpolicies(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, String name, Boolean enabled, Boolean summary, Boolean hasErrors, Integer deleteDaysThreshold) throws IOException, ApiException 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- Parameters:
pageSize- The total page size requested (optional, default to 25)pageNumber- The page number requested (optional, default to 1)sortBy- variable name requested to sort by (optional)expand- variable name requested by expand list (optional)nextPage- next page token (optional)previousPage- Previous page token (optional)name- the policy name - used for filtering results in searches. (optional)enabled- checks to see if policy is enabled - use enabled = true or enabled = false (optional)summary- provides a less verbose response of policy lists. (optional, default to false)hasErrors- provides a way to fetch all policies with errors or policies that do not have errors (optional)deleteDaysThreshold- provides a way to fetch all policies with any actions having deleteDays exceeding the provided value (optional)- Returns:
- PolicyEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingMediaretentionpoliciesWithHttpInfo
public ApiResponse<PolicyEntityListing> getRecordingMediaretentionpoliciesWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, String name, Boolean enabled, Boolean summary, Boolean hasErrors, Integer deleteDaysThreshold) throws IOException 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- Parameters:
pageSize- The total page size requested (optional, default to 25)pageNumber- The page number requested (optional, default to 1)sortBy- variable name requested to sort by (optional)expand- variable name requested by expand list (optional)nextPage- next page token (optional)previousPage- Previous page token (optional)name- the policy name - used for filtering results in searches. (optional)enabled- checks to see if policy is enabled - use enabled = true or enabled = false (optional)summary- provides a less verbose response of policy lists. (optional, default to false)hasErrors- provides a way to fetch all policies with errors or policies that do not have errors (optional)deleteDaysThreshold- provides a way to fetch all policies with any actions having deleteDays exceeding the provided value (optional)- Returns:
- PolicyEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRecordingMediaretentionpolicies
public PolicyEntityListing getRecordingMediaretentionpolicies(GetRecordingMediaretentionpoliciesRequest request) throws IOException, ApiException 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- Parameters:
request- The request object- Returns:
- PolicyEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingMediaretentionpolicies
public ApiResponse<PolicyEntityListing> getRecordingMediaretentionpolicies(ApiRequest<Void> request) throws IOException 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- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRecordingMediaretentionpolicy
Get a media retention policy- Parameters:
policyId- Policy ID (required)- Returns:
- Policy
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingMediaretentionpolicyWithHttpInfo
public ApiResponse<Policy> getRecordingMediaretentionpolicyWithHttpInfo(String policyId) throws IOException Get a media retention policy- Parameters:
policyId- Policy ID (required)- Returns:
- Policy
- Throws:
IOException- if the request fails to be processed
-
getRecordingMediaretentionpolicy
public Policy getRecordingMediaretentionpolicy(GetRecordingMediaretentionpolicyRequest request) throws IOException, ApiException Get a media retention policy- Parameters:
request- The request object- Returns:
- Policy
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingMediaretentionpolicy
public ApiResponse<Policy> getRecordingMediaretentionpolicy(ApiRequest<Void> request) throws IOException Get a media retention policy- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRecordingRecordingkeys
public EncryptionKeyEntityListing getRecordingRecordingkeys(Integer pageSize, Integer pageNumber) throws IOException, ApiException Get encryption key list- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)- Returns:
- EncryptionKeyEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingRecordingkeysWithHttpInfo
public ApiResponse<EncryptionKeyEntityListing> getRecordingRecordingkeysWithHttpInfo(Integer pageSize, Integer pageNumber) throws IOException Get encryption key list- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)- Returns:
- EncryptionKeyEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRecordingRecordingkeys
public EncryptionKeyEntityListing getRecordingRecordingkeys(GetRecordingRecordingkeysRequest request) throws IOException, ApiException Get encryption key list- Parameters:
request- The request object- Returns:
- EncryptionKeyEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingRecordingkeys
public ApiResponse<EncryptionKeyEntityListing> getRecordingRecordingkeys(ApiRequest<Void> request) throws IOException Get encryption key list- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRecordingRecordingkeysRotationschedule
public KeyRotationSchedule getRecordingRecordingkeysRotationschedule() throws IOException, ApiExceptionGet key rotation schedule- Returns:
- KeyRotationSchedule
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingRecordingkeysRotationscheduleWithHttpInfo
public ApiResponse<KeyRotationSchedule> getRecordingRecordingkeysRotationscheduleWithHttpInfo() throws IOExceptionGet key rotation schedule- Returns:
- KeyRotationSchedule
- Throws:
IOException- if the request fails to be processed
-
getRecordingRecordingkeysRotationschedule
public KeyRotationSchedule getRecordingRecordingkeysRotationschedule(GetRecordingRecordingkeysRotationscheduleRequest request) throws IOException, ApiException Get key rotation schedule- Parameters:
request- The request object- Returns:
- KeyRotationSchedule
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingRecordingkeysRotationschedule
public ApiResponse<KeyRotationSchedule> getRecordingRecordingkeysRotationschedule(ApiRequest<Void> request) throws IOException Get key rotation schedule- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRecordingSettings
public RecordingSettings getRecordingSettings(Boolean createDefault) throws IOException, ApiException Get the Recording Settings for the Organization- Parameters:
createDefault- If no settings are found, a new one is created with default values (optional, default to false)- Returns:
- RecordingSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingSettingsWithHttpInfo
public ApiResponse<RecordingSettings> getRecordingSettingsWithHttpInfo(Boolean createDefault) throws IOException Get the Recording Settings for the Organization- Parameters:
createDefault- If no settings are found, a new one is created with default values (optional, default to false)- Returns:
- RecordingSettings
- Throws:
IOException- if the request fails to be processed
-
getRecordingSettings
public RecordingSettings getRecordingSettings(GetRecordingSettingsRequest request) throws IOException, ApiException Get the Recording Settings for the Organization- Parameters:
request- The request object- Returns:
- RecordingSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingSettings
public ApiResponse<RecordingSettings> getRecordingSettings(ApiRequest<Void> request) throws IOException Get the Recording Settings for the Organization- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRecordingUploadsReport
public RecordingUploadReport getRecordingUploadsReport(String reportId) throws IOException, ApiException Get the status of a recording upload status report- Parameters:
reportId- reportId (required)- Returns:
- RecordingUploadReport
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingUploadsReportWithHttpInfo
public ApiResponse<RecordingUploadReport> getRecordingUploadsReportWithHttpInfo(String reportId) throws IOException Get the status of a recording upload status report- Parameters:
reportId- reportId (required)- Returns:
- RecordingUploadReport
- Throws:
IOException- if the request fails to be processed
-
getRecordingUploadsReport
public RecordingUploadReport getRecordingUploadsReport(GetRecordingUploadsReportRequest request) throws IOException, ApiException Get the status of a recording upload status report- Parameters:
request- The request object- Returns:
- RecordingUploadReport
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingUploadsReport
public ApiResponse<RecordingUploadReport> getRecordingUploadsReport(ApiRequest<Void> request) throws IOException Get the status of a recording upload status report- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRecordingsRetentionQuery
public RecordingRetentionCursorEntityListing getRecordingsRetentionQuery(Integer retentionThresholdDays, String cursor, Integer pageSize) throws IOException, ApiException Query for recording retention data- Parameters:
retentionThresholdDays- Fetch retention data for recordings retained for more days than the provided value. (required)cursor- Indicates where to resume query results (not required for first page) (optional)pageSize- Page size. Maximum is 500. (optional, default to 25)- Returns:
- RecordingRetentionCursorEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingsRetentionQueryWithHttpInfo
public ApiResponse<RecordingRetentionCursorEntityListing> getRecordingsRetentionQueryWithHttpInfo(Integer retentionThresholdDays, String cursor, Integer pageSize) throws IOException Query for recording retention data- Parameters:
retentionThresholdDays- Fetch retention data for recordings retained for more days than the provided value. (required)cursor- Indicates where to resume query results (not required for first page) (optional)pageSize- Page size. Maximum is 500. (optional, default to 25)- Returns:
- RecordingRetentionCursorEntityListing
- Throws:
IOException- if the request fails to be processed
-
getRecordingsRetentionQuery
public RecordingRetentionCursorEntityListing getRecordingsRetentionQuery(GetRecordingsRetentionQueryRequest request) throws IOException, ApiException Query for recording retention data- Parameters:
request- The request object- Returns:
- RecordingRetentionCursorEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingsRetentionQuery
public ApiResponse<RecordingRetentionCursorEntityListing> getRecordingsRetentionQuery(ApiRequest<Void> request) throws IOException Query for recording retention data- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRecordingsScreensessionsDetails
public ScreenRecordingActiveSessions getRecordingsScreensessionsDetails() throws IOException, ApiExceptionRetrieves an object containing the total number of concurrent active screen recordings- Returns:
- ScreenRecordingActiveSessions
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingsScreensessionsDetailsWithHttpInfo
public ApiResponse<ScreenRecordingActiveSessions> getRecordingsScreensessionsDetailsWithHttpInfo() throws IOExceptionRetrieves an object containing the total number of concurrent active screen recordings- Returns:
- ScreenRecordingActiveSessions
- Throws:
IOException- if the request fails to be processed
-
getRecordingsScreensessionsDetails
public ScreenRecordingActiveSessions getRecordingsScreensessionsDetails(GetRecordingsScreensessionsDetailsRequest request) throws IOException, ApiException Retrieves an object containing the total number of concurrent active screen recordings- Parameters:
request- The request object- Returns:
- ScreenRecordingActiveSessions
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRecordingsScreensessionsDetails
public ApiResponse<ScreenRecordingActiveSessions> getRecordingsScreensessionsDetails(ApiRequest<Void> request) throws IOException Retrieves an object containing the total number of concurrent active screen recordings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchRecordingCrossplatformMediaretentionpolicy
public CrossPlatformPolicy patchRecordingCrossplatformMediaretentionpolicy(String policyId, CrossPlatformPolicyUpdate body) throws IOException, ApiException Patch a media retention policy- Parameters:
policyId- Policy ID (required)body- Policy (required)- Returns:
- CrossPlatformPolicy
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRecordingCrossplatformMediaretentionpolicyWithHttpInfo
public ApiResponse<CrossPlatformPolicy> patchRecordingCrossplatformMediaretentionpolicyWithHttpInfo(String policyId, CrossPlatformPolicyUpdate body) throws IOException Patch a media retention policy- Parameters:
policyId- Policy ID (required)body- Policy (required)- Returns:
- CrossPlatformPolicy
- Throws:
IOException- if the request fails to be processed
-
patchRecordingCrossplatformMediaretentionpolicy
public CrossPlatformPolicy patchRecordingCrossplatformMediaretentionpolicy(PatchRecordingCrossplatformMediaretentionpolicyRequest request) throws IOException, ApiException Patch a media retention policy- Parameters:
request- The request object- Returns:
- CrossPlatformPolicy
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRecordingCrossplatformMediaretentionpolicy
public ApiResponse<CrossPlatformPolicy> patchRecordingCrossplatformMediaretentionpolicy(ApiRequest<CrossPlatformPolicyUpdate> request) throws IOException Patch a media retention policy- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchRecordingMediaretentionpolicy
public Policy patchRecordingMediaretentionpolicy(String policyId, PolicyUpdate body) throws IOException, ApiException Patch a media retention policy- Parameters:
policyId- Policy ID (required)body- Policy (required)- Returns:
- Policy
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRecordingMediaretentionpolicyWithHttpInfo
public ApiResponse<Policy> patchRecordingMediaretentionpolicyWithHttpInfo(String policyId, PolicyUpdate body) throws IOException Patch a media retention policy- Parameters:
policyId- Policy ID (required)body- Policy (required)- Returns:
- Policy
- Throws:
IOException- if the request fails to be processed
-
patchRecordingMediaretentionpolicy
public Policy patchRecordingMediaretentionpolicy(PatchRecordingMediaretentionpolicyRequest request) throws IOException, ApiException Patch a media retention policy- Parameters:
request- The request object- Returns:
- Policy
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchRecordingMediaretentionpolicy
public ApiResponse<Policy> patchRecordingMediaretentionpolicy(ApiRequest<PolicyUpdate> request) throws IOException Patch a media retention policy- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postConversationRecordingAnnotations
public Annotation postConversationRecordingAnnotations(String conversationId, String recordingId, Annotation body) throws IOException, ApiException Create annotation If the annotation does not exist on the recording, it is created. If it already exists, it is updated. The recording:annotation:add permission is required for creates, and recording:annotation:edit is required for updates.- Parameters:
conversationId- Conversation ID (required)recordingId- Recording ID (required)body- annotation (required)- Returns:
- Annotation
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postConversationRecordingAnnotationsWithHttpInfo
public ApiResponse<Annotation> postConversationRecordingAnnotationsWithHttpInfo(String conversationId, String recordingId, Annotation body) throws IOException Create annotation If the annotation does not exist on the recording, it is created. If it already exists, it is updated. The recording:annotation:add permission is required for creates, and recording:annotation:edit is required for updates.- Parameters:
conversationId- Conversation ID (required)recordingId- Recording ID (required)body- annotation (required)- Returns:
- Annotation
- Throws:
IOException- if the request fails to be processed
-
postConversationRecordingAnnotations
public Annotation postConversationRecordingAnnotations(PostConversationRecordingAnnotationsRequest request) throws IOException, ApiException Create annotation If the annotation does not exist on the recording, it is created. If it already exists, it is updated. The recording:annotation:add permission is required for creates, and recording:annotation:edit is required for updates.- Parameters:
request- The request object- Returns:
- Annotation
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postConversationRecordingAnnotations
public ApiResponse<Annotation> postConversationRecordingAnnotations(ApiRequest<Annotation> request) throws IOException Create annotation If the annotation does not exist on the recording, it is created. If it already exists, it is updated. The recording:annotation:add permission is required for creates, and recording:annotation:edit is required for updates.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRecordingBatchrequests
public BatchDownloadJobSubmissionResult postRecordingBatchrequests(BatchDownloadJobSubmission body) throws IOException, ApiException Submit a batch download request for recordings. Recordings in response will be in their original format/codec - configured in the Trunk configuration. If the recording:recording:viewSensitiveData permission is missing and the organization has sensitive data redaction enabled, recordings with sensitive data will be excluded from the batch download.- Parameters:
body- Job submission criteria (required)- Returns:
- BatchDownloadJobSubmissionResult
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRecordingBatchrequestsWithHttpInfo
public ApiResponse<BatchDownloadJobSubmissionResult> postRecordingBatchrequestsWithHttpInfo(BatchDownloadJobSubmission body) throws IOException Submit a batch download request for recordings. Recordings in response will be in their original format/codec - configured in the Trunk configuration. If the recording:recording:viewSensitiveData permission is missing and the organization has sensitive data redaction enabled, recordings with sensitive data will be excluded from the batch download.- Parameters:
body- Job submission criteria (required)- Returns:
- BatchDownloadJobSubmissionResult
- Throws:
IOException- if the request fails to be processed
-
postRecordingBatchrequests
public BatchDownloadJobSubmissionResult postRecordingBatchrequests(PostRecordingBatchrequestsRequest request) throws IOException, ApiException Submit a batch download request for recordings. Recordings in response will be in their original format/codec - configured in the Trunk configuration. If the recording:recording:viewSensitiveData permission is missing and the organization has sensitive data redaction enabled, recordings with sensitive data will be excluded from the batch download.- Parameters:
request- The request object- Returns:
- BatchDownloadJobSubmissionResult
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRecordingBatchrequests
public ApiResponse<BatchDownloadJobSubmissionResult> postRecordingBatchrequests(ApiRequest<BatchDownloadJobSubmission> request) throws IOException Submit a batch download request for recordings. Recordings in response will be in their original format/codec - configured in the Trunk configuration. If the recording:recording:viewSensitiveData permission is missing and the organization has sensitive data redaction enabled, recordings with sensitive data will be excluded from the batch download.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRecordingCrossplatformMediaretentionpolicies
public CrossPlatformPolicy postRecordingCrossplatformMediaretentionpolicies(CrossPlatformPolicyCreate body) throws IOException, ApiException Create media retention policy Policy does not work retroactively- Parameters:
body- Policy (required)- Returns:
- CrossPlatformPolicy
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRecordingCrossplatformMediaretentionpoliciesWithHttpInfo
public ApiResponse<CrossPlatformPolicy> postRecordingCrossplatformMediaretentionpoliciesWithHttpInfo(CrossPlatformPolicyCreate body) throws IOException Create media retention policy Policy does not work retroactively- Parameters:
body- Policy (required)- Returns:
- CrossPlatformPolicy
- Throws:
IOException- if the request fails to be processed
-
postRecordingCrossplatformMediaretentionpolicies
public CrossPlatformPolicy postRecordingCrossplatformMediaretentionpolicies(PostRecordingCrossplatformMediaretentionpoliciesRequest request) throws IOException, ApiException Create media retention policy Policy does not work retroactively- Parameters:
request- The request object- Returns:
- CrossPlatformPolicy
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRecordingCrossplatformMediaretentionpolicies
public ApiResponse<CrossPlatformPolicy> postRecordingCrossplatformMediaretentionpolicies(ApiRequest<CrossPlatformPolicyCreate> request) throws IOException Create media retention policy Policy does not work retroactively- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRecordingJobs
Create a recording bulk job. Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. Furthermore, the recording:recording:viewSensitiveData permission is required to access recordings with PCI DSS and/or PII data when redaction is enabled for their organization. If the requester does not have that permission and includeRecordingsWithSensitiveData is set to true, then their request will be rejected. It is recommended to query over smaller time periods so your request does not time out.- Parameters:
body- query (required)- Returns:
- RecordingJob
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRecordingJobsWithHttpInfo
public ApiResponse<RecordingJob> postRecordingJobsWithHttpInfo(RecordingJobsQuery body) throws IOException Create a recording bulk job. Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. Furthermore, the recording:recording:viewSensitiveData permission is required to access recordings with PCI DSS and/or PII data when redaction is enabled for their organization. If the requester does not have that permission and includeRecordingsWithSensitiveData is set to true, then their request will be rejected. It is recommended to query over smaller time periods so your request does not time out.- Parameters:
body- query (required)- Returns:
- RecordingJob
- Throws:
IOException- if the request fails to be processed
-
postRecordingJobs
public RecordingJob postRecordingJobs(PostRecordingJobsRequest request) throws IOException, ApiException Create a recording bulk job. Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. Furthermore, the recording:recording:viewSensitiveData permission is required to access recordings with PCI DSS and/or PII data when redaction is enabled for their organization. If the requester does not have that permission and includeRecordingsWithSensitiveData is set to true, then their request will be rejected. It is recommended to query over smaller time periods so your request does not time out.- Parameters:
request- The request object- Returns:
- RecordingJob
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRecordingJobs
public ApiResponse<RecordingJob> postRecordingJobs(ApiRequest<RecordingJobsQuery> request) throws IOException Create a recording bulk job. Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. Furthermore, the recording:recording:viewSensitiveData permission is required to access recordings with PCI DSS and/or PII data when redaction is enabled for their organization. If the requester does not have that permission and includeRecordingsWithSensitiveData is set to true, then their request will be rejected. It is recommended to query over smaller time periods so your request does not time out.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRecordingKeyconfigurations
public RecordingEncryptionConfiguration postRecordingKeyconfigurations(RecordingEncryptionConfiguration body) throws IOException, ApiException Setup configurations for encryption key creation- Parameters:
body- Encryption Configuration (required)- Returns:
- RecordingEncryptionConfiguration
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRecordingKeyconfigurationsWithHttpInfo
public ApiResponse<RecordingEncryptionConfiguration> postRecordingKeyconfigurationsWithHttpInfo(RecordingEncryptionConfiguration body) throws IOException Setup configurations for encryption key creation- Parameters:
body- Encryption Configuration (required)- Returns:
- RecordingEncryptionConfiguration
- Throws:
IOException- if the request fails to be processed
-
postRecordingKeyconfigurations
public RecordingEncryptionConfiguration postRecordingKeyconfigurations(PostRecordingKeyconfigurationsRequest request) throws IOException, ApiException Setup configurations for encryption key creation- Parameters:
request- The request object- Returns:
- RecordingEncryptionConfiguration
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRecordingKeyconfigurations
public ApiResponse<RecordingEncryptionConfiguration> postRecordingKeyconfigurations(ApiRequest<RecordingEncryptionConfiguration> request) throws IOException Setup configurations for encryption key creation- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRecordingKeyconfigurationsValidate
public RecordingEncryptionConfiguration postRecordingKeyconfigurationsValidate(RecordingEncryptionConfiguration body) throws IOException, ApiException Validate encryption key configurations without saving it- Parameters:
body- Encryption Configuration (required)- Returns:
- RecordingEncryptionConfiguration
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRecordingKeyconfigurationsValidateWithHttpInfo
public ApiResponse<RecordingEncryptionConfiguration> postRecordingKeyconfigurationsValidateWithHttpInfo(RecordingEncryptionConfiguration body) throws IOException Validate encryption key configurations without saving it- Parameters:
body- Encryption Configuration (required)- Returns:
- RecordingEncryptionConfiguration
- Throws:
IOException- if the request fails to be processed
-
postRecordingKeyconfigurationsValidate
public RecordingEncryptionConfiguration postRecordingKeyconfigurationsValidate(PostRecordingKeyconfigurationsValidateRequest request) throws IOException, ApiException Validate encryption key configurations without saving it- Parameters:
request- The request object- Returns:
- RecordingEncryptionConfiguration
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRecordingKeyconfigurationsValidate
public ApiResponse<RecordingEncryptionConfiguration> postRecordingKeyconfigurationsValidate(ApiRequest<RecordingEncryptionConfiguration> request) throws IOException Validate encryption key configurations without saving it- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRecordingLocalkeys
public EncryptionKey postRecordingLocalkeys(LocalEncryptionKeyRequest body) throws IOException, ApiException create a local key management recording key- Parameters:
body- Local Encryption body (required)- Returns:
- EncryptionKey
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRecordingLocalkeysWithHttpInfo
public ApiResponse<EncryptionKey> postRecordingLocalkeysWithHttpInfo(LocalEncryptionKeyRequest body) throws IOException create a local key management recording key- Parameters:
body- Local Encryption body (required)- Returns:
- EncryptionKey
- Throws:
IOException- if the request fails to be processed
-
postRecordingLocalkeys
public EncryptionKey postRecordingLocalkeys(PostRecordingLocalkeysRequest request) throws IOException, ApiException create a local key management recording key- Parameters:
request- The request object- Returns:
- EncryptionKey
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRecordingLocalkeys
public ApiResponse<EncryptionKey> postRecordingLocalkeys(ApiRequest<LocalEncryptionKeyRequest> request) throws IOException create a local key management recording key- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRecordingMediaretentionpolicies
public Policy postRecordingMediaretentionpolicies(PolicyCreate body) throws IOException, ApiException Create media retention policy Policy does not work retroactively- Parameters:
body- Policy (required)- Returns:
- Policy
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRecordingMediaretentionpoliciesWithHttpInfo
public ApiResponse<Policy> postRecordingMediaretentionpoliciesWithHttpInfo(PolicyCreate body) throws IOException Create media retention policy Policy does not work retroactively- Parameters:
body- Policy (required)- Returns:
- Policy
- Throws:
IOException- if the request fails to be processed
-
postRecordingMediaretentionpolicies
public Policy postRecordingMediaretentionpolicies(PostRecordingMediaretentionpoliciesRequest request) throws IOException, ApiException Create media retention policy Policy does not work retroactively- Parameters:
request- The request object- Returns:
- Policy
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRecordingMediaretentionpolicies
public ApiResponse<Policy> postRecordingMediaretentionpolicies(ApiRequest<PolicyCreate> request) throws IOException Create media retention policy Policy does not work retroactively- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRecordingRecordingkeys
Create encryption key- Returns:
- EncryptionKey
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRecordingRecordingkeysWithHttpInfo
Create encryption key- Returns:
- EncryptionKey
- Throws:
IOException- if the request fails to be processed
-
postRecordingRecordingkeys
public EncryptionKey postRecordingRecordingkeys(PostRecordingRecordingkeysRequest request) throws IOException, ApiException Create encryption key- Parameters:
request- The request object- Returns:
- EncryptionKey
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRecordingRecordingkeys
public ApiResponse<EncryptionKey> postRecordingRecordingkeys(ApiRequest<Void> request) throws IOException Create encryption key- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRecordingUploadsReports
public RecordingUploadReport postRecordingUploadsReports(RecordingUploadReportRequest body) throws IOException, ApiException Creates a recording upload status report- Parameters:
body- Report parameters (required)- Returns:
- RecordingUploadReport
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRecordingUploadsReportsWithHttpInfo
public ApiResponse<RecordingUploadReport> postRecordingUploadsReportsWithHttpInfo(RecordingUploadReportRequest body) throws IOException Creates a recording upload status report- Parameters:
body- Report parameters (required)- Returns:
- RecordingUploadReport
- Throws:
IOException- if the request fails to be processed
-
postRecordingUploadsReports
public RecordingUploadReport postRecordingUploadsReports(PostRecordingUploadsReportsRequest request) throws IOException, ApiException Creates a recording upload status report- Parameters:
request- The request object- Returns:
- RecordingUploadReport
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRecordingUploadsReports
public ApiResponse<RecordingUploadReport> postRecordingUploadsReports(ApiRequest<RecordingUploadReportRequest> request) throws IOException Creates a recording upload status report- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRecordingsDeletionprotection
public List<AddressableEntityRef> postRecordingsDeletionprotection(ConversationDeletionProtectionQuery body) throws IOException, ApiException Get a list of conversations with protected recordings- Parameters:
body- conversationIds (required)- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRecordingsDeletionprotectionWithHttpInfo
public ApiResponse<List<AddressableEntityRef>> postRecordingsDeletionprotectionWithHttpInfo(ConversationDeletionProtectionQuery body) throws IOException Get a list of conversations with protected recordings- Parameters:
body- conversationIds (required)- Returns:
- List
- Throws:
IOException- if the request fails to be processed
-
postRecordingsDeletionprotection
public List<AddressableEntityRef> postRecordingsDeletionprotection(PostRecordingsDeletionprotectionRequest request) throws IOException, ApiException Get a list of conversations with protected recordings- Parameters:
request- The request object- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRecordingsDeletionprotection
public ApiResponse<List<AddressableEntityRef>> postRecordingsDeletionprotection(ApiRequest<ConversationDeletionProtectionQuery> request) throws IOException Get a list of conversations with protected recordings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRecordingsScreensessionsAcknowledge
public void postRecordingsScreensessionsAcknowledge(AcknowledgeScreenRecordingRequest body) throws IOException, ApiException Acknowledge a screen recording.- Parameters:
body- AcknowledgeScreenRecordingRequest (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRecordingsScreensessionsAcknowledgeWithHttpInfo
public ApiResponse<Void> postRecordingsScreensessionsAcknowledgeWithHttpInfo(AcknowledgeScreenRecordingRequest body) throws IOException Acknowledge a screen recording.- Parameters:
body- AcknowledgeScreenRecordingRequest (required)- Throws:
IOException- if the request fails to be processed
-
postRecordingsScreensessionsAcknowledge
public void postRecordingsScreensessionsAcknowledge(PostRecordingsScreensessionsAcknowledgeRequest request) throws IOException, ApiException Acknowledge a screen recording.- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRecordingsScreensessionsAcknowledge
public ApiResponse<Void> postRecordingsScreensessionsAcknowledge(ApiRequest<AcknowledgeScreenRecordingRequest> request) throws IOException Acknowledge a screen recording.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postRecordingsScreensessionsMetadata
public void postRecordingsScreensessionsMetadata(ScreenRecordingMetaDataRequest body) throws IOException, ApiException Provide meta-data a screen recording.- Parameters:
body- ScreenRecordingMetaDataRequest (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRecordingsScreensessionsMetadataWithHttpInfo
public ApiResponse<Void> postRecordingsScreensessionsMetadataWithHttpInfo(ScreenRecordingMetaDataRequest body) throws IOException Provide meta-data a screen recording.- Parameters:
body- ScreenRecordingMetaDataRequest (required)- Throws:
IOException- if the request fails to be processed
-
postRecordingsScreensessionsMetadata
public void postRecordingsScreensessionsMetadata(PostRecordingsScreensessionsMetadataRequest request) throws IOException, ApiException Provide meta-data a screen recording.- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postRecordingsScreensessionsMetadata
public ApiResponse<Void> postRecordingsScreensessionsMetadata(ApiRequest<ScreenRecordingMetaDataRequest> request) throws IOException Provide meta-data a screen recording.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putConversationRecording
public Recording putConversationRecording(String conversationId, String recordingId, Recording body, Boolean clearExport) throws IOException, ApiException 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. Required permissions depend on the operation: view (recording, screenRecording, or snippetRecording) is always required; editRetention is required when updating retention dates except for restoration; restore is required when restoring an archived recording.- Parameters:
conversationId- Conversation ID (required)recordingId- Recording ID (required)body- recording (required)clearExport- Whether to clear the pending export for the recording (optional)- Returns:
- Recording
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putConversationRecordingWithHttpInfo
public ApiResponse<Recording> putConversationRecordingWithHttpInfo(String conversationId, String recordingId, Recording body, Boolean clearExport) throws IOException 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. Required permissions depend on the operation: view (recording, screenRecording, or snippetRecording) is always required; editRetention is required when updating retention dates except for restoration; restore is required when restoring an archived recording.- Parameters:
conversationId- Conversation ID (required)recordingId- Recording ID (required)body- recording (required)clearExport- Whether to clear the pending export for the recording (optional)- Returns:
- Recording
- Throws:
IOException- if the request fails to be processed
-
putConversationRecording
public Recording putConversationRecording(PutConversationRecordingRequest request) throws IOException, ApiException 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. Required permissions depend on the operation: view (recording, screenRecording, or snippetRecording) is always required; editRetention is required when updating retention dates except for restoration; restore is required when restoring an archived recording.- Parameters:
request- The request object- Returns:
- Recording
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putConversationRecording
public ApiResponse<Recording> putConversationRecording(ApiRequest<Recording> request) throws IOException 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. Required permissions depend on the operation: view (recording, screenRecording, or snippetRecording) is always required; editRetention is required when updating retention dates except for restoration; restore is required when restoring an archived recording.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putConversationRecordingAnnotation
public Annotation putConversationRecordingAnnotation(String conversationId, String recordingId, String annotationId, Annotation body) throws IOException, ApiException Update annotation If the annotation does not exist on the recording, it is created. If it already exists, it is updated. The recording:annotation:add permission is required for creates, and recording:annotation:edit is required for updates.- Parameters:
conversationId- Conversation ID (required)recordingId- Recording ID (required)annotationId- Annotation ID (required)body- annotation (required)- Returns:
- Annotation
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putConversationRecordingAnnotationWithHttpInfo
public ApiResponse<Annotation> putConversationRecordingAnnotationWithHttpInfo(String conversationId, String recordingId, String annotationId, Annotation body) throws IOException Update annotation If the annotation does not exist on the recording, it is created. If it already exists, it is updated. The recording:annotation:add permission is required for creates, and recording:annotation:edit is required for updates.- Parameters:
conversationId- Conversation ID (required)recordingId- Recording ID (required)annotationId- Annotation ID (required)body- annotation (required)- Returns:
- Annotation
- Throws:
IOException- if the request fails to be processed
-
putConversationRecordingAnnotation
public Annotation putConversationRecordingAnnotation(PutConversationRecordingAnnotationRequest request) throws IOException, ApiException Update annotation If the annotation does not exist on the recording, it is created. If it already exists, it is updated. The recording:annotation:add permission is required for creates, and recording:annotation:edit is required for updates.- Parameters:
request- The request object- Returns:
- Annotation
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putConversationRecordingAnnotation
public ApiResponse<Annotation> putConversationRecordingAnnotation(ApiRequest<Annotation> request) throws IOException Update annotation If the annotation does not exist on the recording, it is created. If it already exists, it is updated. The recording:annotation:add permission is required for creates, and recording:annotation:edit is required for updates.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putOrphanrecording
public Recording putOrphanrecording(String orphanId, OrphanUpdateRequest body) throws IOException, ApiException 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.- Parameters:
orphanId- Orphan ID (required)body- (optional)- Returns:
- Recording
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putOrphanrecordingWithHttpInfo
public ApiResponse<Recording> putOrphanrecordingWithHttpInfo(String orphanId, OrphanUpdateRequest body) throws IOException 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.- Parameters:
orphanId- Orphan ID (required)body- (optional)- Returns:
- Recording
- Throws:
IOException- if the request fails to be processed
-
putOrphanrecording
public Recording putOrphanrecording(PutOrphanrecordingRequest request) throws IOException, ApiException 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.- Parameters:
request- The request object- Returns:
- Recording
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putOrphanrecording
public ApiResponse<Recording> putOrphanrecording(ApiRequest<OrphanUpdateRequest> request) throws IOException 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.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putRecordingCrossplatformMediaretentionpolicy
public CrossPlatformPolicy putRecordingCrossplatformMediaretentionpolicy(String policyId, CrossPlatformPolicy body) throws IOException, ApiException Update a media retention policy Policy does not work retroactively- Parameters:
policyId- Policy ID (required)body- Policy (required)- Returns:
- CrossPlatformPolicy
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRecordingCrossplatformMediaretentionpolicyWithHttpInfo
public ApiResponse<CrossPlatformPolicy> putRecordingCrossplatformMediaretentionpolicyWithHttpInfo(String policyId, CrossPlatformPolicy body) throws IOException Update a media retention policy Policy does not work retroactively- Parameters:
policyId- Policy ID (required)body- Policy (required)- Returns:
- CrossPlatformPolicy
- Throws:
IOException- if the request fails to be processed
-
putRecordingCrossplatformMediaretentionpolicy
public CrossPlatformPolicy putRecordingCrossplatformMediaretentionpolicy(PutRecordingCrossplatformMediaretentionpolicyRequest request) throws IOException, ApiException Update a media retention policy Policy does not work retroactively- Parameters:
request- The request object- Returns:
- CrossPlatformPolicy
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRecordingCrossplatformMediaretentionpolicy
public ApiResponse<CrossPlatformPolicy> putRecordingCrossplatformMediaretentionpolicy(ApiRequest<CrossPlatformPolicy> request) throws IOException Update a media retention policy Policy does not work retroactively- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putRecordingJob
public RecordingJob putRecordingJob(String jobId, ExecuteRecordingJobsQuery body) throws IOException, ApiException Execute the recording bulk job. Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. A job must be executed by the same user whom originally created the job. In addition, the user must have permission to update the recording's retention.- Parameters:
jobId- jobId (required)body- query (required)- Returns:
- RecordingJob
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRecordingJobWithHttpInfo
public ApiResponse<RecordingJob> putRecordingJobWithHttpInfo(String jobId, ExecuteRecordingJobsQuery body) throws IOException Execute the recording bulk job. Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. A job must be executed by the same user whom originally created the job. In addition, the user must have permission to update the recording's retention.- Parameters:
jobId- jobId (required)body- query (required)- Returns:
- RecordingJob
- Throws:
IOException- if the request fails to be processed
-
putRecordingJob
public RecordingJob putRecordingJob(PutRecordingJobRequest request) throws IOException, ApiException Execute the recording bulk job. Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. A job must be executed by the same user whom originally created the job. In addition, the user must have permission to update the recording's retention.- Parameters:
request- The request object- Returns:
- RecordingJob
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRecordingJob
public ApiResponse<RecordingJob> putRecordingJob(ApiRequest<ExecuteRecordingJobsQuery> request) throws IOException Execute the recording bulk job. Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. A job must be executed by the same user whom originally created the job. In addition, the user must have permission to update the recording's retention.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putRecordingKeyconfiguration
public RecordingEncryptionConfiguration putRecordingKeyconfiguration(String keyConfigurationId, RecordingEncryptionConfiguration body) throws IOException, ApiException Update the encryption key configurations- Parameters:
keyConfigurationId- Key Configurations Id (required)body- Encryption key configuration metadata (required)- Returns:
- RecordingEncryptionConfiguration
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRecordingKeyconfigurationWithHttpInfo
public ApiResponse<RecordingEncryptionConfiguration> putRecordingKeyconfigurationWithHttpInfo(String keyConfigurationId, RecordingEncryptionConfiguration body) throws IOException Update the encryption key configurations- Parameters:
keyConfigurationId- Key Configurations Id (required)body- Encryption key configuration metadata (required)- Returns:
- RecordingEncryptionConfiguration
- Throws:
IOException- if the request fails to be processed
-
putRecordingKeyconfiguration
public RecordingEncryptionConfiguration putRecordingKeyconfiguration(PutRecordingKeyconfigurationRequest request) throws IOException, ApiException Update the encryption key configurations- Parameters:
request- The request object- Returns:
- RecordingEncryptionConfiguration
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRecordingKeyconfiguration
public ApiResponse<RecordingEncryptionConfiguration> putRecordingKeyconfiguration(ApiRequest<RecordingEncryptionConfiguration> request) throws IOException Update the encryption key configurations- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putRecordingMediaretentionpolicy
public Policy putRecordingMediaretentionpolicy(String policyId, Policy body) throws IOException, ApiException Update a media retention policy Policy does not work retroactively. In the conditions.forUsers section, each user object can include the 'id' field containing the user's unique identifier. Example: [{\"id\":\"\"}]. - Parameters:
policyId- Policy ID (required)body- Policy (required)- Returns:
- Policy
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRecordingMediaretentionpolicyWithHttpInfo
public ApiResponse<Policy> putRecordingMediaretentionpolicyWithHttpInfo(String policyId, Policy body) throws IOException Update a media retention policy Policy does not work retroactively. In the conditions.forUsers section, each user object can include the 'id' field containing the user's unique identifier. Example: [{\"id\":\"\"}]. - Parameters:
policyId- Policy ID (required)body- Policy (required)- Returns:
- Policy
- Throws:
IOException- if the request fails to be processed
-
putRecordingMediaretentionpolicy
public Policy putRecordingMediaretentionpolicy(PutRecordingMediaretentionpolicyRequest request) throws IOException, ApiException Update a media retention policy Policy does not work retroactively. In the conditions.forUsers section, each user object can include the 'id' field containing the user's unique identifier. Example: [{\"id\":\"\"}]. - Parameters:
request- The request object- Returns:
- Policy
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRecordingMediaretentionpolicy
public ApiResponse<Policy> putRecordingMediaretentionpolicy(ApiRequest<Policy> request) throws IOException Update a media retention policy Policy does not work retroactively. In the conditions.forUsers section, each user object can include the 'id' field containing the user's unique identifier. Example: [{\"id\":\"\"}]. - Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putRecordingRecordingkeysRotationschedule
public KeyRotationSchedule putRecordingRecordingkeysRotationschedule(KeyRotationSchedule body) throws IOException, ApiException Update key rotation schedule- Parameters:
body- KeyRotationSchedule (required)- Returns:
- KeyRotationSchedule
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRecordingRecordingkeysRotationscheduleWithHttpInfo
public ApiResponse<KeyRotationSchedule> putRecordingRecordingkeysRotationscheduleWithHttpInfo(KeyRotationSchedule body) throws IOException Update key rotation schedule- Parameters:
body- KeyRotationSchedule (required)- Returns:
- KeyRotationSchedule
- Throws:
IOException- if the request fails to be processed
-
putRecordingRecordingkeysRotationschedule
public KeyRotationSchedule putRecordingRecordingkeysRotationschedule(PutRecordingRecordingkeysRotationscheduleRequest request) throws IOException, ApiException Update key rotation schedule- Parameters:
request- The request object- Returns:
- KeyRotationSchedule
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRecordingRecordingkeysRotationschedule
public ApiResponse<KeyRotationSchedule> putRecordingRecordingkeysRotationschedule(ApiRequest<KeyRotationSchedule> request) throws IOException Update key rotation schedule- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putRecordingSettings
public RecordingSettings putRecordingSettings(RecordingSettings body) throws IOException, ApiException Update the Recording Settings for the Organization- Parameters:
body- Recording settings (required)- Returns:
- RecordingSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRecordingSettingsWithHttpInfo
public ApiResponse<RecordingSettings> putRecordingSettingsWithHttpInfo(RecordingSettings body) throws IOException Update the Recording Settings for the Organization- Parameters:
body- Recording settings (required)- Returns:
- RecordingSettings
- Throws:
IOException- if the request fails to be processed
-
putRecordingSettings
public RecordingSettings putRecordingSettings(PutRecordingSettingsRequest request) throws IOException, ApiException Update the Recording Settings for the Organization- Parameters:
request- The request object- Returns:
- RecordingSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRecordingSettings
public ApiResponse<RecordingSettings> putRecordingSettings(ApiRequest<RecordingSettings> request) throws IOException Update the Recording Settings for the Organization- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putRecordingsDeletionprotection
public void putRecordingsDeletionprotection(Boolean protect, ConversationDeletionProtectionQuery body) throws IOException, ApiException Apply or revoke recording protection for conversations- Parameters:
protect- Check for apply, uncheck for revoke (each action requires the respective permission) (optional, default to true)body- (optional)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRecordingsDeletionprotectionWithHttpInfo
public ApiResponse<Void> putRecordingsDeletionprotectionWithHttpInfo(Boolean protect, ConversationDeletionProtectionQuery body) throws IOException Apply or revoke recording protection for conversations- Parameters:
protect- Check for apply, uncheck for revoke (each action requires the respective permission) (optional, default to true)body- (optional)- Throws:
IOException- if the request fails to be processed
-
putRecordingsDeletionprotection
public void putRecordingsDeletionprotection(PutRecordingsDeletionprotectionRequest request) throws IOException, ApiException Apply or revoke recording protection for conversations- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRecordingsDeletionprotection
public ApiResponse<Void> putRecordingsDeletionprotection(ApiRequest<ConversationDeletionProtectionQuery> request) throws IOException Apply or revoke recording protection for conversations- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-