{ "opencollection": "1.0.0", "info": { "name": "PureCloud Platform Agent Assistants Recording API", "version": "v2" }, "items": [ { "info": { "name": "Recording", "type": "folder" }, "items": [ { "info": { "name": "Gets media retention policy list with query options to filter on name and enabled.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/recording/crossplatform/mediaretentionpolicies", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The total page size requested" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number requested" }, { "name": "sortBy", "value": "", "type": "query", "description": "variable name requested to sort by" }, { "name": "expand", "value": "", "type": "query", "description": "variable name requested by expand list" }, { "name": "nextPage", "value": "", "type": "query", "description": "next page token" }, { "name": "previousPage", "value": "", "type": "query", "description": "Previous page token" }, { "name": "name", "value": "", "type": "query", "description": "the policy name - used for filtering results in searches." }, { "name": "enabled", "value": "", "type": "query", "description": "checks to see if policy is enabled - use enabled = true or enabled = false" }, { "name": "summary", "value": "", "type": "query", "description": "provides a less verbose response of policy lists." }, { "name": "hasErrors", "value": "", "type": "query", "description": "provides a way to fetch all policies with errors or policies that do not have errors" }, { "name": "deleteDaysThreshold", "value": "", "type": "query", "description": "provides a way to fetch all policies with any actions having deleteDays exceeding the provided value" } ] }, "docs": "for a less verbose response, add summary=true to this endpoint" }, { "info": { "name": "Create media retention policy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/recording/crossplatform/mediaretentionpolicies" }, "docs": "Policy does not work retroactively" }, { "info": { "name": "Delete media retention policies", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/recording/crossplatform/mediaretentionpolicies", "params": [ { "name": "ids", "value": "", "type": "query" } ] }, "docs": "Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param." }, { "info": { "name": "Get a media retention policy", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/recording/crossplatform/mediaretentionpolicies/:policyId", "params": [ { "name": "policyId", "value": "", "type": "path", "description": "Policy ID" } ] }, "docs": "Get a media retention policy" }, { "info": { "name": "Update a media retention policy", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/recording/crossplatform/mediaretentionpolicies/:policyId", "params": [ { "name": "policyId", "value": "", "type": "path", "description": "Policy ID" } ] }, "docs": "Policy does not work retroactively" }, { "info": { "name": "Patch a media retention policy", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/recording/crossplatform/mediaretentionpolicies/:policyId", "params": [ { "name": "policyId", "value": "", "type": "path", "description": "Policy ID" } ] }, "docs": "Patch a media retention policy" }, { "info": { "name": "Delete a media retention policy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/recording/crossplatform/mediaretentionpolicies/:policyId", "params": [ { "name": "policyId", "value": "", "type": "path", "description": "Policy ID" } ] }, "docs": "Delete a media retention policy" }, { "info": { "name": "Gets media retention policy list with query options to filter on name and enabled.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/recording/mediaretentionpolicies", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The total page size requested" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number requested" }, { "name": "sortBy", "value": "", "type": "query", "description": "variable name requested to sort by" }, { "name": "expand", "value": "", "type": "query", "description": "variable name requested by expand list" }, { "name": "nextPage", "value": "", "type": "query", "description": "next page token" }, { "name": "previousPage", "value": "", "type": "query", "description": "Previous page token" }, { "name": "name", "value": "", "type": "query", "description": "the policy name - used for filtering results in searches." }, { "name": "enabled", "value": "", "type": "query", "description": "checks to see if policy is enabled - use enabled = true or enabled = false" }, { "name": "summary", "value": "", "type": "query", "description": "provides a less verbose response of policy lists." }, { "name": "hasErrors", "value": "", "type": "query", "description": "provides a way to fetch all policies with errors or policies that do not have errors" }, { "name": "deleteDaysThreshold", "value": "", "type": "query", "description": "provides a way to fetch all policies with any actions having deleteDays exceeding the provided value" } ] }, "docs": "for a less verbose response, add summary=true to this endpoint" }, { "info": { "name": "Create media retention policy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/recording/mediaretentionpolicies" }, "docs": "Policy does not work retroactively" }, { "info": { "name": "Delete media retention policies", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/recording/mediaretentionpolicies", "params": [ { "name": "ids", "value": "", "type": "query" } ] }, "docs": "Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param." }, { "info": { "name": "Get a media retention policy", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/recording/mediaretentionpolicies/:policyId", "params": [ { "name": "policyId", "value": "", "type": "path", "description": "Policy ID" } ] }, "docs": "Get a media retention policy" }, { "info": { "name": "Update a media retention policy", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/recording/mediaretentionpolicies/:policyId", "params": [ { "name": "policyId", "value": "", "type": "path", "description": "Policy ID" } ] }, "docs": "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\":\"\"}]." }, { "info": { "name": "Patch a media retention policy", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/recording/mediaretentionpolicies/:policyId", "params": [ { "name": "policyId", "value": "", "type": "path", "description": "Policy ID" } ] }, "docs": "Patch a media retention policy" }, { "info": { "name": "Delete a media retention policy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/recording/mediaretentionpolicies/:policyId", "params": [ { "name": "policyId", "value": "", "type": "path", "description": "Policy ID" } ] }, "docs": "Delete a media retention policy" }, { "info": { "name": "Get encryption key list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/recording/recordingkeys", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "Get encryption key list" }, { "info": { "name": "Create encryption key", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/recording/recordingkeys" }, "docs": "Create encryption key" }, { "info": { "name": "Get key rotation schedule", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/recording/recordingkeys/rotationschedule" }, "docs": "Get key rotation schedule" }, { "info": { "name": "Update key rotation schedule", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/recording/recordingkeys/rotationschedule" }, "docs": "Update key rotation schedule" }, { "info": { "name": "create a local key management recording key", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/recording/localkeys" }, "docs": "create a local key management recording key" }, { "info": { "name": "Get the encryption key configurations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/recording/keyconfigurations/:keyConfigurationId", "params": [ { "name": "keyConfigurationId", "value": "", "type": "path", "description": "Key Configurations Id" } ] }, "docs": "Get the encryption key configurations" }, { "info": { "name": "Update the encryption key configurations", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/recording/keyconfigurations/:keyConfigurationId", "params": [ { "name": "keyConfigurationId", "value": "", "type": "path", "description": "Key Configurations Id" } ] }, "docs": "Update the encryption key configurations" }, { "info": { "name": "Get a list of key configurations data", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/recording/keyconfigurations" }, "docs": "Get a list of key configurations data" }, { "info": { "name": "Setup configurations for encryption key creation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/recording/keyconfigurations" }, "docs": "Setup configurations for encryption key creation" }, { "info": { "name": "Validate encryption key configurations without saving it", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/recording/keyconfigurations/validate" }, "docs": "Validate encryption key configurations without saving it" }, { "info": { "name": "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.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/recording/batchrequests/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "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." }, { "info": { "name": "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.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/recording/batchrequests" }, "docs": "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." }, { "info": { "name": "Get a list of conversations with protected recordings", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/recordings/deletionprotection" }, "docs": "Get a list of conversations with protected recordings" }, { "info": { "name": "Apply or revoke recording protection for conversations", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/recordings/deletionprotection", "params": [ { "name": "protect", "value": "", "type": "query", "description": "Check for apply, uncheck for revoke (each action requires the respective permission)" } ] }, "docs": "Apply or revoke recording protection for conversations" }, { "info": { "name": "Gets the media of a single orphan recording", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/orphanrecordings/:orphanId/media", "params": [ { "name": "orphanId", "value": "", "type": "path", "description": "Orphan ID" }, { "name": "formatId", "value": "", "type": "query", "description": "The desired media format." }, { "name": "emailFormatId", "value": "", "type": "query", "description": "The desired media format when downloading an email recording." }, { "name": "chatFormatId", "value": "", "type": "query", "description": "The desired media format when downloading a chat recording." }, { "name": "messageFormatId", "value": "", "type": "query", "description": "The desired media format when downloading a message recording." }, { "name": "download", "value": "", "type": "query", "description": "requesting a download format of the recording" }, { "name": "fileName", "value": "", "type": "query", "description": "the name of the downloaded fileName" }, { "name": "locale", "value": "", "type": "query", "description": "The locale for the requested file when downloading, as an ISO 639-1 code" }, { "name": "mediaFormats", "value": "", "type": "query", "description": "All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3" } ] }, "docs": "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." }, { "info": { "name": "Gets a single orphan recording", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/orphanrecordings/:orphanId", "params": [ { "name": "orphanId", "value": "", "type": "path", "description": "Orphan ID" } ] }, "docs": "Gets a single orphan recording" }, { "info": { "name": "Updates an orphan recording to a regular recording with retention values", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/orphanrecordings/:orphanId", "params": [ { "name": "orphanId", "value": "", "type": "path", "description": "Orphan ID" } ] }, "docs": "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." }, { "info": { "name": "Deletes a single orphan recording", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/orphanrecordings/:orphanId", "params": [ { "name": "orphanId", "value": "", "type": "path", "description": "Orphan ID" } ] }, "docs": "Deletes a single orphan recording" }, { "info": { "name": "Gets all orphan recordings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/orphanrecordings", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The total page size requested" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number requested" }, { "name": "sortBy", "value": "", "type": "query", "description": "variable name requested to sort by" }, { "name": "expand", "value": "", "type": "query", "description": "variable name requested by expand list" }, { "name": "nextPage", "value": "", "type": "query", "description": "next page token" }, { "name": "previousPage", "value": "", "type": "query", "description": "Previous page token" }, { "name": "hasConversation", "value": "", "type": "query", "description": "Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization." }, { "name": "media", "value": "", "type": "query", "description": "Filter resulting orphans based on their media type" } ] }, "docs": "Gets all orphan recordings" }, { "info": { "name": "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.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/recordingmetadata/:recordingId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" }, { "name": "recordingId", "value": "", "type": "path", "description": "Recording ID" } ] }, "docs": "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." }, { "info": { "name": "Gets a specific recording.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/recordings/:recordingId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" }, { "name": "recordingId", "value": "", "type": "path", "description": "Recording ID" }, { "name": "formatId", "value": "", "type": "query", "description": "The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE" }, { "name": "emailFormatId", "value": "", "type": "query", "description": "The desired media format when downloading an email recording. Valid values:EML,NONE" }, { "name": "chatFormatId", "value": "", "type": "query", "description": "The desired media format when downloading a chat recording. Valid values:ZIP,NONE " }, { "name": "messageFormatId", "value": "", "type": "query", "description": "The desired media format when downloading a message recording. Valid values:ZIP,NONE" }, { "name": "download", "value": "", "type": "query", "description": "requesting a download format of the recording. Valid values:true,false" }, { "name": "fileName", "value": "", "type": "query", "description": "the name of the downloaded fileName" }, { "name": "locale", "value": "", "type": "query", "description": "The locale for the requested file when downloading or for redacting sensitive information in requested files, as an ISO 639-1 code" }, { "name": "mediaFormats", "value": "", "type": "query", "description": "All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3" } ] }, "docs": "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." }, { "info": { "name": "Updates the retention records on a recording.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/recordings/:recordingId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" }, { "name": "recordingId", "value": "", "type": "path", "description": "Recording ID" }, { "name": "clearExport", "value": "", "type": "query", "description": "Whether to clear the pending export for the recording" } ] }, "docs": "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." }, { "info": { "name": "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.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/recordingmetadata", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" } ] }, "docs": "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." }, { "info": { "name": "Get all of a Conversation's Recordings.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/recordings", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" }, { "name": "maxWaitMs", "value": "", "type": "query", "description": "The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value." }, { "name": "formatId", "value": "", "type": "query", "description": "The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE." }, { "name": "mediaFormats", "value": "", "type": "query", "description": "All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3." }, { "name": "locale", "value": "", "type": "query", "description": "The locale used for redacting sensitive information in requested files, as an ISO 639-1 code" }, { "name": "includePauseAnnotationsForScreenRecordings", "value": "", "type": "query", "description": "Include applicable Secure Pause annotations from all audio recordings to all screen recordings" } ] }, "docs": "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." }, { "info": { "name": "Query for recording retention data", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/recordings/retention/query", "params": [ { "name": "retentionThresholdDays", "value": "", "type": "query", "description": "Fetch retention data for recordings retained for more days than the provided value." }, { "name": "cursor", "value": "", "type": "query", "description": "Indicates where to resume query results (not required for first page)" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size. Maximum is 500." } ] }, "docs": "Query for recording retention data" }, { "info": { "name": "Get annotation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/recordings/:recordingId/annotations/:annotationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" }, { "name": "recordingId", "value": "", "type": "path", "description": "Recording ID" }, { "name": "annotationId", "value": "", "type": "path", "description": "Annotation ID" } ] }, "docs": "Get annotation" }, { "info": { "name": "Update annotation", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/recordings/:recordingId/annotations/:annotationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" }, { "name": "recordingId", "value": "", "type": "path", "description": "Recording ID" }, { "name": "annotationId", "value": "", "type": "path", "description": "Annotation ID" } ] }, "docs": "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." }, { "info": { "name": "Delete annotation", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/recordings/:recordingId/annotations/:annotationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" }, { "name": "recordingId", "value": "", "type": "path", "description": "Recording ID" }, { "name": "annotationId", "value": "", "type": "path", "description": "Annotation ID" } ] }, "docs": "Delete annotation" }, { "info": { "name": "Get annotations for recording", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/recordings/:recordingId/annotations", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" }, { "name": "recordingId", "value": "", "type": "path", "description": "Recording ID" } ] }, "docs": "Get annotations for recording" }, { "info": { "name": "Create annotation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/:conversationId/recordings/:recordingId/annotations", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" }, { "name": "recordingId", "value": "", "type": "path", "description": "Recording ID" } ] }, "docs": "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." }, { "info": { "name": "Get IDs of recordings that the bulk job failed for", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/recording/jobs/:jobId/failedrecordings", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size. Maximum is 100." }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "includeTotal", "value": "", "type": "query", "description": "If false, cursor will be used to locate the page instead of pageNumber. It is recommended to set it to false for improved performance." }, { "name": "cursor", "value": "", "type": "query", "description": "Indicates where to resume query results (not required for first page)" } ] }, "docs": "Get IDs of recordings that the bulk job failed for" }, { "info": { "name": "Get the status of the job associated with the job id.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/recording/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Get the status of the job associated with the job id." }, { "info": { "name": "Execute the recording bulk job.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/recording/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "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." }, { "info": { "name": "Delete the recording bulk job", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/recording/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Delete the recording bulk job" }, { "info": { "name": "Get the status of all jobs within the user's organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/recording/jobs", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "state", "value": "", "type": "query", "description": "Filter by state" }, { "name": "showOnlyMyJobs", "value": "", "type": "query", "description": "Show only my jobs" }, { "name": "jobType", "value": "", "type": "query", "description": "Job Type (Can be left empty for both)" }, { "name": "includeTotal", "value": "", "type": "query", "description": "If false, cursor will be used to locate the page instead of pageNumber. It is recommended to set it to false for improved performance." }, { "name": "cursor", "value": "", "type": "query", "description": "Indicates where to resume query results (not required for first page)" } ] }, "docs": "Get the status of all jobs within the user's organization" }, { "info": { "name": "Create a recording bulk job.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/recording/jobs" }, "docs": "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 d" }, { "info": { "name": "Get the Recording Settings for the Organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/recording/settings", "params": [ { "name": "createDefault", "value": "", "type": "query", "description": "If no settings are found, a new one is created with default values" } ] }, "docs": "Get the Recording Settings for the Organization" }, { "info": { "name": "Update the Recording Settings for the Organization", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/recording/settings" }, "docs": "Update the Recording Settings for the Organization" }, { "info": { "name": "Get the status of a recording upload status report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/recording/uploads/reports/:reportId", "params": [ { "name": "reportId", "value": "", "type": "path", "description": "reportId" } ] }, "docs": "Get the status of a recording upload status report" }, { "info": { "name": "Creates a recording upload status report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/recording/uploads/reports" }, "docs": "Creates a recording upload status report" }, { "info": { "name": "Retrieves an object containing the total number of concurrent active screen recordings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/recordings/screensessions/details" }, "docs": "Retrieves an object containing the total number of concurrent active screen recordings" }, { "info": { "name": "Acknowledge a screen recording.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/recordings/screensessions/acknowledge" }, "docs": "Acknowledge a screen recording." }, { "info": { "name": "Provide meta-data a screen recording.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/recordings/screensessions/metadata" }, "docs": "Provide meta-data a screen recording." } ] } ], "bundled": true }