Class RecordingApiAsync

java.lang.Object
com.mypurecloud.sdk.v2.api.RecordingApiAsync

public class RecordingApiAsync extends Object
  • Constructor Details

    • RecordingApiAsync

      public RecordingApiAsync()
    • RecordingApiAsync

      public RecordingApiAsync(ApiClient apiClient)
  • Method Details

    • deleteConversationRecordingAnnotationAsync

      public Future<Void> deleteConversationRecordingAnnotationAsync(DeleteConversationRecordingAnnotationRequest request, AsyncApiCallback<Void> callback)
      Delete annotation
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • deleteConversationRecordingAnnotationAsync

      public Future<ApiResponse<Void>> deleteConversationRecordingAnnotationAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback)
      Delete annotation
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • deleteOrphanrecordingAsync

      public Future<OrphanRecording> deleteOrphanrecordingAsync(DeleteOrphanrecordingRequest request, AsyncApiCallback<OrphanRecording> callback)
      Deletes a single orphan recording
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • deleteOrphanrecordingAsync

      public Future<ApiResponse<OrphanRecording>> deleteOrphanrecordingAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<OrphanRecording>> callback)
      Deletes a single orphan recording
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • deleteRecordingCrossplatformMediaretentionpoliciesAsync

      public Future<Void> deleteRecordingCrossplatformMediaretentionpoliciesAsync(DeleteRecordingCrossplatformMediaretentionpoliciesRequest request, AsyncApiCallback<Void> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • deleteRecordingCrossplatformMediaretentionpoliciesAsync

      public Future<ApiResponse<Void>> deleteRecordingCrossplatformMediaretentionpoliciesAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • deleteRecordingCrossplatformMediaretentionpolicyAsync

      public Future<Void> deleteRecordingCrossplatformMediaretentionpolicyAsync(DeleteRecordingCrossplatformMediaretentionpolicyRequest request, AsyncApiCallback<Void> callback)
      Delete a media retention policy
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • deleteRecordingCrossplatformMediaretentionpolicyAsync

      public Future<ApiResponse<Void>> deleteRecordingCrossplatformMediaretentionpolicyAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback)
      Delete a media retention policy
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • deleteRecordingJobAsync

      public Future<Void> deleteRecordingJobAsync(DeleteRecordingJobRequest request, AsyncApiCallback<Void> callback)
      Delete the recording bulk job
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • deleteRecordingJobAsync

      public Future<ApiResponse<Void>> deleteRecordingJobAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback)
      Delete the recording bulk job
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • deleteRecordingMediaretentionpoliciesAsync

      public Future<Void> deleteRecordingMediaretentionpoliciesAsync(DeleteRecordingMediaretentionpoliciesRequest request, AsyncApiCallback<Void> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • deleteRecordingMediaretentionpoliciesAsync

      public Future<ApiResponse<Void>> deleteRecordingMediaretentionpoliciesAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • deleteRecordingMediaretentionpolicyAsync

      public Future<Void> deleteRecordingMediaretentionpolicyAsync(DeleteRecordingMediaretentionpolicyRequest request, AsyncApiCallback<Void> callback)
      Delete a media retention policy
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • deleteRecordingMediaretentionpolicyAsync

      public Future<ApiResponse<Void>> deleteRecordingMediaretentionpolicyAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback)
      Delete a media retention policy
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getConversationRecordingAsync

      public Future<Recording> getConversationRecordingAsync(GetConversationRecordingRequest request, AsyncApiCallback<Recording> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getConversationRecordingAsync

      public Future<ApiResponse<Recording>> getConversationRecordingAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Recording>> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getConversationRecordingAnnotationAsync

      public Future<Annotation> getConversationRecordingAnnotationAsync(GetConversationRecordingAnnotationRequest request, AsyncApiCallback<Annotation> callback)
      Get annotation
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getConversationRecordingAnnotationAsync

      public Future<ApiResponse<Annotation>> getConversationRecordingAnnotationAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Annotation>> callback)
      Get annotation
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getConversationRecordingAnnotationsAsync

      public Future<List<Annotation>> getConversationRecordingAnnotationsAsync(GetConversationRecordingAnnotationsRequest request, AsyncApiCallback<List<Annotation>> callback)
      Get annotations for recording
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getConversationRecordingAnnotationsAsync

      public Future<ApiResponse<List<Annotation>>> getConversationRecordingAnnotationsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<List<Annotation>>> callback)
      Get annotations for recording
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getConversationRecordingmetadataAsync

      public Future<List<RecordingMetadata>> getConversationRecordingmetadataAsync(GetConversationRecordingmetadataRequest request, AsyncApiCallback<List<RecordingMetadata>> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getConversationRecordingmetadataAsync

      public Future<ApiResponse<List<RecordingMetadata>>> getConversationRecordingmetadataAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<List<RecordingMetadata>>> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getConversationRecordingmetadataRecordingIdAsync

      public Future<RecordingMetadata> getConversationRecordingmetadataRecordingIdAsync(GetConversationRecordingmetadataRecordingIdRequest request, AsyncApiCallback<RecordingMetadata> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getConversationRecordingmetadataRecordingIdAsync

      public Future<ApiResponse<RecordingMetadata>> getConversationRecordingmetadataRecordingIdAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<RecordingMetadata>> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getConversationRecordingsAsync

      public Future<List<Recording>> getConversationRecordingsAsync(GetConversationRecordingsRequest request, AsyncApiCallback<List<Recording>> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getConversationRecordingsAsync

      public Future<ApiResponse<List<Recording>>> getConversationRecordingsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<List<Recording>>> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getOrphanrecordingAsync

      public Future<OrphanRecording> getOrphanrecordingAsync(GetOrphanrecordingRequest request, AsyncApiCallback<OrphanRecording> callback)
      Gets a single orphan recording
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getOrphanrecordingAsync

      public Future<ApiResponse<OrphanRecording>> getOrphanrecordingAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<OrphanRecording>> callback)
      Gets a single orphan recording
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getOrphanrecordingMediaAsync

      public Future<Recording> getOrphanrecordingMediaAsync(GetOrphanrecordingMediaRequest request, AsyncApiCallback<Recording> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getOrphanrecordingMediaAsync

      public Future<ApiResponse<Recording>> getOrphanrecordingMediaAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Recording>> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getOrphanrecordingsAsync

      Gets all orphan recordings
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getOrphanrecordingsAsync

      Gets all orphan recordings
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingBatchrequestAsync

      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingBatchrequestAsync

      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingCrossplatformMediaretentionpoliciesAsync

      public Future<PolicyEntityListing> getRecordingCrossplatformMediaretentionpoliciesAsync(GetRecordingCrossplatformMediaretentionpoliciesRequest request, AsyncApiCallback<PolicyEntityListing> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingCrossplatformMediaretentionpoliciesAsync

      public Future<ApiResponse<PolicyEntityListing>> getRecordingCrossplatformMediaretentionpoliciesAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<PolicyEntityListing>> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingCrossplatformMediaretentionpolicyAsync

      public Future<CrossPlatformPolicy> getRecordingCrossplatformMediaretentionpolicyAsync(GetRecordingCrossplatformMediaretentionpolicyRequest request, AsyncApiCallback<CrossPlatformPolicy> callback)
      Get a media retention policy
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingCrossplatformMediaretentionpolicyAsync

      public Future<ApiResponse<CrossPlatformPolicy>> getRecordingCrossplatformMediaretentionpolicyAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<CrossPlatformPolicy>> callback)
      Get a media retention policy
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingJobAsync

      public Future<RecordingJob> getRecordingJobAsync(GetRecordingJobRequest request, AsyncApiCallback<RecordingJob> callback)
      Get the status of the job associated with the job id.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingJobAsync

      public Future<ApiResponse<RecordingJob>> getRecordingJobAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<RecordingJob>> callback)
      Get the status of the job associated with the job id.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingJobFailedrecordingsAsync

      Get IDs of recordings that the bulk job failed for
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingJobFailedrecordingsAsync

      public Future<ApiResponse<FailedRecordingEntityListing>> getRecordingJobFailedrecordingsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<FailedRecordingEntityListing>> callback)
      Get IDs of recordings that the bulk job failed for
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingJobsAsync

      Get the status of all jobs within the user's organization
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingJobsAsync

      Get the status of all jobs within the user's organization
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingKeyconfigurationAsync

      Get the encryption key configurations
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingKeyconfigurationAsync

      Get the encryption key configurations
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingKeyconfigurationsAsync

      Get a list of key configurations data
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingKeyconfigurationsAsync

      Get a list of key configurations data
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingMediaretentionpoliciesAsync

      public Future<PolicyEntityListing> getRecordingMediaretentionpoliciesAsync(GetRecordingMediaretentionpoliciesRequest request, AsyncApiCallback<PolicyEntityListing> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingMediaretentionpoliciesAsync

      public Future<ApiResponse<PolicyEntityListing>> getRecordingMediaretentionpoliciesAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<PolicyEntityListing>> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingMediaretentionpolicyAsync

      public Future<Policy> getRecordingMediaretentionpolicyAsync(GetRecordingMediaretentionpolicyRequest request, AsyncApiCallback<Policy> callback)
      Get a media retention policy
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingMediaretentionpolicyAsync

      public Future<ApiResponse<Policy>> getRecordingMediaretentionpolicyAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Policy>> callback)
      Get a media retention policy
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingRecordingkeysAsync

      Get encryption key list
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingRecordingkeysAsync

      Get encryption key list
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingRecordingkeysRotationscheduleAsync

      public Future<KeyRotationSchedule> getRecordingRecordingkeysRotationscheduleAsync(GetRecordingRecordingkeysRotationscheduleRequest request, AsyncApiCallback<KeyRotationSchedule> callback)
      Get key rotation schedule
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingRecordingkeysRotationscheduleAsync

      public Future<ApiResponse<KeyRotationSchedule>> getRecordingRecordingkeysRotationscheduleAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<KeyRotationSchedule>> callback)
      Get key rotation schedule
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingSettingsAsync

      public Future<RecordingSettings> getRecordingSettingsAsync(GetRecordingSettingsRequest request, AsyncApiCallback<RecordingSettings> callback)
      Get the Recording Settings for the Organization
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingSettingsAsync

      public Future<ApiResponse<RecordingSettings>> getRecordingSettingsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<RecordingSettings>> callback)
      Get the Recording Settings for the Organization
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingUploadsReportAsync

      public Future<RecordingUploadReport> getRecordingUploadsReportAsync(GetRecordingUploadsReportRequest request, AsyncApiCallback<RecordingUploadReport> callback)
      Get the status of a recording upload status report
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingUploadsReportAsync

      public Future<ApiResponse<RecordingUploadReport>> getRecordingUploadsReportAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<RecordingUploadReport>> callback)
      Get the status of a recording upload status report
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingsRetentionQueryAsync

      Query for recording retention data
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingsRetentionQueryAsync

      Query for recording retention data
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingsScreensessionsDetailsAsync

      Retrieves an object containing the total number of concurrent active screen recordings
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • getRecordingsScreensessionsDetailsAsync

      public Future<ApiResponse<ScreenRecordingActiveSessions>> getRecordingsScreensessionsDetailsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<ScreenRecordingActiveSessions>> callback)
      Retrieves an object containing the total number of concurrent active screen recordings
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • patchRecordingCrossplatformMediaretentionpolicyAsync

      public Future<CrossPlatformPolicy> patchRecordingCrossplatformMediaretentionpolicyAsync(PatchRecordingCrossplatformMediaretentionpolicyRequest request, AsyncApiCallback<CrossPlatformPolicy> callback)
      Patch a media retention policy
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • patchRecordingCrossplatformMediaretentionpolicyAsync

      public Future<ApiResponse<CrossPlatformPolicy>> patchRecordingCrossplatformMediaretentionpolicyAsync(ApiRequest<CrossPlatformPolicyUpdate> request, AsyncApiCallback<ApiResponse<CrossPlatformPolicy>> callback)
      Patch a media retention policy
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • patchRecordingMediaretentionpolicyAsync

      public Future<Policy> patchRecordingMediaretentionpolicyAsync(PatchRecordingMediaretentionpolicyRequest request, AsyncApiCallback<Policy> callback)
      Patch a media retention policy
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • patchRecordingMediaretentionpolicyAsync

      public Future<ApiResponse<Policy>> patchRecordingMediaretentionpolicyAsync(ApiRequest<PolicyUpdate> request, AsyncApiCallback<ApiResponse<Policy>> callback)
      Patch a media retention policy
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • postConversationRecordingAnnotationsAsync

      public Future<Annotation> postConversationRecordingAnnotationsAsync(PostConversationRecordingAnnotationsRequest request, AsyncApiCallback<Annotation> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • postConversationRecordingAnnotationsAsync

      public Future<ApiResponse<Annotation>> postConversationRecordingAnnotationsAsync(ApiRequest<Annotation> request, AsyncApiCallback<ApiResponse<Annotation>> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • postRecordingBatchrequestsAsync

      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • postRecordingBatchrequestsAsync

      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • postRecordingCrossplatformMediaretentionpoliciesAsync

      public Future<CrossPlatformPolicy> postRecordingCrossplatformMediaretentionpoliciesAsync(PostRecordingCrossplatformMediaretentionpoliciesRequest request, AsyncApiCallback<CrossPlatformPolicy> callback)
      Create media retention policy Policy does not work retroactively
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • postRecordingCrossplatformMediaretentionpoliciesAsync

      public Future<ApiResponse<CrossPlatformPolicy>> postRecordingCrossplatformMediaretentionpoliciesAsync(ApiRequest<CrossPlatformPolicyCreate> request, AsyncApiCallback<ApiResponse<CrossPlatformPolicy>> callback)
      Create media retention policy Policy does not work retroactively
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • postRecordingJobsAsync

      public Future<RecordingJob> postRecordingJobsAsync(PostRecordingJobsRequest request, AsyncApiCallback<RecordingJob> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • postRecordingJobsAsync

      public Future<ApiResponse<RecordingJob>> postRecordingJobsAsync(ApiRequest<RecordingJobsQuery> request, AsyncApiCallback<ApiResponse<RecordingJob>> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • postRecordingKeyconfigurationsAsync

      Setup configurations for encryption key creation
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • postRecordingKeyconfigurationsAsync

      Setup configurations for encryption key creation
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • postRecordingKeyconfigurationsValidateAsync

      Validate encryption key configurations without saving it
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • postRecordingKeyconfigurationsValidateAsync

      Validate encryption key configurations without saving it
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • postRecordingLocalkeysAsync

      public Future<EncryptionKey> postRecordingLocalkeysAsync(PostRecordingLocalkeysRequest request, AsyncApiCallback<EncryptionKey> callback)
      create a local key management recording key
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • postRecordingLocalkeysAsync

      public Future<ApiResponse<EncryptionKey>> postRecordingLocalkeysAsync(ApiRequest<LocalEncryptionKeyRequest> request, AsyncApiCallback<ApiResponse<EncryptionKey>> callback)
      create a local key management recording key
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • postRecordingMediaretentionpoliciesAsync

      public Future<Policy> postRecordingMediaretentionpoliciesAsync(PostRecordingMediaretentionpoliciesRequest request, AsyncApiCallback<Policy> callback)
      Create media retention policy Policy does not work retroactively
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • postRecordingMediaretentionpoliciesAsync

      public Future<ApiResponse<Policy>> postRecordingMediaretentionpoliciesAsync(ApiRequest<PolicyCreate> request, AsyncApiCallback<ApiResponse<Policy>> callback)
      Create media retention policy Policy does not work retroactively
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • postRecordingRecordingkeysAsync

      public Future<EncryptionKey> postRecordingRecordingkeysAsync(PostRecordingRecordingkeysRequest request, AsyncApiCallback<EncryptionKey> callback)
      Create encryption key
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • postRecordingRecordingkeysAsync

      public Future<ApiResponse<EncryptionKey>> postRecordingRecordingkeysAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<EncryptionKey>> callback)
      Create encryption key
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • postRecordingUploadsReportsAsync

      public Future<RecordingUploadReport> postRecordingUploadsReportsAsync(PostRecordingUploadsReportsRequest request, AsyncApiCallback<RecordingUploadReport> callback)
      Creates a recording upload status report
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • postRecordingUploadsReportsAsync

      Creates a recording upload status report
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • postRecordingsDeletionprotectionAsync

      public Future<List<AddressableEntityRef>> postRecordingsDeletionprotectionAsync(PostRecordingsDeletionprotectionRequest request, AsyncApiCallback<List<AddressableEntityRef>> callback)
      Get a list of conversations with protected recordings
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • postRecordingsDeletionprotectionAsync

      Get a list of conversations with protected recordings
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • postRecordingsScreensessionsAcknowledgeAsync

      public Future<Void> postRecordingsScreensessionsAcknowledgeAsync(PostRecordingsScreensessionsAcknowledgeRequest request, AsyncApiCallback<Void> callback)
      Acknowledge a screen recording.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • postRecordingsScreensessionsAcknowledgeAsync

      public Future<ApiResponse<Void>> postRecordingsScreensessionsAcknowledgeAsync(ApiRequest<AcknowledgeScreenRecordingRequest> request, AsyncApiCallback<ApiResponse<Void>> callback)
      Acknowledge a screen recording.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • postRecordingsScreensessionsMetadataAsync

      public Future<Void> postRecordingsScreensessionsMetadataAsync(PostRecordingsScreensessionsMetadataRequest request, AsyncApiCallback<Void> callback)
      Provide meta-data a screen recording.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • postRecordingsScreensessionsMetadataAsync

      public Future<ApiResponse<Void>> postRecordingsScreensessionsMetadataAsync(ApiRequest<ScreenRecordingMetaDataRequest> request, AsyncApiCallback<ApiResponse<Void>> callback)
      Provide meta-data a screen recording.
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • putConversationRecordingAsync

      public Future<Recording> putConversationRecordingAsync(PutConversationRecordingRequest request, AsyncApiCallback<Recording> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • putConversationRecordingAsync

      public Future<ApiResponse<Recording>> putConversationRecordingAsync(ApiRequest<Recording> request, AsyncApiCallback<ApiResponse<Recording>> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • putConversationRecordingAnnotationAsync

      public Future<Annotation> putConversationRecordingAnnotationAsync(PutConversationRecordingAnnotationRequest request, AsyncApiCallback<Annotation> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • putConversationRecordingAnnotationAsync

      public Future<ApiResponse<Annotation>> putConversationRecordingAnnotationAsync(ApiRequest<Annotation> request, AsyncApiCallback<ApiResponse<Annotation>> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • putOrphanrecordingAsync

      public Future<Recording> putOrphanrecordingAsync(PutOrphanrecordingRequest request, AsyncApiCallback<Recording> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • putOrphanrecordingAsync

      public Future<ApiResponse<Recording>> putOrphanrecordingAsync(ApiRequest<OrphanUpdateRequest> request, AsyncApiCallback<ApiResponse<Recording>> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • putRecordingCrossplatformMediaretentionpolicyAsync

      public Future<CrossPlatformPolicy> putRecordingCrossplatformMediaretentionpolicyAsync(PutRecordingCrossplatformMediaretentionpolicyRequest request, AsyncApiCallback<CrossPlatformPolicy> callback)
      Update a media retention policy Policy does not work retroactively
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • putRecordingCrossplatformMediaretentionpolicyAsync

      public Future<ApiResponse<CrossPlatformPolicy>> putRecordingCrossplatformMediaretentionpolicyAsync(ApiRequest<CrossPlatformPolicy> request, AsyncApiCallback<ApiResponse<CrossPlatformPolicy>> callback)
      Update a media retention policy Policy does not work retroactively
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • putRecordingJobAsync

      public Future<RecordingJob> putRecordingJobAsync(PutRecordingJobRequest request, AsyncApiCallback<RecordingJob> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • putRecordingJobAsync

      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • putRecordingKeyconfigurationAsync

      Update the encryption key configurations
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • putRecordingKeyconfigurationAsync

      Update the encryption key configurations
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • putRecordingMediaretentionpolicyAsync

      public Future<Policy> putRecordingMediaretentionpolicyAsync(PutRecordingMediaretentionpolicyRequest request, AsyncApiCallback<Policy> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • putRecordingMediaretentionpolicyAsync

      public Future<ApiResponse<Policy>> putRecordingMediaretentionpolicyAsync(ApiRequest<Policy> request, AsyncApiCallback<ApiResponse<Policy>> callback)
      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
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • putRecordingRecordingkeysRotationscheduleAsync

      public Future<KeyRotationSchedule> putRecordingRecordingkeysRotationscheduleAsync(PutRecordingRecordingkeysRotationscheduleRequest request, AsyncApiCallback<KeyRotationSchedule> callback)
      Update key rotation schedule
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • putRecordingRecordingkeysRotationscheduleAsync

      public Future<ApiResponse<KeyRotationSchedule>> putRecordingRecordingkeysRotationscheduleAsync(ApiRequest<KeyRotationSchedule> request, AsyncApiCallback<ApiResponse<KeyRotationSchedule>> callback)
      Update key rotation schedule
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • putRecordingSettingsAsync

      public Future<RecordingSettings> putRecordingSettingsAsync(PutRecordingSettingsRequest request, AsyncApiCallback<RecordingSettings> callback)
      Update the Recording Settings for the Organization
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • putRecordingSettingsAsync

      Update the Recording Settings for the Organization
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • putRecordingsDeletionprotectionAsync

      public Future<Void> putRecordingsDeletionprotectionAsync(PutRecordingsDeletionprotectionRequest request, AsyncApiCallback<Void> callback)
      Apply or revoke recording protection for conversations
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed
    • putRecordingsDeletionprotectionAsync

      public Future<ApiResponse<Void>> putRecordingsDeletionprotectionAsync(ApiRequest<ConversationDeletionProtectionQuery> request, AsyncApiCallback<ApiResponse<Void>> callback)
      Apply or revoke recording protection for conversations
      Parameters:
      request - the request object
      callback - the action to perform when the request is completed
      Returns:
      the future indication when the request has completed