genesys-recording - Pinkfish - AI Agents & Workflows for Getting Work Done

Server path: /genesys-recording | Type: Application | PCID required: Yes

Tools

Tool	Description
`genesys_recording_delete_conversation_recording_annotation`	Delete annotation
`genesys_recording_delete_crossplatform_mediaretentionpolicies`	Delete media retention policies
`genesys_recording_delete_crossplatform_mediaretentionpolicy`	Delete a media retention policy
`genesys_recording_delete_job`	Delete the recording bulk job
`genesys_recording_delete_mediaretentionpolicies`	Delete media retention policies
`genesys_recording_delete_mediaretentionpolicy`	Delete a media retention policy
`genesys_recording_delete_orphanrecording`	Deletes a single orphan recording
`genesys_recording_get_batchrequest`	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.
`genesys_recording_get_conversation_recording`	Gets a specific recording.
`genesys_recording_get_conversation_recording_annotation`	Get annotation
`genesys_recording_get_conversation_recording_annotations`	Get annotations for recording
`genesys_recording_get_conversation_recordingmetadata`	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.
`genesys_recording_get_conversation_recordingmetadata_recording_id`	Get metadata for a specific recording. Does not return playable media.
`genesys_recording_get_conversation_recordings`	Get all of a Conversation’s Recordings.
`genesys_recording_get_crossplatform_mediaretentionpolicies`	Gets media retention policy list with query options to filter on name and enabled.
`genesys_recording_get_crossplatform_mediaretentionpolicy`	Get a media retention policy
`genesys_recording_get_job`	Get the status of the job associated with the job id.
`genesys_recording_get_job_failedrecordings`	Get IDs of recordings that the bulk job failed for
`genesys_recording_get_jobs`	Get the status of all jobs within the user’s organization
`genesys_recording_get_mediaretentionpolicies`	Gets media retention policy list with query options to filter on name and enabled.
`genesys_recording_get_mediaretentionpolicy`	Get a media retention policy
`genesys_recording_get_orphanrecording`	Gets a single orphan recording
`genesys_recording_get_orphanrecording_media`	Gets the media of a single orphan recording
`genesys_recording_get_orphanrecordings`	Gets all orphan recordings
`genesys_recording_get_recordingkeys`	Get encryption key list
`genesys_recording_get_recordingkeys_rotationschedule`	Get key rotation schedule
`genesys_recording_get_recordings_retention_query`	Query for recording retention data
`genesys_recording_get_recordings_screensessions_details`	Retrieves an object containing the total number of concurrent active screen recordings
`genesys_recording_get_settings`	Get the Recording Settings for the Organization
`genesys_recording_get_uploads_report`	Get the status of a recording upload status report
`genesys_recording_patch_crossplatform_mediaretentionpolicy`	Patch a media retention policy
`genesys_recording_patch_mediaretentionpolicy`	Patch a media retention policy
`genesys_recording_post_batchrequests`	Submit a batch download request for recordings. Recordings in response will be in their original format/codec - configured in the Trunk configuration.
`genesys_recording_post_conversation_recording_annotations`	Create annotation
`genesys_recording_post_crossplatform_mediaretentionpolicies`	Create media retention policy
`genesys_recording_post_jobs`	Create a recording bulk job.
`genesys_recording_post_localkeys`	create a local key management recording key
`genesys_recording_post_mediaretentionpolicies`	Create media retention policy
`genesys_recording_post_recordingkeys`	Create encryption key
`genesys_recording_post_recordings_deletionprotection`	Get a list of conversations with protected recordings
`genesys_recording_post_recordings_screensessions_acknowledge`	Acknowledge a screen recording.
`genesys_recording_post_recordings_screensessions_metadata`	Provide meta-data a screen recording.
`genesys_recording_post_uploads_reports`	Creates a recording upload status report
`genesys_recording_put_conversation_recording`	Updates the retention records on a recording.
`genesys_recording_put_conversation_recording_annotation`	Update annotation
`genesys_recording_put_crossplatform_mediaretentionpolicy`	Update a media retention policy
`genesys_recording_put_job`	Execute the recording bulk job.
`genesys_recording_put_mediaretentionpolicy`	Update a media retention policy
`genesys_recording_put_orphanrecording`	Updates an orphan recording to a regular recording with retention values
`genesys_recording_put_recordingkeys_rotationschedule`	Update key rotation schedule
`genesys_recording_put_recordings_deletionprotection`	Apply or revoke recording protection for conversations
`genesys_recording_put_settings`	Update the Recording Settings for the Organization

genesys_recording_delete_conversation_recording_annotation

Delete annotation Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation ID
`recordingId`	string	Yes	—	Recording ID
`annotationId`	string	Yes	—	Annotation ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation ID"
    },
    "recordingId": {
      "type": "string",
      "description": "Recording ID"
    },
    "annotationId": {
      "type": "string",
      "description": "Annotation ID"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "recordingId",
    "annotationId"
  ]
}

genesys_recording_delete_crossplatform_mediaretentionpolicies

Delete media retention policies Parameters:

Parameter	Type	Required	Default	Description
`ids`	string	Yes	—	ids

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ids": {
      "type": "string",
      "description": "ids"
    }
  },
  "required": [
    "PCID",
    "ids"
  ]
}

genesys_recording_delete_crossplatform_mediaretentionpolicy

Delete a media retention policy Parameters:

Parameter	Type	Required	Default	Description
`policyId`	string	Yes	—	Policy ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "policyId": {
      "type": "string",
      "description": "Policy ID"
    }
  },
  "required": [
    "PCID",
    "policyId"
  ]
}

genesys_recording_delete_job

Delete the recording bulk job Parameters:

Parameter	Type	Required	Default	Description
`jobId`	string	Yes	—	jobId

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "jobId": {
      "type": "string",
      "description": "jobId"
    }
  },
  "required": [
    "PCID",
    "jobId"
  ]
}

genesys_recording_delete_mediaretentionpolicies

Delete media retention policies Parameters:

Parameter	Type	Required	Default	Description
`ids`	string	Yes	—	ids

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ids": {
      "type": "string",
      "description": "ids"
    }
  },
  "required": [
    "PCID",
    "ids"
  ]
}

genesys_recording_delete_mediaretentionpolicy

Delete a media retention policy Parameters:

Parameter	Type	Required	Default	Description
`policyId`	string	Yes	—	Policy ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "policyId": {
      "type": "string",
      "description": "Policy ID"
    }
  },
  "required": [
    "PCID",
    "policyId"
  ]
}

genesys_recording_delete_orphanrecording

Deletes a single orphan recording Parameters:

Parameter	Type	Required	Default	Description
`orphanId`	string	Yes	—	Orphan ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orphanId": {
      "type": "string",
      "description": "Orphan ID"
    }
  },
  "required": [
    "PCID",
    "orphanId"
  ]
}

genesys_recording_get_batchrequest

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:

Parameter	Type	Required	Default	Description
`jobId`	string	Yes	—	jobId

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "jobId": {
      "type": "string",
      "description": "jobId"
    }
  },
  "required": [
    "PCID",
    "jobId"
  ]
}

genesys_recording_get_conversation_recording

Gets a specific recording. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation ID
`recordingId`	string	Yes	—	Recording ID
`formatId`	string	No	—	The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE
`emailFormatId`	string	No	—	The desired media format when downloading an email recording. Valid values:EML,NONE
`chatFormatId`	string	No	—	The desired media format when downloading a chat recording. Valid values:ZIP,NONE
`messageFormatId`	string	No	—	The desired media format when downloading a message recording. Valid values:ZIP,NONE
`download`	boolean	No	—	requesting a download format of the recording. Valid values:true,false
`fileName`	string	No	—	the name of the downloaded fileName
`locale`	string	No	—	The locale for the requested file when downloading or for redacting sensitive information in requested files, as an ISO 639-1 code
`mediaFormats`	any[]	No	—	All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation ID"
    },
    "recordingId": {
      "type": "string",
      "description": "Recording ID"
    },
    "formatId": {
      "type": "string",
      "description": "The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE",
      "enum": [
        "WAV",
        "WEBM",
        "WAV_ULAW",
        "OGG_VORBIS",
        "OGG_OPUS",
        "MP3",
        "NONE"
      ]
    },
    "emailFormatId": {
      "type": "string",
      "description": "The desired media format when downloading an email recording. Valid values:EML,NONE",
      "enum": [
        "EML",
        "NONE"
      ]
    },
    "chatFormatId": {
      "type": "string",
      "description": "The desired media format when downloading a chat recording. Valid values:ZIP,NONE",
      "enum": [
        "ZIP",
        "NONE"
      ]
    },
    "messageFormatId": {
      "type": "string",
      "description": "The desired media format when downloading a message recording. Valid values:ZIP,NONE",
      "enum": [
        "ZIP",
        "NONE"
      ]
    },
    "download": {
      "type": "boolean",
      "description": "requesting a download format of the recording. Valid values:true,false",
      "enum": [
        "true",
        "false"
      ]
    },
    "fileName": {
      "type": "string",
      "description": "the name of the downloaded fileName"
    },
    "locale": {
      "type": "string",
      "description": "The locale for the requested file when downloading or for redacting sensitive information in requested files, as an ISO 639-1 code"
    },
    "mediaFormats": {
      "type": "array",
      "description": "All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "recordingId"
  ]
}

genesys_recording_get_conversation_recording_annotation

Get annotation Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation ID
`recordingId`	string	Yes	—	Recording ID
`annotationId`	string	Yes	—	Annotation ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation ID"
    },
    "recordingId": {
      "type": "string",
      "description": "Recording ID"
    },
    "annotationId": {
      "type": "string",
      "description": "Annotation ID"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "recordingId",
    "annotationId"
  ]
}

genesys_recording_get_conversation_recording_annotations

Get annotations for recording Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation ID
`recordingId`	string	Yes	—	Recording ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation ID"
    },
    "recordingId": {
      "type": "string",
      "description": "Recording ID"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "recordingId"
  ]
}

genesys_recording_get_conversation_recordingmetadata

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:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation ID"
    }
  },
  "required": [
    "PCID",
    "conversationId"
  ]
}

genesys_recording_get_conversation_recordingmetadata_recording_id

Get metadata for a specific recording. Does not return playable media. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation ID
`recordingId`	string	Yes	—	Recording ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation ID"
    },
    "recordingId": {
      "type": "string",
      "description": "Recording ID"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "recordingId"
  ]
}

genesys_recording_get_conversation_recordings

Get all of a Conversation’s Recordings. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation ID
`maxWaitMs`	integer	No	—	The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value.
`formatId`	string	No	—	The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE.
`mediaFormats`	any[]	No	—	All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3.
`locale`	string	No	—	The locale used for redacting sensitive information in requested files, as an ISO 639-1 code
`includePauseAnnotationsForScreenRecordings`	boolean	No	—	Include applicable Secure Pause annotations from all audio recordings to all screen recordings

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation ID"
    },
    "maxWaitMs": {
      "type": "integer",
      "description": "The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value."
    },
    "formatId": {
      "type": "string",
      "description": "The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE.",
      "enum": [
        "WAV",
        "WEBM",
        "WAV_ULAW",
        "OGG_VORBIS",
        "OGG_OPUS",
        "MP3",
        "NONE"
      ]
    },
    "mediaFormats": {
      "type": "array",
      "description": "All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3."
    },
    "locale": {
      "type": "string",
      "description": "The locale used for redacting sensitive information in requested files, as an ISO 639-1 code"
    },
    "includePauseAnnotationsForScreenRecordings": {
      "type": "boolean",
      "description": "Include applicable Secure Pause annotations from all audio recordings to all screen recordings"
    }
  },
  "required": [
    "PCID",
    "conversationId"
  ]
}

genesys_recording_get_crossplatform_mediaretentionpolicies

Gets media retention policy list with query options to filter on name and enabled. Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	The total page size requested
`pageNumber`	integer	No	—	The page number requested
`sortBy`	string	No	—	variable name requested to sort by
`expand`	any[]	No	—	variable name requested by expand list
`nextPage`	string	No	—	next page token
`previousPage`	string	No	—	Previous page token
`name`	string	No	—	the policy name - used for filtering results in searches.
`enabled`	boolean	No	—	checks to see if policy is enabled - use enabled = true or enabled = false
`summary`	boolean	No	—	provides a less verbose response of policy lists.
`hasErrors`	boolean	No	—	provides a way to fetch all policies with errors or policies that do not have errors
`deleteDaysThreshold`	integer	No	—	provides a way to fetch all policies with any actions having deleteDays exceeding the provided value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "The total page size requested"
    },
    "pageNumber": {
      "type": "integer",
      "description": "The page number requested"
    },
    "sortBy": {
      "type": "string",
      "description": "variable name requested to sort by"
    },
    "expand": {
      "type": "array",
      "description": "variable name requested by expand list"
    },
    "nextPage": {
      "type": "string",
      "description": "next page token"
    },
    "previousPage": {
      "type": "string",
      "description": "Previous page token"
    },
    "name": {
      "type": "string",
      "description": "the policy name - used for filtering results in searches."
    },
    "enabled": {
      "type": "boolean",
      "description": "checks to see if policy is enabled - use enabled = true or enabled = false"
    },
    "summary": {
      "type": "boolean",
      "description": "provides a less verbose response of policy lists."
    },
    "hasErrors": {
      "type": "boolean",
      "description": "provides a way to fetch all policies with errors or policies that do not have errors"
    },
    "deleteDaysThreshold": {
      "type": "integer",
      "description": "provides a way to fetch all policies with any actions having deleteDays exceeding the provided value"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_recording_get_crossplatform_mediaretentionpolicy

Get a media retention policy Parameters:

Parameter	Type	Required	Default	Description
`policyId`	string	Yes	—	Policy ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "policyId": {
      "type": "string",
      "description": "Policy ID"
    }
  },
  "required": [
    "PCID",
    "policyId"
  ]
}

genesys_recording_get_job

Get the status of the job associated with the job id. Parameters:

Parameter	Type	Required	Default	Description
`jobId`	string	Yes	—	jobId

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "jobId": {
      "type": "string",
      "description": "jobId"
    }
  },
  "required": [
    "PCID",
    "jobId"
  ]
}

genesys_recording_get_job_failedrecordings

Get IDs of recordings that the bulk job failed for Parameters:

Parameter	Type	Required	Default	Description
`jobId`	string	Yes	—	jobId
`pageSize`	integer	No	—	Page size. Maximum is 100.
`pageNumber`	integer	No	—	Page number
`includeTotal`	boolean	No	—	If false, cursor will be used to locate the page instead of pageNumber. It is recommended to set it to false for improved performance.
`cursor`	string	No	—	Indicates where to resume query results (not required for first page)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "jobId": {
      "type": "string",
      "description": "jobId"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size. Maximum is 100."
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "includeTotal": {
      "type": "boolean",
      "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."
    },
    "cursor": {
      "type": "string",
      "description": "Indicates where to resume query results (not required for first page)"
    }
  },
  "required": [
    "PCID",
    "jobId"
  ]
}

genesys_recording_get_jobs

Get the status of all jobs within the user’s organization Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	Page size
`pageNumber`	integer	No	—	Page number
`sortBy`	string	No	—	Sort by
`state`	string	No	—	Filter by state
`showOnlyMyJobs`	boolean	No	—	Show only my jobs
`jobType`	string	No	—	Job Type (Can be left empty for both)
`includeTotal`	boolean	No	—	If false, cursor will be used to locate the page instead of pageNumber. It is recommended to set it to false for improved performance.
`cursor`	string	No	—	Indicates where to resume query results (not required for first page)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size"
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "sortBy": {
      "type": "string",
      "description": "Sort by",
      "enum": [
        "userId",
        "dateCreated"
      ]
    },
    "state": {
      "type": "string",
      "description": "Filter by state",
      "enum": [
        "FULFILLED",
        "PENDING",
        "READY",
        "PROCESSING",
        "CANCELLED",
        "FAILED"
      ]
    },
    "showOnlyMyJobs": {
      "type": "boolean",
      "description": "Show only my jobs"
    },
    "jobType": {
      "type": "string",
      "description": "Job Type (Can be left empty for both)",
      "enum": [
        "ARCHIVE",
        "DELETE",
        "EXPORT"
      ]
    },
    "includeTotal": {
      "type": "boolean",
      "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."
    },
    "cursor": {
      "type": "string",
      "description": "Indicates where to resume query results (not required for first page)"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_recording_get_mediaretentionpolicies

Gets media retention policy list with query options to filter on name and enabled. Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	The total page size requested
`pageNumber`	integer	No	—	The page number requested
`sortBy`	string	No	—	variable name requested to sort by
`expand`	any[]	No	—	variable name requested by expand list
`nextPage`	string	No	—	next page token
`previousPage`	string	No	—	Previous page token
`name`	string	No	—	the policy name - used for filtering results in searches.
`enabled`	boolean	No	—	checks to see if policy is enabled - use enabled = true or enabled = false
`summary`	boolean	No	—	provides a less verbose response of policy lists.
`hasErrors`	boolean	No	—	provides a way to fetch all policies with errors or policies that do not have errors
`deleteDaysThreshold`	integer	No	—	provides a way to fetch all policies with any actions having deleteDays exceeding the provided value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "The total page size requested"
    },
    "pageNumber": {
      "type": "integer",
      "description": "The page number requested"
    },
    "sortBy": {
      "type": "string",
      "description": "variable name requested to sort by"
    },
    "expand": {
      "type": "array",
      "description": "variable name requested by expand list"
    },
    "nextPage": {
      "type": "string",
      "description": "next page token"
    },
    "previousPage": {
      "type": "string",
      "description": "Previous page token"
    },
    "name": {
      "type": "string",
      "description": "the policy name - used for filtering results in searches."
    },
    "enabled": {
      "type": "boolean",
      "description": "checks to see if policy is enabled - use enabled = true or enabled = false"
    },
    "summary": {
      "type": "boolean",
      "description": "provides a less verbose response of policy lists."
    },
    "hasErrors": {
      "type": "boolean",
      "description": "provides a way to fetch all policies with errors or policies that do not have errors"
    },
    "deleteDaysThreshold": {
      "type": "integer",
      "description": "provides a way to fetch all policies with any actions having deleteDays exceeding the provided value"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_recording_get_mediaretentionpolicy

Get a media retention policy Parameters:

Parameter	Type	Required	Default	Description
`policyId`	string	Yes	—	Policy ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "policyId": {
      "type": "string",
      "description": "Policy ID"
    }
  },
  "required": [
    "PCID",
    "policyId"
  ]
}

genesys_recording_get_orphanrecording

Gets a single orphan recording Parameters:

Parameter	Type	Required	Default	Description
`orphanId`	string	Yes	—	Orphan ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orphanId": {
      "type": "string",
      "description": "Orphan ID"
    }
  },
  "required": [
    "PCID",
    "orphanId"
  ]
}

genesys_recording_get_orphanrecording_media

Gets the media of a single orphan recording Parameters:

Parameter	Type	Required	Default	Description
`orphanId`	string	Yes	—	Orphan ID
`formatId`	string	No	—	The desired media format.
`emailFormatId`	string	No	—	The desired media format when downloading an email recording.
`chatFormatId`	string	No	—	The desired media format when downloading a chat recording.
`messageFormatId`	string	No	—	The desired media format when downloading a message recording.
`download`	boolean	No	—	requesting a download format of the recording
`fileName`	string	No	—	the name of the downloaded fileName
`locale`	string	No	—	The locale for the requested file when downloading, as an ISO 639-1 code
`mediaFormats`	any[]	No	—	All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orphanId": {
      "type": "string",
      "description": "Orphan ID"
    },
    "formatId": {
      "type": "string",
      "description": "The desired media format.",
      "enum": [
        "WAV",
        "WEBM",
        "WAV_ULAW",
        "OGG_VORBIS",
        "OGG_OPUS",
        "MP3",
        "NONE"
      ]
    },
    "emailFormatId": {
      "type": "string",
      "description": "The desired media format when downloading an email recording.",
      "enum": [
        "EML",
        "NONE"
      ]
    },
    "chatFormatId": {
      "type": "string",
      "description": "The desired media format when downloading a chat recording.",
      "enum": [
        "ZIP",
        "NONE"
      ]
    },
    "messageFormatId": {
      "type": "string",
      "description": "The desired media format when downloading a message recording.",
      "enum": [
        "ZIP",
        "NONE"
      ]
    },
    "download": {
      "type": "boolean",
      "description": "requesting a download format of the recording",
      "enum": [
        "true",
        "false"
      ]
    },
    "fileName": {
      "type": "string",
      "description": "the name of the downloaded fileName"
    },
    "locale": {
      "type": "string",
      "description": "The locale for the requested file when downloading, as an ISO 639-1 code"
    },
    "mediaFormats": {
      "type": "array",
      "description": "All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3"
    }
  },
  "required": [
    "PCID",
    "orphanId"
  ]
}

genesys_recording_get_orphanrecordings

Gets all orphan recordings Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	The total page size requested
`pageNumber`	integer	No	—	The page number requested
`sortBy`	string	No	—	variable name requested to sort by
`expand`	any[]	No	—	variable name requested by expand list
`nextPage`	string	No	—	next page token
`previousPage`	string	No	—	Previous page token
`hasConversation`	boolean	No	—	Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization.
`media`	string	No	—	Filter resulting orphans based on their media type

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "The total page size requested"
    },
    "pageNumber": {
      "type": "integer",
      "description": "The page number requested"
    },
    "sortBy": {
      "type": "string",
      "description": "variable name requested to sort by"
    },
    "expand": {
      "type": "array",
      "description": "variable name requested by expand list"
    },
    "nextPage": {
      "type": "string",
      "description": "next page token"
    },
    "previousPage": {
      "type": "string",
      "description": "Previous page token"
    },
    "hasConversation": {
      "type": "boolean",
      "description": "Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization."
    },
    "media": {
      "type": "string",
      "description": "Filter resulting orphans based on their media type",
      "enum": [
        "Call",
        "Screen"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_recording_get_recordingkeys

Get encryption key list Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	Page size
`pageNumber`	integer	No	—	Page number

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size"
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_recording_get_recordingkeys_rotationschedule

Get key rotation schedule

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_recording_get_recordings_retention_query

Query for recording retention data Parameters:

Parameter	Type	Required	Default	Description
`retentionThresholdDays`	integer	Yes	—	Fetch retention data for recordings retained for more days than the provided value.
`cursor`	string	No	—	Indicates where to resume query results (not required for first page)
`pageSize`	integer	No	—	Page size. Maximum is 500.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "retentionThresholdDays": {
      "type": "integer",
      "description": "Fetch retention data for recordings retained for more days than the provided value."
    },
    "cursor": {
      "type": "string",
      "description": "Indicates where to resume query results (not required for first page)"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size. Maximum is 500."
    }
  },
  "required": [
    "PCID",
    "retentionThresholdDays"
  ]
}

genesys_recording_get_recordings_screensessions_details

Retrieves an object containing the total number of concurrent active screen recordings

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_recording_get_settings

Get the Recording Settings for the Organization Parameters:

Parameter	Type	Required	Default	Description
`createDefault`	boolean	No	—	If no settings are found, a new one is created with default values

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "createDefault": {
      "type": "boolean",
      "description": "If no settings are found, a new one is created with default values"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_recording_get_uploads_report

Get the status of a recording upload status report Parameters:

Parameter	Type	Required	Default	Description
`reportId`	string	Yes	—	reportId

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "reportId": {
      "type": "string",
      "description": "reportId"
    }
  },
  "required": [
    "PCID",
    "reportId"
  ]
}

genesys_recording_patch_crossplatform_mediaretentionpolicy

Patch a media retention policy Parameters:

Parameter	Type	Required	Default	Description
`policyId`	string	Yes	—	Policy ID
`enabled`	boolean	No	—	enabled

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "policyId": {
      "type": "string",
      "description": "Policy ID"
    },
    "enabled": {
      "type": "boolean",
      "description": "enabled"
    }
  },
  "required": [
    "PCID",
    "policyId"
  ]
}

genesys_recording_patch_mediaretentionpolicy

Patch a media retention policy Parameters:

Parameter	Type	Required	Default	Description
`policyId`	string	Yes	—	Policy ID
`enabled`	boolean	No	—	enabled

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "policyId": {
      "type": "string",
      "description": "Policy ID"
    },
    "enabled": {
      "type": "boolean",
      "description": "enabled"
    }
  },
  "required": [
    "PCID",
    "policyId"
  ]
}

genesys_recording_post_batchrequests

Submit a batch download request for recordings. Recordings in response will be in their original format/codec - configured in the Trunk configuration. Parameters:

Parameter	Type	Required	Default	Description
`batchDownloadRequestList`	any[]	Yes	—	List of up to 100 items requested

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "batchDownloadRequestList": {
      "type": "array",
      "description": "List of up to 100 items requested"
    }
  },
  "required": [
    "PCID",
    "batchDownloadRequestList"
  ]
}

genesys_recording_post_conversation_recording_annotations

Create annotation Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation ID
`recordingId`	string	Yes	—	Recording ID
`absoluteDurationMs`	integer	No	—	Duration of annotation (milliseconds).
`absoluteLocation`	integer	No	—	Offset of annotation (milliseconds) from start of recording (after removing the cumulative duration of all pauses).
`annotations`	any[]	No	—	List of annotations
`description`	string	No	—	Text of annotation. Maximum character limit is 500.
`durationMs`	integer	No	—	Duration of annotation in milliseconds.
`id`	string	No	—	Annotation id. All pause annotations on a recording will share an ID value, bookmark annotations will have unique IDs, and hold annotations will have randomly generated UUIDs (i.e. the ID will change at each request).
`location`	integer	No	—	Offset of annotation in milliseconds.
`name`	string	No	—	name
`realtimeLocation`	integer	No	—	Offset of annotation (milliseconds) from start of the recording before removing the cumulative duration of all pauses before this annotation
`reason`	string	No	—	Reason for a pause annotation. Valid values: Hold,SecurePause,FlowOrQueue,Pause
`recordingDurationMs`	integer	No	—	Duration of annotation (milliseconds), adjusted for any recording cuts.
`recordingLocation`	integer	No	—	Offset of annotation (milliseconds) from start of recording, adjusted for any recording cuts
`selfUri`	string	No	—	The URI for this object
`type`	string	No	—	type
`user`	object	No	—	user

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation ID"
    },
    "recordingId": {
      "type": "string",
      "description": "Recording ID"
    },
    "absoluteDurationMs": {
      "type": "integer",
      "description": "Duration of annotation (milliseconds)."
    },
    "absoluteLocation": {
      "type": "integer",
      "description": "Offset of annotation (milliseconds) from start of recording (after removing the cumulative duration of all pauses)."
    },
    "annotations": {
      "type": "array",
      "description": "List of annotations"
    },
    "description": {
      "type": "string",
      "description": "Text of annotation. Maximum character limit is 500."
    },
    "durationMs": {
      "type": "integer",
      "description": "Duration of annotation in milliseconds."
    },
    "id": {
      "type": "string",
      "description": "Annotation id. All pause annotations on a recording will share an ID value, bookmark annotations will have unique IDs, and hold annotations will have randomly generated UUIDs (i.e. the ID will change at each request)."
    },
    "location": {
      "type": "integer",
      "description": "Offset of annotation in milliseconds."
    },
    "name": {
      "type": "string",
      "description": "name"
    },
    "realtimeLocation": {
      "type": "integer",
      "description": "Offset of annotation (milliseconds) from start of the recording before removing the cumulative duration of all pauses before this annotation"
    },
    "reason": {
      "type": "string",
      "description": "Reason for a pause annotation. Valid values: Hold,SecurePause,FlowOrQueue,Pause",
      "enum": [
        "Hold",
        "SecurePause",
        "FlowOrQueue",
        "Pause"
      ]
    },
    "recordingDurationMs": {
      "type": "integer",
      "description": "Duration of annotation (milliseconds), adjusted for any recording cuts."
    },
    "recordingLocation": {
      "type": "integer",
      "description": "Offset of annotation (milliseconds) from start of recording, adjusted for any recording cuts"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "type": {
      "type": "string",
      "description": "type"
    },
    "user": {
      "type": "object",
      "description": "user"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "recordingId"
  ]
}

genesys_recording_post_crossplatform_mediaretentionpolicies

Create media retention policy Parameters:

Parameter	Type	Required	Default	Description
`actions`	object	No	—	actions
`conditions`	object	No	—	conditions
`createdDate`	string	No	—	Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`description`	string	No	—	description
`enabled`	boolean	No	—	enabled
`id`	string	No	—	The globally unique identifier for the object.
`mediaPolicies`	object	No	—	mediaPolicies
`modifiedDate`	string	No	—	Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`name`	string	Yes	—	The policy name.
`order`	integer	No	—	order
`policyErrors`	object	No	—	policyErrors
`selfUri`	string	No	—	The URI for this object

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "actions": {
      "type": "object",
      "description": "actions"
    },
    "conditions": {
      "type": "object",
      "description": "conditions"
    },
    "createdDate": {
      "type": "string",
      "description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "description": {
      "type": "string",
      "description": "description"
    },
    "enabled": {
      "type": "boolean",
      "description": "enabled"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "mediaPolicies": {
      "type": "object",
      "description": "mediaPolicies"
    },
    "modifiedDate": {
      "type": "string",
      "description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "name": {
      "type": "string",
      "description": "The policy name."
    },
    "order": {
      "type": "integer",
      "description": "order"
    },
    "policyErrors": {
      "type": "object",
      "description": "policyErrors"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    }
  },
  "required": [
    "PCID",
    "name"
  ]
}

genesys_recording_post_jobs

Create a recording bulk job. Parameters:

Parameter	Type	Required	Default	Description
`action`	string	Yes	—	Operation to perform bulk task. If the operation will cause the delete date of a recording to be older than the export date, the export date will be adjusted to the delete date.
`actionAge`	integer	No	—	The number of days after each recording’s creation date when the action will be performed. If screenRecordingActionAge is also provided, this value is only used for non-screen recordings. Otherwise this value is used for all recordings.
`actionDate`	string	No	—	The date when the action will be performed. If screenRecordingActionDate is also provided, this value is only used for non-screen recordings. Otherwise this value is used for all recordings. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`agedConversationInterval`	string	No	—	As an alternative to conversationQuery, specify the date and time range of conversations that are older than 5 years to query.Results will include all conversations that had activity during the interval. This is supported only when querying for conversations older than 5 years;conversationQuery must not be provided when this is provided. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss.Interval duration must not exceed 6 months. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`clearExport`	boolean	No	—	For DELETE action, setting this to true will clear any pending exports for recordings. This field is only used for DELETE action. Default value = false
`conversationQuery`	object	No	—	conversationQuery
`includeRecordingsWithSensitiveData`	boolean	No	—	Whether to include recordings with PCI DSS and/or PII data, default value = false
`includeScreenRecordings`	boolean	No	—	Whether to include Screen recordings for the action, default value = true
`integrationId`	string	No	—	IntegrationId to Access AWS S3 bucket for bulk recording exports. This field is required and used only for EXPORT action.
`screenRecordingActionAge`	integer	No	—	The number of days after each screen recording’s creation date when the action will be performed. If this is provided then includeScreenRecordings must be true.
`screenRecordingActionDate`	string	No	—	The date when the action will be performed for screen recordings. If this is provided then includeScreenRecordings must be true. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "action": {
      "type": "string",
      "description": "Operation to perform bulk task. If the operation will cause the delete date of a recording to be older than the export date, the export date will be adjusted to the delete date.",
      "enum": [
        "ARCHIVE",
        "DELETE",
        "EXPORT"
      ]
    },
    "actionAge": {
      "type": "integer",
      "description": "The number of days after each recording's creation date when the action will be performed. If screenRecordingActionAge is also provided, this value is only used for non-screen recordings. Otherwise this value is used for all recordings."
    },
    "actionDate": {
      "type": "string",
      "description": "The date when the action will be performed. If screenRecordingActionDate is also provided, this value is only used for non-screen recordings. Otherwise this value is used for all recordings. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "agedConversationInterval": {
      "type": "string",
      "description": "As an alternative to conversationQuery, specify the date and time range of conversations that are older than 5 years to query.Results will include all conversations that had activity during the interval. This is supported only when querying for conversations older than 5 years;conversationQuery must not be provided when this is provided. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss.Interval duration must not exceed 6 months. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "clearExport": {
      "type": "boolean",
      "description": "For DELETE action, setting this to true will clear any pending exports for recordings. This field is only used for DELETE action. Default value = false"
    },
    "conversationQuery": {
      "type": "object",
      "description": "conversationQuery"
    },
    "includeRecordingsWithSensitiveData": {
      "type": "boolean",
      "description": "Whether to include recordings with PCI DSS and/or PII data, default value = false"
    },
    "includeScreenRecordings": {
      "type": "boolean",
      "description": "Whether to include Screen recordings for the action, default value = true"
    },
    "integrationId": {
      "type": "string",
      "description": "IntegrationId to Access AWS S3 bucket for bulk recording exports. This field is required and used only for EXPORT action."
    },
    "screenRecordingActionAge": {
      "type": "integer",
      "description": "The number of days after each screen recording's creation date when the action will be performed. If this is provided then includeScreenRecordings must be true."
    },
    "screenRecordingActionDate": {
      "type": "string",
      "description": "The date when the action will be performed for screen recordings. If this is provided then includeScreenRecordings must be true. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    }
  },
  "required": [
    "PCID",
    "action"
  ]
}

genesys_recording_post_localkeys

create a local key management recording key Parameters:

Parameter	Type	Required	Default	Description
`configId`	string	Yes	—	The local configuration id that contains metadata on private local service
`keypairId`	string	Yes	—	The key pair id from the local service.
`publicKey`	string	Yes	—	Base 64 encoded public key, generated by the local service.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "configId": {
      "type": "string",
      "description": "The local configuration id that contains metadata on private local service"
    },
    "keypairId": {
      "type": "string",
      "description": "The key pair id from the local service."
    },
    "publicKey": {
      "type": "string",
      "description": "Base 64 encoded public key, generated by the local service."
    }
  },
  "required": [
    "PCID",
    "configId",
    "keypairId",
    "publicKey"
  ]
}

genesys_recording_post_mediaretentionpolicies

Create media retention policy Parameters:

Parameter	Type	Required	Default	Description
`actions`	object	No	—	actions
`conditions`	object	No	—	conditions
`createdDate`	string	No	—	Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`description`	string	No	—	description
`enabled`	boolean	No	—	enabled
`id`	string	No	—	The globally unique identifier for the object.
`mediaPolicies`	object	No	—	mediaPolicies
`modifiedDate`	string	No	—	Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`name`	string	Yes	—	The policy name.
`order`	integer	No	—	order
`policyErrors`	object	No	—	policyErrors
`selfUri`	string	No	—	The URI for this object

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "actions": {
      "type": "object",
      "description": "actions"
    },
    "conditions": {
      "type": "object",
      "description": "conditions"
    },
    "createdDate": {
      "type": "string",
      "description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "description": {
      "type": "string",
      "description": "description"
    },
    "enabled": {
      "type": "boolean",
      "description": "enabled"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "mediaPolicies": {
      "type": "object",
      "description": "mediaPolicies"
    },
    "modifiedDate": {
      "type": "string",
      "description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "name": {
      "type": "string",
      "description": "The policy name."
    },
    "order": {
      "type": "integer",
      "description": "order"
    },
    "policyErrors": {
      "type": "object",
      "description": "policyErrors"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    }
  },
  "required": [
    "PCID",
    "name"
  ]
}

genesys_recording_post_recordingkeys

Create encryption key

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_recording_post_recordings_deletionprotection

Get a list of conversations with protected recordings Parameters:

Parameter	Type	Required	Default	Description
`conversationIds`	any[]	Yes	—	This is a list of ConversationIds. The list cannot exceed 100 conversationids.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationIds": {
      "type": "array",
      "description": "This is a list of ConversationIds. The list cannot exceed 100 conversationids."
    }
  },
  "required": [
    "PCID",
    "conversationIds"
  ]
}

genesys_recording_post_recordings_screensessions_acknowledge

Acknowledge a screen recording. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	No	—	conversationId
`participantJid`	string	No	—	participantJid
`roomId`	string	No	—	roomId

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "conversationId"
    },
    "participantJid": {
      "type": "string",
      "description": "participantJid"
    },
    "roomId": {
      "type": "string",
      "description": "roomId"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_recording_post_recordings_screensessions_metadata

Provide meta-data a screen recording. Parameters:

Parameter	Type	Required	Default	Description
`metaData`	any[]	No	—	metaData
`participantJid`	string	No	—	participantJid
`roomId`	string	No	—	roomId

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "metaData": {
      "type": "array",
      "description": "metaData"
    },
    "participantJid": {
      "type": "string",
      "description": "participantJid"
    },
    "roomId": {
      "type": "string",
      "description": "roomId"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_recording_post_uploads_reports

Creates a recording upload status report Parameters:

Parameter	Type	Required	Default	Description
`dateSince`	string	Yes	—	Report will include uploads since this date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`uploadStatus`	string	No	—	Report will include uploads with this status

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dateSince": {
      "type": "string",
      "description": "Report will include uploads since this date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "uploadStatus": {
      "type": "string",
      "description": "Report will include uploads with this status",
      "enum": [
        "Pending",
        "Success",
        "Failure",
        "WaitForConversation"
      ]
    }
  },
  "required": [
    "PCID",
    "dateSince"
  ]
}

genesys_recording_put_conversation_recording

Updates the retention records on a recording. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation ID
`recordingId`	string	Yes	—	Recording ID
`clearExport`	boolean	No	—	Whether to clear the pending export for the recording
`actualTranscodeTimeMs`	integer	No	—	actualTranscodeTimeMs
`annotations`	any[]	No	—	Annotations that belong to the recording.
`archiveDate`	string	No	—	The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`archiveMedium`	string	No	—	The type of archive medium used. Example: CloudArchive
`creationTime`	string	No	—	The creation time of the recording. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`deleteDate`	string	No	—	The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`emailTranscript`	any[]	No	—	Represents an email transcript
`endTime`	string	No	—	The end time of the recording. Null when there is no playable media.
`estimatedTranscodeTimeMs`	integer	No	—	estimatedTranscodeTimeMs
`exportDate`	string	No	—	The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`exportedDate`	string	No	—	The date the recording was exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`fileState`	string	No	—	Represents the current file state for a recording. Examples: Uploading, Archived, etc
`id`	string	No	—	The globally unique identifier for the object.
`maxAllowedRestorationsForOrg`	integer	No	—	How many archive restorations the organization is allowed to have. Deprecated - Always returns 10000 since the restoration limit is no longer enforced.
`media`	string	No	—	The media type of the recording. This could be audio, chat, messaging, email, or screen.
`mediaSubject`	string	No	—	The media subject of the recording.
`mediaSubtype`	string	No	—	The media subtype of the recording.
`mediaUris`	object	No	—	The different mediaUris for the recording. Null when there is no playable media.
`messagingTranscript`	any[]	No	—	Represents a messaging transcript
`name`	string	No	—	name
`originalRecordingStartTime`	string	No	—	The start time of the full recording, before any segment access restrictions are applied. Null when there is no playable media. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`outputDurationMs`	integer	No	—	Duration of transcoded media in milliseconds
`outputSizeInBytes`	integer	No	—	Size of transcoded media in bytes. 0 if there is no transcoded media.
`path`	string	No	—	path
`recordingErrorStatus`	string	No	—	Status of a recording that cannot be returned because of an error
`recordingFileRole`	string	No	—	Role of the file recording. It can be either customer_experience or adhoc.
`remainingRestorationsAllowedForOrg`	integer	No	—	The remaining archive restorations the organization has. Deprecated - Always returns 10000 since the restoration limit is no longer enforced.
`restoreExpirationTime`	string	No	—	The amount of time a restored recording will remain restored before being archived again. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`selfUri`	string	No	—	The URI for this object
`sessionId`	string	No	—	The session id represents an external resource id, such as email, call, chat, etc
`startTime`	string	No	—	The start time of the recording. Null when there is no playable media.
`transcript`	any[]	No	—	Represents a chat transcript
`users`	any[]	No	—	The users participating in the conversation

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation ID"
    },
    "recordingId": {
      "type": "string",
      "description": "Recording ID"
    },
    "clearExport": {
      "type": "boolean",
      "description": "Whether to clear the pending export for the recording"
    },
    "actualTranscodeTimeMs": {
      "type": "integer",
      "description": "actualTranscodeTimeMs"
    },
    "annotations": {
      "type": "array",
      "description": "Annotations that belong to the recording."
    },
    "archiveDate": {
      "type": "string",
      "description": "The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "archiveMedium": {
      "type": "string",
      "description": "The type of archive medium used. Example: CloudArchive",
      "enum": [
        "CLOUDARCHIVE"
      ]
    },
    "creationTime": {
      "type": "string",
      "description": "The creation time of the recording. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "deleteDate": {
      "type": "string",
      "description": "The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "emailTranscript": {
      "type": "array",
      "description": "Represents an email transcript"
    },
    "endTime": {
      "type": "string",
      "description": "The end time of the recording. Null when there is no playable media."
    },
    "estimatedTranscodeTimeMs": {
      "type": "integer",
      "description": "estimatedTranscodeTimeMs"
    },
    "exportDate": {
      "type": "string",
      "description": "The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "exportedDate": {
      "type": "string",
      "description": "The date the recording was exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "fileState": {
      "type": "string",
      "description": "Represents the current file state for a recording. Examples: Uploading, Archived, etc",
      "enum": [
        "ARCHIVED",
        "AVAILABLE",
        "DELETED",
        "RESTORED",
        "RESTORING",
        "UPLOADING",
        "ERROR"
      ]
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "maxAllowedRestorationsForOrg": {
      "type": "integer",
      "description": "How many archive restorations the organization is allowed to have. Deprecated - Always returns 10000 since the restoration limit is no longer enforced."
    },
    "media": {
      "type": "string",
      "description": "The media type of the recording. This could be audio, chat, messaging, email, or screen."
    },
    "mediaSubject": {
      "type": "string",
      "description": "The media subject of the recording."
    },
    "mediaSubtype": {
      "type": "string",
      "description": "The media subtype of the recording.",
      "enum": [
        "Trunk",
        "Station",
        "Consult",
        "Screen",
        "Snippet"
      ]
    },
    "mediaUris": {
      "type": "object",
      "description": "The different mediaUris for the recording. Null when there is no playable media."
    },
    "messagingTranscript": {
      "type": "array",
      "description": "Represents a messaging transcript"
    },
    "name": {
      "type": "string",
      "description": "name"
    },
    "originalRecordingStartTime": {
      "type": "string",
      "description": "The start time of the full recording, before any segment access restrictions are applied. Null when there is no playable media. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "outputDurationMs": {
      "type": "integer",
      "description": "Duration of transcoded media in milliseconds"
    },
    "outputSizeInBytes": {
      "type": "integer",
      "description": "Size of transcoded media in bytes. 0 if there is no transcoded media."
    },
    "path": {
      "type": "string",
      "description": "path"
    },
    "recordingErrorStatus": {
      "type": "string",
      "description": "Status of a recording that cannot be returned because of an error",
      "enum": [
        "EMAIL_TRANSCRIPT_TOO_LARGE"
      ]
    },
    "recordingFileRole": {
      "type": "string",
      "description": "Role of the file recording. It can be either customer_experience or adhoc.",
      "enum": [
        "CUSTOMER_EXPERIENCE",
        "ADHOC"
      ]
    },
    "remainingRestorationsAllowedForOrg": {
      "type": "integer",
      "description": "The remaining archive restorations the organization has. Deprecated - Always returns 10000 since the restoration limit is no longer enforced."
    },
    "restoreExpirationTime": {
      "type": "string",
      "description": "The amount of time a restored recording will remain restored before being archived again. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "sessionId": {
      "type": "string",
      "description": "The session id represents an external resource id, such as email, call, chat, etc"
    },
    "startTime": {
      "type": "string",
      "description": "The start time of the recording. Null when there is no playable media."
    },
    "transcript": {
      "type": "array",
      "description": "Represents a chat transcript"
    },
    "users": {
      "type": "array",
      "description": "The users participating in the conversation"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "recordingId"
  ]
}

genesys_recording_put_conversation_recording_annotation

Update annotation Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation ID
`recordingId`	string	Yes	—	Recording ID
`annotationId`	string	Yes	—	Annotation ID
`absoluteDurationMs`	integer	No	—	Duration of annotation (milliseconds).
`absoluteLocation`	integer	No	—	Offset of annotation (milliseconds) from start of recording (after removing the cumulative duration of all pauses).
`annotations`	any[]	No	—	List of annotations
`description`	string	No	—	Text of annotation. Maximum character limit is 500.
`durationMs`	integer	No	—	Duration of annotation in milliseconds.
`id`	string	No	—	Annotation id. All pause annotations on a recording will share an ID value, bookmark annotations will have unique IDs, and hold annotations will have randomly generated UUIDs (i.e. the ID will change at each request).
`location`	integer	No	—	Offset of annotation in milliseconds.
`name`	string	No	—	name
`realtimeLocation`	integer	No	—	Offset of annotation (milliseconds) from start of the recording before removing the cumulative duration of all pauses before this annotation
`reason`	string	No	—	Reason for a pause annotation. Valid values: Hold,SecurePause,FlowOrQueue,Pause
`recordingDurationMs`	integer	No	—	Duration of annotation (milliseconds), adjusted for any recording cuts.
`recordingLocation`	integer	No	—	Offset of annotation (milliseconds) from start of recording, adjusted for any recording cuts
`selfUri`	string	No	—	The URI for this object
`type`	string	No	—	type
`user`	object	No	—	user

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation ID"
    },
    "recordingId": {
      "type": "string",
      "description": "Recording ID"
    },
    "annotationId": {
      "type": "string",
      "description": "Annotation ID"
    },
    "absoluteDurationMs": {
      "type": "integer",
      "description": "Duration of annotation (milliseconds)."
    },
    "absoluteLocation": {
      "type": "integer",
      "description": "Offset of annotation (milliseconds) from start of recording (after removing the cumulative duration of all pauses)."
    },
    "annotations": {
      "type": "array",
      "description": "List of annotations"
    },
    "description": {
      "type": "string",
      "description": "Text of annotation. Maximum character limit is 500."
    },
    "durationMs": {
      "type": "integer",
      "description": "Duration of annotation in milliseconds."
    },
    "id": {
      "type": "string",
      "description": "Annotation id. All pause annotations on a recording will share an ID value, bookmark annotations will have unique IDs, and hold annotations will have randomly generated UUIDs (i.e. the ID will change at each request)."
    },
    "location": {
      "type": "integer",
      "description": "Offset of annotation in milliseconds."
    },
    "name": {
      "type": "string",
      "description": "name"
    },
    "realtimeLocation": {
      "type": "integer",
      "description": "Offset of annotation (milliseconds) from start of the recording before removing the cumulative duration of all pauses before this annotation"
    },
    "reason": {
      "type": "string",
      "description": "Reason for a pause annotation. Valid values: Hold,SecurePause,FlowOrQueue,Pause",
      "enum": [
        "Hold",
        "SecurePause",
        "FlowOrQueue",
        "Pause"
      ]
    },
    "recordingDurationMs": {
      "type": "integer",
      "description": "Duration of annotation (milliseconds), adjusted for any recording cuts."
    },
    "recordingLocation": {
      "type": "integer",
      "description": "Offset of annotation (milliseconds) from start of recording, adjusted for any recording cuts"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "type": {
      "type": "string",
      "description": "type"
    },
    "user": {
      "type": "object",
      "description": "user"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "recordingId",
    "annotationId"
  ]
}

genesys_recording_put_crossplatform_mediaretentionpolicy

Update a media retention policy Parameters:

Parameter	Type	Required	Default	Description
`policyId`	string	Yes	—	Policy ID
`actions`	object	No	—	actions
`conditions`	object	No	—	conditions
`createdDate`	string	No	—	Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`description`	string	No	—	description
`enabled`	boolean	No	—	enabled
`id`	string	No	—	The globally unique identifier for the object.
`mediaPolicies`	object	No	—	mediaPolicies
`modifiedDate`	string	No	—	Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`name`	string	No	—	name
`order`	integer	No	—	order
`policyErrors`	object	No	—	policyErrors
`selfUri`	string	No	—	The URI for this object

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "policyId": {
      "type": "string",
      "description": "Policy ID"
    },
    "actions": {
      "type": "object",
      "description": "actions"
    },
    "conditions": {
      "type": "object",
      "description": "conditions"
    },
    "createdDate": {
      "type": "string",
      "description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "description": {
      "type": "string",
      "description": "description"
    },
    "enabled": {
      "type": "boolean",
      "description": "enabled"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "mediaPolicies": {
      "type": "object",
      "description": "mediaPolicies"
    },
    "modifiedDate": {
      "type": "string",
      "description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "name": {
      "type": "string",
      "description": "name"
    },
    "order": {
      "type": "integer",
      "description": "order"
    },
    "policyErrors": {
      "type": "object",
      "description": "policyErrors"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    }
  },
  "required": [
    "PCID",
    "policyId"
  ]
}

genesys_recording_put_job

Execute the recording bulk job. Parameters:

Parameter	Type	Required	Default	Description
`jobId`	string	Yes	—	jobId
`state`	string	Yes	—	The desired state for the job to be set to.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "jobId": {
      "type": "string",
      "description": "jobId"
    },
    "state": {
      "type": "string",
      "description": "The desired state for the job to be set to.",
      "enum": [
        "PROCESSING"
      ]
    }
  },
  "required": [
    "PCID",
    "jobId",
    "state"
  ]
}

genesys_recording_put_mediaretentionpolicy

Update a media retention policy Parameters:

Parameter	Type	Required	Default	Description
`policyId`	string	Yes	—	Policy ID
`actions`	object	No	—	actions
`conditions`	object	No	—	conditions
`createdDate`	string	No	—	Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`description`	string	No	—	description
`enabled`	boolean	No	—	enabled
`id`	string	No	—	The globally unique identifier for the object.
`mediaPolicies`	object	No	—	mediaPolicies
`modifiedDate`	string	No	—	Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`name`	string	No	—	name
`order`	integer	No	—	order
`policyErrors`	object	No	—	policyErrors
`selfUri`	string	No	—	The URI for this object

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "policyId": {
      "type": "string",
      "description": "Policy ID"
    },
    "actions": {
      "type": "object",
      "description": "actions"
    },
    "conditions": {
      "type": "object",
      "description": "conditions"
    },
    "createdDate": {
      "type": "string",
      "description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "description": {
      "type": "string",
      "description": "description"
    },
    "enabled": {
      "type": "boolean",
      "description": "enabled"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "mediaPolicies": {
      "type": "object",
      "description": "mediaPolicies"
    },
    "modifiedDate": {
      "type": "string",
      "description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "name": {
      "type": "string",
      "description": "name"
    },
    "order": {
      "type": "integer",
      "description": "order"
    },
    "policyErrors": {
      "type": "object",
      "description": "policyErrors"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    }
  },
  "required": [
    "PCID",
    "policyId"
  ]
}

genesys_recording_put_orphanrecording

Updates an orphan recording to a regular recording with retention values Parameters:

Parameter	Type	Required	Default	Description
`orphanId`	string	Yes	—	Orphan ID
`archiveDate`	string	No	—	The orphan recording’s archive date. Must be greater than 1 day from now if set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`conversationId`	string	No	—	A conversation Id that this orphan’s recording is to be attached to. If not present, the conversationId will be deduced from the recording media.
`deleteDate`	string	No	—	The orphan recording’s delete date. Must be greater than archiveDate and exportDate if set, otherwise one day from now. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`exportDate`	string	No	—	The orphan recording’s export date. Must be greater than 1 day from now if set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`integrationId`	string	No	—	IntegrationId to access AWS S3 bucket for export. This field is required if exportDate is set.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "orphanId": {
      "type": "string",
      "description": "Orphan ID"
    },
    "archiveDate": {
      "type": "string",
      "description": "The orphan recording's archive date. Must be greater than 1 day from now if set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "conversationId": {
      "type": "string",
      "description": "A conversation Id that this orphan's recording is to be attached to. If not present, the conversationId will be deduced from the recording media."
    },
    "deleteDate": {
      "type": "string",
      "description": "The orphan recording's delete date. Must be greater than archiveDate and exportDate if set, otherwise one day from now. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "exportDate": {
      "type": "string",
      "description": "The orphan recording's export date. Must be greater than 1 day from now if set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "integrationId": {
      "type": "string",
      "description": "IntegrationId to access AWS S3 bucket for export. This field is required if exportDate is set."
    }
  },
  "required": [
    "PCID",
    "orphanId"
  ]
}

genesys_recording_put_recordingkeys_rotationschedule

Update key rotation schedule Parameters:

Parameter	Type	Required	Default	Description
`id`	string	No	—	The globally unique identifier for the object.
`name`	string	No	—	name
`period`	string	Yes	—	Value to set schedule to
`selfUri`	string	No	—	The URI for this object

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "name": {
      "type": "string",
      "description": "name"
    },
    "period": {
      "type": "string",
      "description": "Value to set schedule to",
      "enum": [
        "DISABLED",
        "DAILY",
        "WEEKLY",
        "MONTHLY",
        "YEARLY"
      ]
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    }
  },
  "required": [
    "PCID",
    "period"
  ]
}

genesys_recording_put_recordings_deletionprotection

Apply or revoke recording protection for conversations Parameters:

Parameter	Type	Required	Default	Description
`protect`	boolean	No	—	Check for apply, uncheck for revoke (each action requires the respective permission)
`conversationIds`	any[]	No	—	This is a list of ConversationIds. The list cannot exceed 100 conversationids.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "protect": {
      "type": "boolean",
      "description": "Check for apply, uncheck for revoke (each action requires the respective permission)"
    },
    "conversationIds": {
      "type": "array",
      "description": "This is a list of ConversationIds. The list cannot exceed 100 conversationids."
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_recording_put_settings

Update the Recording Settings for the Organization Parameters:

Parameter	Type	Required	Default	Description
`maxConfigurableScreenRecordingStreams`	integer	No	—	Upper limit that maxSimultaneousStreams can be configured
`maxSimultaneousStreams`	integer	No	—	Maximum number of simultaneous screen recording streams
`recordingBatchDownloadUrlTtl`	integer	No	—	The duration in minutes for which the generated URL for recording batch download remains valid.The default duration is set to 60 minutes, with a minimum allowable duration of 2 minutes and a maximum of 60 minutes.
`recordingPlaybackUrlTtl`	integer	No	—	The duration in minutes for which the generated URL for recording playback remains valid.The default duration is set to 60 minutes, with a minimum allowable duration of 2 minutes and a maximum of 60 minutes.
`regionalRecordingStorageEnabled`	boolean	No	—	Store call recordings in the region where they are intended to be recorded, otherwise in the organization’s home region

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "maxConfigurableScreenRecordingStreams": {
      "type": "integer",
      "description": "Upper limit that maxSimultaneousStreams can be configured"
    },
    "maxSimultaneousStreams": {
      "type": "integer",
      "description": "Maximum number of simultaneous screen recording streams"
    },
    "recordingBatchDownloadUrlTtl": {
      "type": "integer",
      "description": "The duration in minutes for which the generated URL for recording batch download remains valid.The default duration is set to 60 minutes, with a minimum allowable duration of 2 minutes and a maximum of 60 minutes."
    },
    "recordingPlaybackUrlTtl": {
      "type": "integer",
      "description": "The duration in minutes for which the generated URL for recording playback remains valid.The default duration is set to 60 minutes, with a minimum allowable duration of 2 minutes and a maximum of 60 minutes."
    },
    "regionalRecordingStorageEnabled": {
      "type": "boolean",
      "description": "Store call recordings in the region where they are intended to be recorded, otherwise in the organization's home region"
    }
  },
  "required": [
    "PCID"
  ]
}

Triggers API

Platform API

Embedded MCP Servers

Application MCP Servers

​Tools

​genesys_recording_delete_conversation_recording_annotation

​genesys_recording_delete_crossplatform_mediaretentionpolicies

​genesys_recording_delete_crossplatform_mediaretentionpolicy

​genesys_recording_delete_job

​genesys_recording_delete_mediaretentionpolicies

​genesys_recording_delete_mediaretentionpolicy

​genesys_recording_delete_orphanrecording

​genesys_recording_get_batchrequest

​genesys_recording_get_conversation_recording

​genesys_recording_get_conversation_recording_annotation

​genesys_recording_get_conversation_recording_annotations

​genesys_recording_get_conversation_recordingmetadata

​genesys_recording_get_conversation_recordingmetadata_recording_id

​genesys_recording_get_conversation_recordings

​genesys_recording_get_crossplatform_mediaretentionpolicies

​genesys_recording_get_crossplatform_mediaretentionpolicy

​genesys_recording_get_job

​genesys_recording_get_job_failedrecordings

​genesys_recording_get_jobs

​genesys_recording_get_mediaretentionpolicies

​genesys_recording_get_mediaretentionpolicy

​genesys_recording_get_orphanrecording

​genesys_recording_get_orphanrecording_media

​genesys_recording_get_orphanrecordings

​genesys_recording_get_recordingkeys

​genesys_recording_get_recordingkeys_rotationschedule

​genesys_recording_get_recordings_retention_query

​genesys_recording_get_recordings_screensessions_details

​genesys_recording_get_settings

​genesys_recording_get_uploads_report

​genesys_recording_patch_crossplatform_mediaretentionpolicy

​genesys_recording_patch_mediaretentionpolicy

​genesys_recording_post_batchrequests

​genesys_recording_post_conversation_recording_annotations

​genesys_recording_post_crossplatform_mediaretentionpolicies

​genesys_recording_post_jobs

​genesys_recording_post_localkeys

​genesys_recording_post_mediaretentionpolicies

​genesys_recording_post_recordingkeys

​genesys_recording_post_recordings_deletionprotection

​genesys_recording_post_recordings_screensessions_acknowledge

​genesys_recording_post_recordings_screensessions_metadata

​genesys_recording_post_uploads_reports

​genesys_recording_put_conversation_recording

​genesys_recording_put_conversation_recording_annotation

​genesys_recording_put_crossplatform_mediaretentionpolicy

​genesys_recording_put_job

​genesys_recording_put_mediaretentionpolicy

​genesys_recording_put_orphanrecording

​genesys_recording_put_recordingkeys_rotationschedule

​genesys_recording_put_recordings_deletionprotection

​genesys_recording_put_settings

Tools

genesys_recording_delete_conversation_recording_annotation

genesys_recording_delete_crossplatform_mediaretentionpolicies

genesys_recording_delete_crossplatform_mediaretentionpolicy

genesys_recording_delete_job

genesys_recording_delete_mediaretentionpolicies

genesys_recording_delete_mediaretentionpolicy

genesys_recording_delete_orphanrecording

genesys_recording_get_batchrequest

genesys_recording_get_conversation_recording

genesys_recording_get_conversation_recording_annotation

genesys_recording_get_conversation_recording_annotations

genesys_recording_get_conversation_recordingmetadata

genesys_recording_get_conversation_recordingmetadata_recording_id

genesys_recording_get_conversation_recordings

genesys_recording_get_crossplatform_mediaretentionpolicies

genesys_recording_get_crossplatform_mediaretentionpolicy

genesys_recording_get_job

genesys_recording_get_job_failedrecordings

genesys_recording_get_jobs

genesys_recording_get_mediaretentionpolicies

genesys_recording_get_mediaretentionpolicy

genesys_recording_get_orphanrecording

genesys_recording_get_orphanrecording_media

genesys_recording_get_orphanrecordings

genesys_recording_get_recordingkeys

genesys_recording_get_recordingkeys_rotationschedule

genesys_recording_get_recordings_retention_query

genesys_recording_get_recordings_screensessions_details

genesys_recording_get_settings

genesys_recording_get_uploads_report

genesys_recording_patch_crossplatform_mediaretentionpolicy

genesys_recording_patch_mediaretentionpolicy

genesys_recording_post_batchrequests

genesys_recording_post_conversation_recording_annotations

genesys_recording_post_crossplatform_mediaretentionpolicies

genesys_recording_post_jobs

genesys_recording_post_localkeys

genesys_recording_post_mediaretentionpolicies

genesys_recording_post_recordingkeys

genesys_recording_post_recordings_deletionprotection

genesys_recording_post_recordings_screensessions_acknowledge

genesys_recording_post_recordings_screensessions_metadata

genesys_recording_post_uploads_reports

genesys_recording_put_conversation_recording

genesys_recording_put_conversation_recording_annotation

genesys_recording_put_crossplatform_mediaretentionpolicy

genesys_recording_put_job

genesys_recording_put_mediaretentionpolicy

genesys_recording_put_orphanrecording

genesys_recording_put_recordingkeys_rotationschedule

genesys_recording_put_recordings_deletionprotection

genesys_recording_put_settings