Genesys

Genesys Recording API

Recordings, policies, annotations, orphans

GitHub OpenAPI

Operations 57

GET /api/v2/recording/crossplatform/mediaretentionpolicies Gets media retention policy list with query options to filter on name and… #
POST /api/v2/recording/crossplatform/mediaretentionpolicies Create media retention policy #
DELETE /api/v2/recording/crossplatform/mediaretentionpolicies Delete media retention policies #
GET /api/v2/recording/crossplatform/mediaretentionpolicies/{policyId} Get a media retention policy #
PUT /api/v2/recording/crossplatform/mediaretentionpolicies/{policyId} Update a media retention policy #
DELETE /api/v2/recording/crossplatform/mediaretentionpolicies/{policyId} Delete a media retention policy #
PATCH /api/v2/recording/crossplatform/mediaretentionpolicies/{policyId} Patch a media retention policy #
GET /api/v2/recording/mediaretentionpolicies Gets media retention policy list with query options to filter on name and… #
POST /api/v2/recording/mediaretentionpolicies Create media retention policy #
DELETE /api/v2/recording/mediaretentionpolicies Delete media retention policies #
GET /api/v2/recording/mediaretentionpolicies/{policyId} Get a media retention policy #
PUT /api/v2/recording/mediaretentionpolicies/{policyId} Update a media retention policy #
DELETE /api/v2/recording/mediaretentionpolicies/{policyId} Delete a media retention policy #
PATCH /api/v2/recording/mediaretentionpolicies/{policyId} Patch a media retention policy #
GET /api/v2/recording/recordingkeys Get encryption key list #
POST /api/v2/recording/recordingkeys Create encryption key #
GET /api/v2/recording/recordingkeys/rotationschedule Get key rotation schedule #
PUT /api/v2/recording/recordingkeys/rotationschedule Update key rotation schedule #
POST /api/v2/recording/localkeys create a local key management recording key #
GET /api/v2/recording/keyconfigurations/{keyConfigurationId} Get the encryption key configurations #
PUT /api/v2/recording/keyconfigurations/{keyConfigurationId} Update the encryption key configurations #
GET /api/v2/recording/keyconfigurations Get a list of key configurations data #
POST /api/v2/recording/keyconfigurations Setup configurations for encryption key creation #
POST /api/v2/recording/keyconfigurations/validate Validate encryption key configurations without saving it #
GET /api/v2/recording/batchrequests/{jobId} Get the status and results for a batch request job, only the user that… #
POST /api/v2/recording/batchrequests Submit a batch download request for recordings. #
POST /api/v2/recordings/deletionprotection Get a list of conversations with protected recordings #
PUT /api/v2/recordings/deletionprotection Apply or revoke recording protection for conversations #
GET /api/v2/orphanrecordings/{orphanId}/media Gets the media of a single orphan recording #
GET /api/v2/orphanrecordings/{orphanId} Gets a single orphan recording #
PUT /api/v2/orphanrecordings/{orphanId} Updates an orphan recording to a regular recording with retention values #
DELETE /api/v2/orphanrecordings/{orphanId} Deletes a single orphan recording #
GET /api/v2/orphanrecordings Gets all orphan recordings #
GET /api/v2/conversations/{conversationId}/recordingmetadata/{recordingId} Get metadata for a specific recording. #
GET /api/v2/conversations/{conversationId}/recordings/{recordingId} Gets a specific recording #
PUT /api/v2/conversations/{conversationId}/recordings/{recordingId} Updates the retention records on a recording #
GET /api/v2/conversations/{conversationId}/recordingmetadata Get recording metadata for a conversation. #
GET /api/v2/conversations/{conversationId}/recordings Get all of a Conversation's Recordings #
GET /api/v2/recordings/retention/query Query for recording retention data #
GET /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId} Get annotation #
PUT /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId} Update annotation #
DELETE /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId} Delete annotation #
GET /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations Get annotations for recording #
POST /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations Create annotation #
GET /api/v2/recording/jobs/{jobId}/failedrecordings Get IDs of recordings that the bulk job failed for #
GET /api/v2/recording/jobs/{jobId} Get the status of the job associated with the job id #
PUT /api/v2/recording/jobs/{jobId} Execute the recording bulk job #
DELETE /api/v2/recording/jobs/{jobId} Delete the recording bulk job #
GET /api/v2/recording/jobs Get the status of all jobs within the user's organization #
POST /api/v2/recording/jobs Create a recording bulk job #
GET /api/v2/recording/settings Get the Recording Settings for the Organization #
PUT /api/v2/recording/settings Update the Recording Settings for the Organization #
GET /api/v2/recording/uploads/reports/{reportId} Get the status of a recording upload status report #
POST /api/v2/recording/uploads/reports Creates a recording upload status report #
GET /api/v2/recordings/screensessions/details Retrieves an object containing the total number of concurrent active screen… #
POST /api/v2/recordings/screensessions/acknowledge Acknowledge a screen recording #
POST /api/v2/recordings/screensessions/metadata Provide meta-data a screen recording #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/authentication/genesys-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-recording-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/scopes/genesys-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/conventions/genesys-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/errors/genesys-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/data-model/genesys-data-model.yml
🔗
AgenticAccess
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/agentic-access/genesys-agentic-access.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/genesys:genesys-recording-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

genesys-recording-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
  version: v2
  title: PureCloud Platform Recording API
  termsOfService: https://help.genesys.cloud/articles/terms-and-conditions/
  contact:
    name: PureCloud Developer Evangelists
    url: https://developer.genesys.cloud/
    email: DeveloperEvangelists@genesys.com
  license:
    name: UNLICENSED
    url: https://help.genesys.cloud/articles/terms-and-conditions/
servers:
- url: https://api.mypurecloud.com
tags:


# --- truncated at 32 KB (674 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-recording-api-openapi.yml