Skip to main content
Server path: /genesys-recording | Type: Application | PCID required: Yes

​
Tools

ToolDescription
genesys_recording_delete_conversation_recording_annotationDelete annotation
genesys_recording_delete_crossplatform_mediaretentionpoliciesDelete media retention policies
genesys_recording_delete_crossplatform_mediaretentionpolicyDelete a media retention policy
genesys_recording_delete_jobDelete the recording bulk job
genesys_recording_delete_mediaretentionpoliciesDelete media retention policies
genesys_recording_delete_mediaretentionpolicyDelete a media retention policy
genesys_recording_delete_orphanrecordingDeletes a single orphan recording
genesys_recording_get_batchrequestGet 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_recordingGets a specific recording.
genesys_recording_get_conversation_recording_annotationGet annotation
genesys_recording_get_conversation_recording_annotationsGet annotations for recording
genesys_recording_get_conversation_recordingmetadataGet 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_idGet metadata for a specific recording. Does not return playable media. Bookmark annotations will be excluded if either recording:recording:view or recording:annotation:view permission is missing.
genesys_recording_get_conversation_recordingsGet all of a Conversation’s Recordings.
genesys_recording_get_crossplatform_mediaretentionpoliciesGets media retention policy list with query options to filter on name and enabled.
genesys_recording_get_crossplatform_mediaretentionpolicyGet a media retention policy
genesys_recording_get_jobGet the status of the job associated with the job id.
genesys_recording_get_job_failedrecordingsGet IDs of recordings that the bulk job failed for
genesys_recording_get_jobsGet the status of all jobs within the user’s organization
genesys_recording_get_mediaretentionpoliciesGets media retention policy list with query options to filter on name and enabled.
genesys_recording_get_mediaretentionpolicyGet a media retention policy
genesys_recording_get_orphanrecordingGets a single orphan recording
genesys_recording_get_orphanrecording_mediaGets the media of a single orphan recording
genesys_recording_get_orphanrecordingsGets all orphan recordings
genesys_recording_get_recordingkeysGet encryption key list
genesys_recording_get_recordingkeys_rotationscheduleGet key rotation schedule
genesys_recording_get_recordings_retention_queryQuery for recording retention data
genesys_recording_get_recordings_screensessions_detailsRetrieves an object containing the total number of concurrent active screen recordings
genesys_recording_get_settingsGet the Recording Settings for the Organization
genesys_recording_get_uploads_reportGet the status of a recording upload status report
genesys_recording_patch_crossplatform_mediaretentionpolicyPatch a media retention policy
genesys_recording_patch_mediaretentionpolicyPatch a media retention policy
genesys_recording_post_batchrequestsSubmit a batch download request for recordings. Recordings in response will be in their original format/codec - configured in the Trunk configuration. If the recording:recording:viewSensitiveData permission is missing and the organization has sensitive data redaction enabled, recordings with sensitive data will be excluded from the batch download.
genesys_recording_post_conversation_recording_annotationsCreate annotation
genesys_recording_post_crossplatform_mediaretentionpoliciesCreate media retention policy
genesys_recording_post_jobsCreate a recording bulk job.
genesys_recording_post_localkeyscreate a local key management recording key
genesys_recording_post_mediaretentionpoliciesCreate media retention policy
genesys_recording_post_recordingkeysCreate encryption key
genesys_recording_post_recordings_deletionprotectionGet a list of conversations with protected recordings
genesys_recording_post_recordings_screensessions_acknowledgeAcknowledge a screen recording.
genesys_recording_post_recordings_screensessions_metadataProvide meta-data a screen recording.
genesys_recording_post_uploads_reportsCreates a recording upload status report
genesys_recording_put_conversation_recordingUpdates the retention records on a recording.
genesys_recording_put_conversation_recording_annotationUpdate annotation
genesys_recording_put_crossplatform_mediaretentionpolicyUpdate a media retention policy
genesys_recording_put_jobExecute the recording bulk job.
genesys_recording_put_mediaretentionpolicyUpdate a media retention policy
genesys_recording_put_orphanrecordingUpdates an orphan recording to a regular recording with retention values
genesys_recording_put_recordingkeys_rotationscheduleUpdate key rotation schedule
genesys_recording_put_recordings_deletionprotectionApply or revoke recording protection for conversations
genesys_recording_put_settingsUpdate the Recording Settings for the Organization

​
genesys_recording_delete_conversation_recording_annotation

Delete annotation Parameters:
ParameterTypeRequiredDefaultDescription
conversationIdstringYes—Conversation ID
recordingIdstringYes—Recording ID
annotationIdstringYes—Annotation ID

​
genesys_recording_delete_crossplatform_mediaretentionpolicies

Delete media retention policies Parameters:
ParameterTypeRequiredDefaultDescription
idsstringYes—The ids value

​
genesys_recording_delete_crossplatform_mediaretentionpolicy

Delete a media retention policy Parameters:
ParameterTypeRequiredDefaultDescription
policyIdstringYes—Policy ID

​
genesys_recording_delete_job

Delete the recording bulk job Parameters:
ParameterTypeRequiredDefaultDescription
jobIdstringYes—Job Id

​
genesys_recording_delete_mediaretentionpolicies

Delete media retention policies Parameters:
ParameterTypeRequiredDefaultDescription
idsstringYes—The ids value

​
genesys_recording_delete_mediaretentionpolicy

Delete a media retention policy Parameters:
ParameterTypeRequiredDefaultDescription
policyIdstringYes—Policy ID

​
genesys_recording_delete_orphanrecording

Deletes a single orphan recording Parameters:
ParameterTypeRequiredDefaultDescription
orphanIdstringYes—Orphan ID

​
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:
ParameterTypeRequiredDefaultDescription
jobIdstringYes—Job Id

​
genesys_recording_get_conversation_recording

Gets a specific recording. Parameters:
ParameterTypeRequiredDefaultDescription
conversationIdstringYes—Conversation ID
recordingIdstringYes—Recording ID
formatIdstringNo—The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE
emailFormatIdstringNo—The desired media format when downloading an email recording. Valid values:EML,NONE
chatFormatIdstringNo—The desired media format when downloading a chat recording. Valid values:ZIP,NONE
messageFormatIdstringNo—The desired media format when downloading a message recording. Valid values:ZIP,NONE
downloadbooleanNo—requesting a download format of the recording. Valid values:true,false
fileNamestringNo—the name of the downloaded fileName
localestringNo—The locale for the requested file when downloading or for redacting sensitive information in requested files, as an ISO 639-1 code
mediaFormatsstring[]No—All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3

​
genesys_recording_get_conversation_recording_annotation

Get annotation Parameters:
ParameterTypeRequiredDefaultDescription
conversationIdstringYes—Conversation ID
recordingIdstringYes—Recording ID
annotationIdstringYes—Annotation ID

​
genesys_recording_get_conversation_recording_annotations

Get annotations for recording Parameters:
ParameterTypeRequiredDefaultDescription
conversationIdstringYes—Conversation ID
recordingIdstringYes—Recording ID

​
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:
ParameterTypeRequiredDefaultDescription
conversationIdstringYes—Conversation ID

​
genesys_recording_get_conversation_recordingmetadata_recording_id

Get metadata for a specific recording. Does not return playable media. Bookmark annotations will be excluded if either recording:recording:view or recording:annotation:view permission is missing. Parameters:
ParameterTypeRequiredDefaultDescription
conversationIdstringYes—Conversation ID
recordingIdstringYes—Recording ID

​
genesys_recording_get_conversation_recordings

Get all of a Conversation’s Recordings. Parameters:
ParameterTypeRequiredDefaultDescription
conversationIdstringYes—Conversation ID
maxWaitMsintegerNo—The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value.
formatIdstringNo—The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE.
mediaFormatsstring[]No—All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3.
localestringNo—The locale used for redacting sensitive information in requested files, as an ISO 639-1 code
includePauseAnnotationsForScreenRecordingsbooleanNo—Include applicable Secure Pause annotations from all audio recordings to all screen recordings

​
genesys_recording_get_crossplatform_mediaretentionpolicies

Gets media retention policy list with query options to filter on name and enabled. Parameters:
ParameterTypeRequiredDefaultDescription
pageSizeintegerNo—The total page size requested
pageNumberintegerNo—The page number requested
sortBystringNo—variable name requested to sort by
expandstring[]No—variable name requested by expand list
nextPagestringNo—next page token
previousPagestringNo—Previous page token
namestringNo—the policy name - used for filtering results in searches.
enabledbooleanNo—checks to see if policy is enabled - use enabled = true or enabled = false
summarybooleanNo—provides a less verbose response of policy lists.
hasErrorsbooleanNo—provides a way to fetch all policies with errors or policies that do not have errors
deleteDaysThresholdintegerNo—provides a way to fetch all policies with any actions having deleteDays exceeding the provided value

​
genesys_recording_get_crossplatform_mediaretentionpolicy

Get a media retention policy Parameters:
ParameterTypeRequiredDefaultDescription
policyIdstringYes—Policy ID

​
genesys_recording_get_job

Get the status of the job associated with the job id. Parameters:
ParameterTypeRequiredDefaultDescription
jobIdstringYes—Job Id

​
genesys_recording_get_job_failedrecordings

Get IDs of recordings that the bulk job failed for Parameters:
ParameterTypeRequiredDefaultDescription
jobIdstringYes—Job Id
pageSizeintegerNo—Page size. Maximum is 100.
pageNumberintegerNo—Page number
includeTotalbooleanNo—If false, cursor will be used to locate the page instead of pageNumber. It is recommended to set it to false for improved performance.
cursorstringNo—Indicates where to resume query results (not required for first page)

​
genesys_recording_get_jobs

Get the status of all jobs within the user’s organization Parameters:
ParameterTypeRequiredDefaultDescription
pageSizeintegerNo—Page size
pageNumberintegerNo—Page number
sortBystringNo—Sort by
statestringNo—Filter by state
showOnlyMyJobsbooleanNo—Show only my jobs
jobTypestringNo—Job Type (Can be left empty for both)
includeTotalbooleanNo—If false, cursor will be used to locate the page instead of pageNumber. It is recommended to set it to false for improved performance.
cursorstringNo—Indicates where to resume query results (not required for first page)

​
genesys_recording_get_mediaretentionpolicies

Gets media retention policy list with query options to filter on name and enabled. Parameters:
ParameterTypeRequiredDefaultDescription
pageSizeintegerNo—The total page size requested
pageNumberintegerNo—The page number requested
sortBystringNo—variable name requested to sort by
expandstring[]No—variable name requested by expand list
nextPagestringNo—next page token
previousPagestringNo—Previous page token
namestringNo—the policy name - used for filtering results in searches.
enabledbooleanNo—checks to see if policy is enabled - use enabled = true or enabled = false
summarybooleanNo—provides a less verbose response of policy lists.
hasErrorsbooleanNo—provides a way to fetch all policies with errors or policies that do not have errors
deleteDaysThresholdintegerNo—provides a way to fetch all policies with any actions having deleteDays exceeding the provided value

​
genesys_recording_get_mediaretentionpolicy

Get a media retention policy Parameters:
ParameterTypeRequiredDefaultDescription
policyIdstringYes—Policy ID

​
genesys_recording_get_orphanrecording

Gets a single orphan recording Parameters:
ParameterTypeRequiredDefaultDescription
orphanIdstringYes—Orphan ID

​
genesys_recording_get_orphanrecording_media

Gets the media of a single orphan recording Parameters:
ParameterTypeRequiredDefaultDescription
orphanIdstringYes—Orphan ID
formatIdstringNo—The desired media format.
emailFormatIdstringNo—The desired media format when downloading an email recording.
chatFormatIdstringNo—The desired media format when downloading a chat recording.
messageFormatIdstringNo—The desired media format when downloading a message recording.
downloadbooleanNo—requesting a download format of the recording
fileNamestringNo—the name of the downloaded fileName
localestringNo—The locale for the requested file when downloading, as an ISO 639-1 code
mediaFormatsstring[]No—All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3

​
genesys_recording_get_orphanrecordings

Gets all orphan recordings Parameters:
ParameterTypeRequiredDefaultDescription
pageSizeintegerNo—The total page size requested
pageNumberintegerNo—The page number requested
sortBystringNo—variable name requested to sort by
expandstring[]No—variable name requested by expand list
nextPagestringNo—next page token
previousPagestringNo—Previous page token
hasConversationbooleanNo—Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization.
mediastringNo—Filter resulting orphans based on their media type

​
genesys_recording_get_recordingkeys

Get encryption key list Parameters:
ParameterTypeRequiredDefaultDescription
pageSizeintegerNo—Page size
pageNumberintegerNo—Page number

​
genesys_recording_get_recordingkeys_rotationschedule

Get key rotation schedule

​
genesys_recording_get_recordings_retention_query

Query for recording retention data Parameters:
ParameterTypeRequiredDefaultDescription
retentionThresholdDaysintegerYes—Fetch retention data for recordings retained for more days than the provided value.
cursorstringNo—Indicates where to resume query results (not required for first page)
pageSizeintegerNo—Page size. Maximum is 500.

​
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 Parameters:
ParameterTypeRequiredDefaultDescription
createDefaultbooleanNo—If no settings are found, a new one is created with default values

​
genesys_recording_get_uploads_report

Get the status of a recording upload status report Parameters:
ParameterTypeRequiredDefaultDescription
reportIdstringYes—Report Id

​
genesys_recording_patch_crossplatform_mediaretentionpolicy

Patch a media retention policy Parameters:
ParameterTypeRequiredDefaultDescription
policyIdstringYes—Policy ID
enabledbooleanNo—The enabled value

​
genesys_recording_patch_mediaretentionpolicy

Patch a media retention policy Parameters:
ParameterTypeRequiredDefaultDescription
policyIdstringYes—Policy ID
enabledbooleanNo—The enabled value

​
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. If the recording:recording:viewSensitiveData permission is missing and the organization has sensitive data redaction enabled, recordings with sensitive data will be excluded from the batch download. Parameters:
ParameterTypeRequiredDefaultDescription
batchDownloadRequestListobject[]Yes—List of up to 100 items requested

​
genesys_recording_post_conversation_recording_annotations

Create annotation Parameters:
ParameterTypeRequiredDefaultDescription
conversationIdstringYes—Conversation ID
recordingIdstringYes—Recording ID
absoluteDurationMsintegerNo—Duration of annotation (milliseconds).
absoluteLocationintegerNo—Offset of annotation (milliseconds) from start of recording (after removing the cumulative duration of all pauses).
annotationsobject[]No—List of annotations
descriptionstringNo—Text of annotation. Maximum character limit is 500.
durationMsintegerNo—Duration of annotation in milliseconds.
idstringNo—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).
locationintegerNo—Offset of annotation in milliseconds.
namestringNo—The name value
realtimeLocationintegerNo—Offset of annotation (milliseconds) from start of the recording before removing the cumulative duration of all pauses before this annotation
reasonstringNo—Reason for a pause annotation. Valid values: Hold,SecurePause,FlowOrQueue,Pause
recordingDurationMsintegerNo—Duration of annotation (milliseconds), adjusted for any recording cuts.
recordingLocationintegerNo—Offset of annotation (milliseconds) from start of recording, adjusted for any recording cuts
selfUristringNo—The URI for this object
typestringNo—The type value
userobjectNo—The user value

​
genesys_recording_post_crossplatform_mediaretentionpolicies

Create media retention policy Parameters:
ParameterTypeRequiredDefaultDescription
actionsobjectNo—The actions value
conditionsobjectNo—The conditions value
createdDatestringNo—Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
descriptionstringNo—The description value
enabledbooleanNo—The enabled value
idstringNo—The globally unique identifier for the object.
mediaPoliciesobjectNo—Media Policies
modifiedDatestringNo—Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
namestringYes—The policy name.
orderintegerNo—The order value
policyErrorsobjectNo—Policy Errors
selfUristringNo—The URI for this object

​
genesys_recording_post_jobs

Create a recording bulk job. Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYes—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.
actionAgeintegerNo—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.
actionDatestringNo—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
agedConversationIntervalstringNo—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
clearExportbooleanNo—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
conversationQueryobjectNo—Conversation Query
includePolicyBasedRecordingsbooleanNo—Whether to include policy-based recordings for the action, default value = true
includeRecordingsWithSensitiveDatabooleanNo—Whether to include recordings with PCI DSS and/or PII data, default value = false
includeScreenRecordingsbooleanNo—Whether to include Screen recordings for the action, default value = true
includeSnippetRecordingsbooleanNo—Whether to include snippet recordings for the action, default value = true
integrationIdstringNo—IntegrationId to Access AWS S3 bucket for bulk recording exports. This field is required and used only for EXPORT action.
screenRecordingActionAgeintegerNo—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.
screenRecordingActionDatestringNo—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

​
genesys_recording_post_localkeys

create a local key management recording key Parameters:
ParameterTypeRequiredDefaultDescription
configIdstringYes—The local configuration id that contains metadata on private local service
keypairIdstringYes—The key pair id from the local service.
publicKeystringYes—Base 64 encoded public key, generated by the local service.

​
genesys_recording_post_mediaretentionpolicies

Create media retention policy Parameters:
ParameterTypeRequiredDefaultDescription
actionsobjectNo—The actions value
conditionsobjectNo—The conditions value
createdDatestringNo—Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
descriptionstringNo—The description value
enabledbooleanNo—The enabled value
idstringNo—The globally unique identifier for the object.
mediaPoliciesobjectNo—Media Policies
modifiedDatestringNo—Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
namestringYes—The policy name.
orderintegerNo—The order value
policyErrorsobjectNo—Policy Errors
selfUristringNo—The URI for this object

​
genesys_recording_post_recordingkeys

Create encryption key

​
genesys_recording_post_recordings_deletionprotection

Get a list of conversations with protected recordings Parameters:
ParameterTypeRequiredDefaultDescription
conversationIdsstring[]Yes—This is a list of ConversationIds. The list cannot exceed 100 conversationids.

​
genesys_recording_post_recordings_screensessions_acknowledge

Acknowledge a screen recording. Parameters:
ParameterTypeRequiredDefaultDescription
conversationIdstringNo—Conversation Id
participantJidstringNo—Participant Jid
roomIdstringNo—Room Id

​
genesys_recording_post_recordings_screensessions_metadata

Provide meta-data a screen recording. Parameters:
ParameterTypeRequiredDefaultDescription
metaDataobject[]No—Meta Data
participantJidstringNo—Participant Jid
roomIdstringNo—Room Id

​
genesys_recording_post_uploads_reports

Creates a recording upload status report Parameters:
ParameterTypeRequiredDefaultDescription
dateSincestringYes—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
uploadStatusstringNo—Report will include uploads with this status

​
genesys_recording_put_conversation_recording

Updates the retention records on a recording. Parameters:
ParameterTypeRequiredDefaultDescription
conversationIdstringYes—Conversation ID
recordingIdstringYes—Recording ID
clearExportbooleanNo—Whether to clear the pending export for the recording
actualTranscodeTimeMsintegerNo—Actual Transcode Time Ms
annotationsobject[]No—Annotations that belong to the recording.
archiveDatestringNo—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
archiveMediumstringNo—The type of archive medium used. Example: CloudArchive
associatedConversationIdsstring[]No—List of associated conversation IDs
creationTimestringNo—The creation time of the recording. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
deleteDatestringNo—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
emailTranscriptobject[]No—Represents an email transcript
endTimestringNo—The end time of the recording. Null when there is no playable media.
estimatedTranscodeTimeMsintegerNo—Estimated Transcode Time Ms
exportDatestringNo—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
exportedDatestringNo—The date the recording was exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
fileStatestringNo—Represents the current file state for a recording. Examples: Uploading, Archived, etc
idstringNo—The globally unique identifier for the object.
maxAllowedRestorationsForOrgintegerNo—How many archive restorations the organization is allowed to have. Deprecated - Always returns 10000 since the restoration limit is no longer enforced.
mediastringNo—The media type of the recording. This could be audio, chat, messaging, email, or screen.
mediaSubjectstringNo—The media subject of the recording.
mediaSubtypestringNo—The media subtype of the recording.
mediaUrisobjectNo—The different mediaUris for the recording. Null when there is no playable media.
messagingTranscriptobject[]No—Represents a messaging transcript
namestringNo—The name value
originalRecordingStartTimestringNo—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
outputDurationMsintegerNo—Duration of transcoded media in milliseconds
outputSizeInBytesintegerNo—Size of transcoded media in bytes. 0 if there is no transcoded media.
pathstringNo—The path value
recordingErrorStatusstringNo—Status of a recording that cannot be returned because of an error
recordingFileRolestringNo—Role of the file recording. It can be either customer_experience or adhoc.
remainingRestorationsAllowedForOrgintegerNo—The remaining archive restorations the organization has. Deprecated - Always returns 10000 since the restoration limit is no longer enforced.
restoreExpirationTimestringNo—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
selfUristringNo—The URI for this object
sessionIdstringNo—The session id represents an external resource id, such as email, call, chat, etc
startTimestringNo—The start time of the recording. Null when there is no playable media.
transcriptobject[]No—Represents a chat transcript
usersobject[]No—The users participating in the conversation

​
genesys_recording_put_conversation_recording_annotation

Update annotation Parameters:
ParameterTypeRequiredDefaultDescription
conversationIdstringYes—Conversation ID
recordingIdstringYes—Recording ID
annotationIdstringYes—Annotation ID
absoluteDurationMsintegerNo—Duration of annotation (milliseconds).
absoluteLocationintegerNo—Offset of annotation (milliseconds) from start of recording (after removing the cumulative duration of all pauses).
annotationsobject[]No—List of annotations
descriptionstringNo—Text of annotation. Maximum character limit is 500.
durationMsintegerNo—Duration of annotation in milliseconds.
idstringNo—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).
locationintegerNo—Offset of annotation in milliseconds.
namestringNo—The name value
realtimeLocationintegerNo—Offset of annotation (milliseconds) from start of the recording before removing the cumulative duration of all pauses before this annotation
reasonstringNo—Reason for a pause annotation. Valid values: Hold,SecurePause,FlowOrQueue,Pause
recordingDurationMsintegerNo—Duration of annotation (milliseconds), adjusted for any recording cuts.
recordingLocationintegerNo—Offset of annotation (milliseconds) from start of recording, adjusted for any recording cuts
selfUristringNo—The URI for this object
typestringNo—The type value
userobjectNo—The user value

​
genesys_recording_put_crossplatform_mediaretentionpolicy

Update a media retention policy Parameters:
ParameterTypeRequiredDefaultDescription
policyIdstringYes—Policy ID
actionsobjectNo—The actions value
conditionsobjectNo—The conditions value
createdDatestringNo—Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
descriptionstringNo—The description value
enabledbooleanNo—The enabled value
idstringNo—The globally unique identifier for the object.
mediaPoliciesobjectNo—Media Policies
modifiedDatestringNo—Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
namestringNo—The name value
orderintegerNo—The order value
policyErrorsobjectNo—Policy Errors
selfUristringNo—The URI for this object

​
genesys_recording_put_job

Execute the recording bulk job. Parameters:
ParameterTypeRequiredDefaultDescription
jobIdstringYes—Job Id
statestringYes—The desired state for the job to be set to.

​
genesys_recording_put_mediaretentionpolicy

Update a media retention policy Parameters:
ParameterTypeRequiredDefaultDescription
policyIdstringYes—Policy ID
actionsobjectNo—The actions value
conditionsobjectNo—The conditions value
createdDatestringNo—Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
descriptionstringNo—The description value
enabledbooleanNo—The enabled value
idstringNo—The globally unique identifier for the object.
mediaPoliciesobjectNo—Media Policies
modifiedDatestringNo—Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
namestringNo—The name value
orderintegerNo—The order value
policyErrorsobjectNo—Policy Errors
selfUristringNo—The URI for this object

​
genesys_recording_put_orphanrecording

Updates an orphan recording to a regular recording with retention values Parameters:
ParameterTypeRequiredDefaultDescription
orphanIdstringYes—Orphan ID
archiveDatestringNo—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
conversationIdstringNo—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.
deleteDatestringNo—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
exportDatestringNo—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
integrationIdstringNo—IntegrationId to access AWS S3 bucket for export. This field is required if exportDate is set.

​
genesys_recording_put_recordingkeys_rotationschedule

Update key rotation schedule Parameters:
ParameterTypeRequiredDefaultDescription
idstringNo—The globally unique identifier for the object.
namestringNo—The name value
periodstringYes—Value to set schedule to
selfUristringNo—The URI for this object

​
genesys_recording_put_recordings_deletionprotection

Apply or revoke recording protection for conversations Parameters:
ParameterTypeRequiredDefaultDescription
protectbooleanNo—Check for apply, uncheck for revoke (each action requires the respective permission)
conversationIdsstring[]Yes—This is a list of ConversationIds. The list cannot exceed 100 conversationids.

​
genesys_recording_put_settings

Update the Recording Settings for the Organization Parameters:
ParameterTypeRequiredDefaultDescription
maxConfigurableScreenRecordingStreamsintegerNo—Upper limit that maxSimultaneousStreams can be configured
maxSimultaneousStreamsintegerNo—Maximum number of simultaneous screen recording streams
recordingBatchDownloadUrlTtlintegerNo—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.
recordingPlaybackUrlTtlintegerNo—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.
regionalRecordingStorageEnabledbooleanNo—Store call recordings in the region where they are intended to be recorded, otherwise in the organization’s home region