> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # genesys-recording > Genesys Recording - access and annotate conversation recordings, manage retention policies **Server path:** `/genesys-recording` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`genesys_recording_delete_conversation_recording_annotation`](#genesys_recording_delete_conversation_recording_annotation) | Delete annotation | | [`genesys_recording_delete_crossplatform_mediaretentionpolicies`](#genesys_recording_delete_crossplatform_mediaretentionpolicies) | Delete media retention policies | | [`genesys_recording_delete_crossplatform_mediaretentionpolicy`](#genesys_recording_delete_crossplatform_mediaretentionpolicy) | Delete a media retention policy | | [`genesys_recording_delete_job`](#genesys_recording_delete_job) | Delete the recording bulk job | | [`genesys_recording_delete_mediaretentionpolicies`](#genesys_recording_delete_mediaretentionpolicies) | Delete media retention policies | | [`genesys_recording_delete_mediaretentionpolicy`](#genesys_recording_delete_mediaretentionpolicy) | Delete a media retention policy | | [`genesys_recording_delete_orphanrecording`](#genesys_recording_delete_orphanrecording) | Deletes a single orphan recording | | [`genesys_recording_get_batchrequest`](#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`](#genesys_recording_get_conversation_recording) | Gets a specific recording. | | [`genesys_recording_get_conversation_recording_annotation`](#genesys_recording_get_conversation_recording_annotation) | Get annotation | | [`genesys_recording_get_conversation_recording_annotations`](#genesys_recording_get_conversation_recording_annotations) | Get annotations for recording | | [`genesys_recording_get_conversation_recordingmetadata`](#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`](#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. | | [`genesys_recording_get_conversation_recordings`](#genesys_recording_get_conversation_recordings) | Get all of a Conversation's Recordings. | | [`genesys_recording_get_crossplatform_mediaretentionpolicies`](#genesys_recording_get_crossplatform_mediaretentionpolicies) | Gets media retention policy list with query options to filter on name and enabled. | | [`genesys_recording_get_crossplatform_mediaretentionpolicy`](#genesys_recording_get_crossplatform_mediaretentionpolicy) | Get a media retention policy | | [`genesys_recording_get_job`](#genesys_recording_get_job) | Get the status of the job associated with the job id. | | [`genesys_recording_get_job_failedrecordings`](#genesys_recording_get_job_failedrecordings) | Get IDs of recordings that the bulk job failed for | | [`genesys_recording_get_jobs`](#genesys_recording_get_jobs) | Get the status of all jobs within the user's organization | | [`genesys_recording_get_mediaretentionpolicies`](#genesys_recording_get_mediaretentionpolicies) | Gets media retention policy list with query options to filter on name and enabled. | | [`genesys_recording_get_mediaretentionpolicy`](#genesys_recording_get_mediaretentionpolicy) | Get a media retention policy | | [`genesys_recording_get_orphanrecording`](#genesys_recording_get_orphanrecording) | Gets a single orphan recording | | [`genesys_recording_get_orphanrecording_media`](#genesys_recording_get_orphanrecording_media) | Gets the media of a single orphan recording | | [`genesys_recording_get_orphanrecordings`](#genesys_recording_get_orphanrecordings) | Gets all orphan recordings | | [`genesys_recording_get_recordingkeys`](#genesys_recording_get_recordingkeys) | Get encryption key list | | [`genesys_recording_get_recordingkeys_rotationschedule`](#genesys_recording_get_recordingkeys_rotationschedule) | Get key rotation schedule | | [`genesys_recording_get_recordings_retention_query`](#genesys_recording_get_recordings_retention_query) | Query for recording retention data | | [`genesys_recording_get_recordings_screensessions_details`](#genesys_recording_get_recordings_screensessions_details) | Retrieves an object containing the total number of concurrent active screen recordings | | [`genesys_recording_get_settings`](#genesys_recording_get_settings) | Get the Recording Settings for the Organization | | [`genesys_recording_get_uploads_report`](#genesys_recording_get_uploads_report) | Get the status of a recording upload status report | | [`genesys_recording_patch_crossplatform_mediaretentionpolicy`](#genesys_recording_patch_crossplatform_mediaretentionpolicy) | Patch a media retention policy | | [`genesys_recording_patch_mediaretentionpolicy`](#genesys_recording_patch_mediaretentionpolicy) | Patch a media retention policy | | [`genesys_recording_post_batchrequests`](#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. | | [`genesys_recording_post_conversation_recording_annotations`](#genesys_recording_post_conversation_recording_annotations) | Create annotation | | [`genesys_recording_post_crossplatform_mediaretentionpolicies`](#genesys_recording_post_crossplatform_mediaretentionpolicies) | Create media retention policy | | [`genesys_recording_post_jobs`](#genesys_recording_post_jobs) | Create a recording bulk job. | | [`genesys_recording_post_localkeys`](#genesys_recording_post_localkeys) | create a local key management recording key | | [`genesys_recording_post_mediaretentionpolicies`](#genesys_recording_post_mediaretentionpolicies) | Create media retention policy | | [`genesys_recording_post_recordingkeys`](#genesys_recording_post_recordingkeys) | Create encryption key | | [`genesys_recording_post_recordings_deletionprotection`](#genesys_recording_post_recordings_deletionprotection) | Get a list of conversations with protected recordings | | [`genesys_recording_post_recordings_screensessions_acknowledge`](#genesys_recording_post_recordings_screensessions_acknowledge) | Acknowledge a screen recording. | | [`genesys_recording_post_recordings_screensessions_metadata`](#genesys_recording_post_recordings_screensessions_metadata) | Provide meta-data a screen recording. | | [`genesys_recording_post_uploads_reports`](#genesys_recording_post_uploads_reports) | Creates a recording upload status report | | [`genesys_recording_put_conversation_recording`](#genesys_recording_put_conversation_recording) | Updates the retention records on a recording. | | [`genesys_recording_put_conversation_recording_annotation`](#genesys_recording_put_conversation_recording_annotation) | Update annotation | | [`genesys_recording_put_crossplatform_mediaretentionpolicy`](#genesys_recording_put_crossplatform_mediaretentionpolicy) | Update a media retention policy | | [`genesys_recording_put_job`](#genesys_recording_put_job) | Execute the recording bulk job. | | [`genesys_recording_put_mediaretentionpolicy`](#genesys_recording_put_mediaretentionpolicy) | Update a media retention policy | | [`genesys_recording_put_orphanrecording`](#genesys_recording_put_orphanrecording) | Updates an orphan recording to a regular recording with retention values | | [`genesys_recording_put_recordingkeys_rotationschedule`](#genesys_recording_put_recordingkeys_rotationschedule) | Update key rotation schedule | | [`genesys_recording_put_recordings_deletionprotection`](#genesys_recording_put_recordings_deletionprotection) | Apply or revoke recording protection for conversations | | [`genesys_recording_put_settings`](#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 | ```json theme={null} { "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 | — | The ids value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ids": { "type": "string", "description": "The ids value" } }, "required": [ "PCID", "ids" ] } ``` *** ## genesys\_recording\_delete\_crossplatform\_mediaretentionpolicy Delete a media retention policy **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ----------- | | `policyId` | string | Yes | — | Policy ID | ```json theme={null} { "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 | — | Job Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "Job Id" } }, "required": [ "PCID", "jobId" ] } ``` *** ## genesys\_recording\_delete\_mediaretentionpolicies Delete media retention policies **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------- | | `ids` | string | Yes | — | The ids value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ids": { "type": "string", "description": "The ids value" } }, "required": [ "PCID", "ids" ] } ``` *** ## genesys\_recording\_delete\_mediaretentionpolicy Delete a media retention policy **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ----------- | | `policyId` | string | Yes | — | Policy ID | ```json theme={null} { "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 | ```json theme={null} { "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 | — | Job Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "Job Id" } }, "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` | string\[] | No | — | All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV\_ULAW,OGG\_VORBIS,OGG\_OPUS,MP3 | ```json theme={null} { "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", "items": { "type": "string" }, "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 | ```json theme={null} { "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 | ```json theme={null} { "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 | ```json theme={null} { "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. 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 | | `recordingId` | string | Yes | — | Recording ID | ```json theme={null} { "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` | string\[] | 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 | ```json theme={null} { "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", "items": { "type": "string" }, "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` | string\[] | 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 | ```json theme={null} { "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", "items": { "type": "string" }, "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 | ```json theme={null} { "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 | — | Job Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "Job Id" } }, "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 | — | Job Id | | `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) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "Job Id" }, "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) | ```json theme={null} { "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` | string\[] | 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 | ```json theme={null} { "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", "items": { "type": "string" }, "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 | ```json theme={null} { "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 | ```json theme={null} { "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` | string\[] | No | — | All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV\_ULAW,OGG\_VORBIS,OGG\_OPUS,MP3 | ```json theme={null} { "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", "items": { "type": "string" }, "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` | string\[] | 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 | ```json theme={null} { "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", "items": { "type": "string" }, "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 | ```json theme={null} { "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 ```json theme={null} { "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. | ```json theme={null} { "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 ```json theme={null} { "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 | ```json theme={null} { "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 | — | Report Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "reportId": { "type": "string", "description": "Report Id" } }, "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 | — | The enabled value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "policyId": { "type": "string", "description": "Policy ID" }, "enabled": { "type": "boolean", "description": "The enabled value" } }, "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 | — | The enabled value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "policyId": { "type": "string", "description": "Policy ID" }, "enabled": { "type": "boolean", "description": "The enabled value" } }, "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. 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:** | Parameter | Type | Required | Default | Description | | -------------------------- | --------- | -------- | ------- | --------------------------------- | | `batchDownloadRequestList` | object\[] | Yes | — | List of up to 100 items requested | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "batchDownloadRequestList": { "type": "array", "items": { "type": "object", "properties": { "conversationId": { "type": "string", "description": "Conversation id requested" }, "recordingId": { "type": "string", "description": "Recording id requested, optional. Leave null for all recordings on the conversation" } } }, "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` | object\[] | 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 | — | The name value | | `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 | — | The type value | | `user` | object | No | — | The user value | ```json theme={null} { "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", "items": { "type": "object" }, "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": "The name value" }, "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": "The type value" }, "user": { "type": "object", "description": "The user value", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "name": { "type": "string", "description": "The name value" }, "division": { "type": "object", "description": "The division value" }, "chat": { "type": "object", "description": "The chat value" }, "department": { "type": "string", "description": "The department value" }, "email": { "type": "string", "description": "The email value" }, "primaryContactInfo": { "type": "array", "items": { "type": "object" }, "description": "Auto populated from addresses." }, "addresses": { "type": "array", "items": { "type": "object" }, "description": "Email addresses and phone numbers for this user" }, "state": { "type": "string", "description": "The current state for this user.", "enum": [ "active", "inactive", "deleted" ] }, "title": { "type": "string", "description": "The title value" }, "username": { "type": "string", "description": "The username value" }, "manager": { "type": "object", "description": "Circular schema reference: #/components/schemas/User" }, "images": { "type": "array", "items": { "type": "object" }, "description": "The images value" }, "version": { "type": "integer", "description": "Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH." }, "certifications": { "type": "array", "items": { "type": "string" }, "description": "The certifications value" }, "biography": { "type": "object", "description": "The biography value" }, "employerInfo": { "type": "object", "description": "Employer Info" }, "preferredName": { "type": "string", "description": "Preferred full name of the agent" }, "routingStatus": { "type": "object", "description": "Routing Status" }, "presence": { "type": "object", "description": "The presence value" }, "integrationPresence": { "type": "object", "description": "Integration Presence" }, "conversationSummary": { "type": "object", "description": "Conversation Summary" }, "outOfOffice": { "type": "object", "description": "Out Of Office" }, "geolocation": { "type": "object", "description": "The geolocation value" }, "station": { "type": "object", "description": "The station value" }, "authorization": { "type": "object", "description": "The authorization value" }, "profileSkills": { "type": "array", "items": { "type": "string" }, "description": "Profile skills possessed by the user" }, "locations": { "type": "array", "items": { "type": "object" }, "description": "The user placement at each site location." }, "groups": { "type": "array", "items": { "type": "object" }, "description": "The groups the user is a member of" }, "team": { "type": "object", "description": "The team value" }, "workPlanBidRanks": { "type": "object", "description": "Work Plan Bid Ranks" }, "skills": { "type": "array", "items": { "type": "object" }, "description": "Routing (ACD) skills possessed by the user" }, "languages": { "type": "array", "items": { "type": "object" }, "description": "Routing (ACD) languages possessed by the user" }, "acdAutoAnswer": { "type": "boolean", "description": "acd auto answer" }, "languagePreference": { "type": "string", "description": "preferred language by the user" }, "lastTokenIssued": { "type": "object", "description": "Last Token Issued" }, "dateLastLogin": { "type": "string", "description": "The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "dateWelcomeSent": { "type": "string", "description": "The date & time the user was sent their welcome email. 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" } }, "required": [ "version" ] } }, "required": [ "PCID", "conversationId", "recordingId" ] } ``` *** ## genesys\_recording\_post\_crossplatform\_mediaretentionpolicies Create media retention policy **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------- | | `actions` | object | No | — | The actions value | | `conditions` | object | No | — | The conditions value | | `createdDate` | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `description` | string | No | — | The description value | | `enabled` | boolean | No | — | The enabled value | | `id` | string | No | — | The globally unique identifier for the object. | | `mediaPolicies` | object | No | — | Media Policies | | `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 | — | The order value | | `policyErrors` | object | No | — | Policy Errors | | `selfUri` | string | No | — | The URI for this object | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "actions": { "type": "object", "description": "The actions value", "properties": { "retainRecording": { "type": "boolean", "description": "true to retain the recording associated with the conversation. Default = true" }, "deleteRecording": { "type": "boolean", "description": "true to delete the recording associated with the conversation. If retainRecording = true, this will be ignored. Default = false" }, "alwaysDelete": { "type": "boolean", "description": "true to delete the recording associated with the conversation regardless of the values of retainRecording or deleteRecording. Default = false" }, "assignEvaluations": { "type": "array", "items": { "type": "object" }, "description": "Assign Evaluations" }, "assignMeteredEvaluations": { "type": "array", "items": { "type": "object" }, "description": "Assign Metered Evaluations" }, "assignMeteredAssignmentByAgent": { "type": "array", "items": { "type": "object" }, "description": "Assign Metered Assignment By Agent" }, "assignCalibrations": { "type": "array", "items": { "type": "object" }, "description": "Assign Calibrations" }, "retentionDuration": { "type": "object", "description": "Retention Duration" }, "mediaTranscriptions": { "type": "array", "items": { "type": "object" }, "description": "Media Transcriptions" }, "integrationExport": { "type": "object", "description": "Integration Export" } } }, "conditions": { "type": "object", "description": "The conditions value", "properties": { "forUsers": { "type": "array", "items": { "type": "object" }, "description": "List of users to apply this policy to. Each user object can include the 'id' field containing the user's unique identifier. Example: [{\"id\":\"\"}]." }, "directions": { "type": "array", "items": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ] }, "description": "The directions value" }, "dateRanges": { "type": "array", "items": { "type": "string" }, "description": "Date Ranges" }, "mediaTypes": { "type": "array", "items": { "type": "string", "enum": [ "CALL", "CHAT" ] }, "description": "Media Types" }, "forQueues": { "type": "array", "items": { "type": "object" }, "description": "For Queues" }, "duration": { "type": "object", "description": "The duration value" }, "wrapupCodes": { "type": "array", "items": { "type": "object" }, "description": "Wrapup Codes" }, "timeAllowed": { "type": "object", "description": "Time Allowed" }, "teams": { "type": "array", "items": { "type": "object" }, "description": "Teams to match conversations against" }, "customerParticipation": { "type": "string", "description": "This condition is to filter out conversation with and without customer participation.", "enum": [ "YES", "NO" ] } } }, "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": "The description value" }, "enabled": { "type": "boolean", "description": "The enabled value" }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "mediaPolicies": { "type": "object", "description": "Media Policies", "properties": { "callPolicy": { "type": "object", "description": "Call Policy" }, "chatPolicy": { "type": "object", "description": "Chat Policy" }, "emailPolicy": { "type": "object", "description": "Email Policy" }, "messagePolicy": { "type": "object", "description": "Message Policy" } } }, "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": "The order value" }, "policyErrors": { "type": "object", "description": "Policy Errors", "properties": { "policyErrorMessages": { "type": "array", "items": { "type": "object" }, "description": "Policy Error Messages" } } }, "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 | — | Conversation Query | | `includePolicyBasedRecordings` | boolean | No | — | Whether to include policy-based recordings for the action, default value = true | | `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 | | `includeSnippetRecordings` | boolean | No | — | Whether to include snippet 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 | ```json theme={null} { "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": "Conversation Query", "properties": { "conversationFilters": { "type": "array", "items": { "type": "object" }, "description": "Filters that target conversation-level data" }, "segmentFilters": { "type": "array", "items": { "type": "object" }, "description": "Filters that target individual segments within a conversation" }, "evaluationFilters": { "type": "array", "items": { "type": "object" }, "description": "Filters that target evaluations" }, "surveyFilters": { "type": "array", "items": { "type": "object" }, "description": "Filters that target surveys" }, "resolutionFilters": { "type": "array", "items": { "type": "object" }, "description": "Filters that target resolutions" }, "order": { "type": "string", "description": "Sort the result set in ascending/descending order. Default is ascending", "enum": [ "asc", "desc", "unordered" ] }, "orderBy": { "type": "string", "description": "Specify which data element within the result set to use for sorting. The options to use as a basis for sorting the results: conversationStart, segmentStart, and segmentEnd. If not specified, the default is conversationStart", "enum": [ "conversationStart", "conversationEnd", "segmentStart", "segmentEnd" ] }, "interval": { "type": "string", "description": "Specifies the date and time range of data being queried. Results will include all conversations that had activity during the interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss" }, "limit": { "type": "integer", "description": "Specify number of results to be returned" }, "startOfDayIntervalMatching": { "type": "boolean", "description": "Add a filter to only include conversations that started after the beginning of the interval start date (UTC)" } }, "required": [ "interval" ] }, "includePolicyBasedRecordings": { "type": "boolean", "description": "Whether to include policy-based recordings for the action, default value = true" }, "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" }, "includeSnippetRecordings": { "type": "boolean", "description": "Whether to include snippet 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. | ```json theme={null} { "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 | — | The actions value | | `conditions` | object | No | — | The conditions value | | `createdDate` | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `description` | string | No | — | The description value | | `enabled` | boolean | No | — | The enabled value | | `id` | string | No | — | The globally unique identifier for the object. | | `mediaPolicies` | object | No | — | Media Policies | | `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 | — | The order value | | `policyErrors` | object | No | — | Policy Errors | | `selfUri` | string | No | — | The URI for this object | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "actions": { "type": "object", "description": "The actions value", "properties": { "retainRecording": { "type": "boolean", "description": "true to retain the recording associated with the conversation. Default = true" }, "deleteRecording": { "type": "boolean", "description": "true to delete the recording associated with the conversation. If retainRecording = true, this will be ignored. Default = false" }, "alwaysDelete": { "type": "boolean", "description": "true to delete the recording associated with the conversation regardless of the values of retainRecording or deleteRecording. Default = false" }, "assignEvaluations": { "type": "array", "items": { "type": "object" }, "description": "Assign Evaluations" }, "assignMeteredEvaluations": { "type": "array", "items": { "type": "object" }, "description": "Assign Metered Evaluations" }, "assignMeteredAssignmentByAgent": { "type": "array", "items": { "type": "object" }, "description": "Assign Metered Assignment By Agent" }, "assignCalibrations": { "type": "array", "items": { "type": "object" }, "description": "Assign Calibrations" }, "assignSurveys": { "type": "array", "items": { "type": "object" }, "description": "Assign Surveys" }, "retentionDuration": { "type": "object", "description": "Retention Duration" }, "initiateScreenRecording": { "type": "object", "description": "Initiate Screen Recording" }, "mediaTranscriptions": { "type": "array", "items": { "type": "object" }, "description": "Deprecated. The Voci and Call Journey transcription integrations are no longer supported." }, "integrationExport": { "type": "object", "description": "Integration Export" } } }, "conditions": { "type": "object", "description": "The conditions value", "properties": { "forUsers": { "type": "array", "items": { "type": "object" }, "description": "List of users to apply this policy to. Each user object can include the 'id' field containing the user's unique identifier. Example: [{\"id\":\"\"}]." }, "directions": { "type": "array", "items": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ] }, "description": "The directions value" }, "dateRanges": { "type": "array", "items": { "type": "string" }, "description": "Date Ranges" }, "mediaTypes": { "type": "array", "items": { "type": "string", "enum": [ "CALL", "CHAT" ] }, "description": "Media Types" }, "forQueues": { "type": "array", "items": { "type": "object" }, "description": "For Queues" }, "duration": { "type": "object", "description": "The duration value" }, "wrapupCodes": { "type": "array", "items": { "type": "object" }, "description": "Wrapup Codes" }, "timeAllowed": { "type": "object", "description": "Time Allowed" }, "teams": { "type": "array", "items": { "type": "object" }, "description": "Teams to match conversations against" }, "customerParticipation": { "type": "string", "description": "This condition is to filter out conversation with and without customer participation.", "enum": [ "YES", "NO" ] } } }, "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": "The description value" }, "enabled": { "type": "boolean", "description": "The enabled value" }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "mediaPolicies": { "type": "object", "description": "Media Policies", "properties": { "callPolicy": { "type": "object", "description": "Call Policy" }, "chatPolicy": { "type": "object", "description": "Chat Policy" }, "emailPolicy": { "type": "object", "description": "Email Policy" }, "messagePolicy": { "type": "object", "description": "Message Policy" } } }, "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": "The order value" }, "policyErrors": { "type": "object", "description": "Policy Errors", "properties": { "policyErrorMessages": { "type": "array", "items": { "type": "object" }, "description": "Policy Error Messages" } } }, "selfUri": { "type": "string", "description": "The URI for this object" } }, "required": [ "PCID", "name" ] } ``` *** ## genesys\_recording\_post\_recordingkeys Create encryption key ```json theme={null} { "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` | string\[] | Yes | — | This is a list of ConversationIds. The list cannot exceed 100 conversationids. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "conversationIds": { "type": "array", "items": { "type": "string" }, "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 | — | Conversation Id | | `participantJid` | string | No | — | Participant Jid | | `roomId` | string | No | — | Room Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "conversationId": { "type": "string", "description": "Conversation Id" }, "participantJid": { "type": "string", "description": "Participant Jid" }, "roomId": { "type": "string", "description": "Room Id" } }, "required": [ "PCID" ] } ``` *** ## genesys\_recording\_post\_recordings\_screensessions\_metadata Provide meta-data a screen recording. **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | --------- | -------- | ------- | --------------- | | `metaData` | object\[] | No | — | Meta Data | | `participantJid` | string | No | — | Participant Jid | | `roomId` | string | No | — | Room Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "metaData": { "type": "array", "items": { "type": "object", "properties": { "trackId": { "type": "string", "description": "Track Id" }, "mediaId": { "type": "string", "description": "Media Id" }, "screenId": { "type": "string", "description": "Screen Id" }, "originX": { "type": "integer", "format": "int32", "description": "Origin X" }, "originY": { "type": "integer", "format": "int32", "description": "Origin Y" }, "primary": { "type": "boolean", "description": "The primary value" }, "main": { "type": "boolean", "description": "The main value" } } }, "description": "Meta Data" }, "participantJid": { "type": "string", "description": "Participant Jid" }, "roomId": { "type": "string", "description": "Room Id" } }, "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 | ```json theme={null} { "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 | — | Actual Transcode Time Ms | | `annotations` | object\[] | 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 | | `associatedConversationIds` | string\[] | No | — | List of associated conversation IDs | | `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` | object\[] | No | — | Represents an email transcript | | `endTime` | string | No | — | The end time of the recording. Null when there is no playable media. | | `estimatedTranscodeTimeMs` | integer | No | — | Estimated Transcode Time Ms | | `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` | object\[] | No | — | Represents a messaging transcript | | `name` | string | No | — | The name value | | `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 | — | The path value | | `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` | object\[] | No | — | Represents a chat transcript | | `users` | object\[] | No | — | The users participating in the conversation | ```json theme={null} { "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": "Actual Transcode Time Ms" }, "annotations": { "type": "array", "items": { "type": "object", "properties": { "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)." }, "name": { "type": "string", "description": "The name value" }, "type": { "type": "string", "description": "The type value" }, "location": { "type": "integer", "format": "int64", "description": "Offset of annotation in milliseconds." }, "durationMs": { "type": "integer", "format": "int64", "description": "Duration of annotation in milliseconds." }, "absoluteLocation": { "type": "integer", "format": "int64", "description": "Offset of annotation (milliseconds) from start of recording (after removing the cumulative duration of all pauses)." }, "absoluteDurationMs": { "type": "integer", "format": "int64", "description": "Duration of annotation (milliseconds)." }, "recordingLocation": { "type": "integer", "format": "int64", "description": "Offset of annotation (milliseconds) from start of recording, adjusted for any recording cuts" }, "recordingDurationMs": { "type": "integer", "format": "int64", "description": "Duration of annotation (milliseconds), adjusted for any recording cuts." }, "user": { "type": "object", "description": "The user value" }, "description": { "type": "string", "description": "Text of annotation. Maximum character limit is 500." }, "reason": { "type": "string", "enum": [ "Hold", "SecurePause", "FlowOrQueue", "Pause" ], "description": "Reason for a pause annotation. Valid values: Hold,SecurePause,FlowOrQueue,Pause" }, "annotations": { "type": "array", "items": { "type": "object" }, "description": "List of annotations" }, "realtimeLocation": { "type": "integer", "format": "int64", "description": "Offset of annotation (milliseconds) from start of the recording before removing the cumulative duration of all pauses before this annotation" }, "selfUri": { "type": "string", "format": "uri", "description": "The URI for this object" } } }, "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" ] }, "associatedConversationIds": { "type": "array", "items": { "type": "string" }, "description": "List of associated conversation IDs" }, "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", "items": { "type": "object", "properties": { "htmlBody": { "type": "string", "description": "Html Body" }, "textBody": { "type": "string", "description": "Text Body" }, "id": { "type": "string", "description": "The id value" }, "to": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" } } }, "description": "The to value" }, "cc": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" } } }, "description": "The cc value" }, "bcc": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" } } }, "description": "The bcc value" }, "from": { "type": "object", "description": "The from value" }, "replyTo": { "type": "object", "description": "Reply To" }, "subject": { "type": "string", "description": "The subject value" }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "contentPath": { "type": "string" }, "contentType": { "type": "string" }, "attachmentId": { "type": "string" }, "contentLength": { "type": "integer" } } }, "description": "The attachments value" }, "time": { "type": "string", "format": "date-time", "description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" } } }, "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": "Estimated Transcode Time Ms" }, "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", "items": { "type": "object", "properties": { "from": { "type": "string", "description": "The message sender session id." }, "fromUser": { "type": "object", "description": "From User" }, "fromExternalContact": { "type": "object", "description": "From External Contact" }, "to": { "type": "string", "description": "The message recipient." }, "timestamp": { "type": "string", "format": "date-time", "description": "The time when the message was sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "id": { "type": "string", "description": "A globally unique identifier for this communication." }, "status": { "type": "string", "description": "Status of the message" }, "purpose": { "type": "string", "description": "A well known string that specifies the purpose or type of the participant on this communication." }, "participantId": { "type": "string", "description": "A globally unique identifier for the participant on this communication." }, "queue": { "type": "object", "description": "The queue value" }, "workflow": { "type": "object", "description": "The workflow value" }, "messageText": { "type": "string", "description": "The content of this message." }, "messageMediaAttachments": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "The location of the media, useful for retrieving it" }, "mediaType": { "type": "string", "description": "The optional internet media type of the the media object.If null then the media type should be dictated by the url." }, "contentLength": { "type": "integer", "description": "The optional content length of the the media object, in bytes." }, "name": { "type": "string", "description": "The name of the media object." }, "id": { "type": "string", "description": "A globally unique identifier for the media object." } } }, "description": "List of media objects attached with this message." }, "messageStickerAttachments": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "The location of the media, useful for retrieving it" }, "id": { "type": "string", "description": "A globally unique identifier for the media object." } } }, "description": "List of message stickers attached with this message." }, "quickReplies": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "Text to show inside the quick reply. This is also used as the response text after clicking on the quick reply." }, "payload": { "type": "string", "description": "Content of the textback payload after clicking a quick reply" }, "url": { "type": "string", "description": "The location of the image file associated with quick reply" }, "action": { "type": "string", "description": "Specifies the type of action that is triggered upon clicking the quick reply. Currently, the only supported action is \"Message\" which sends a message using the quick reply text." }, "isSelected": { "type": "boolean", "description": "Indicates if the quick reply option is selected by end customer" } } }, "description": "List of quick reply options offered with this message." }, "buttonResponse": { "type": "object", "description": "Button Response" }, "buttonResponses": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Button response type that captures Button and QuickReply type responses" }, "text": { "type": "string", "description": "Text to show inside the Button reply. This is also used as the response text after clicking on the Button." }, "payload": { "type": "string", "description": "Content of the textback payload after clicking a button" }, "messageType": { "type": "string", "description": "Button response message type that captures QuickReply , Cards and Carousel.This is used as label for Card selection" }, "originatingMessageId": { "type": "string", "description": "Reference to the ID of the original message (e.g., list picker) this button response is replying to." } } }, "description": "List of Button Response selected by user for this message." }, "story": { "type": "object", "description": "Story object." }, "cards": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "description": "Text to show in the title." }, "description": { "type": "string", "description": "Text to show in the description." }, "url": { "type": "string", "description": "URL of an image." }, "defaultAction": { "type": "object", "description": "A card action that a user can take." }, "actions": { "type": "array", "description": "List of possible action objects." } } }, "description": "List of cards offered for this message" }, "notificationTemplate": { "type": "object", "description": "Notification Template" }, "datePicker": { "type": "object", "description": "Date Picker" }, "listPicker": { "type": "object", "description": "List Picker" }, "contentType": { "type": "string", "enum": [ "QuickReply", "Story", "Card", "Carousel", "Attachment", "Location", "Notification", "GenericTemplate", "ListTemplate", "Postback", "Reactions", "Mention", "ButtonResponse", "DatePicker", "ListPicker", "InteractiveApplication", "PaymentRequest", "PaymentResponse", "Form", "RichLink", "RoadsideAssistance", "NotificationResponse" ], "description": "Indicates the content type for this message" }, "socialVisibility": { "type": "string", "enum": [ "Public", "Private" ], "description": "For social media messages, the visibility of the message in the originating social platform" }, "events": { "type": "array", "items": { "type": "object", "properties": { "eventType": { "type": "string", "description": "Type of this event element" }, "coBrowse": { "type": "object", "description": "A CoBrowse event." }, "typing": { "type": "object", "description": "A Typing event." }, "presence": { "type": "object", "description": "A Presence event." }, "video": { "type": "object", "description": "A Video event." } } }, "description": "List of event elements" }, "interactiveApplication": { "type": "object", "description": "Interactive Application" }, "paymentRequest": { "type": "object", "description": "Payment Request" }, "paymentResponse": { "type": "object", "description": "Payment Response" }, "form": { "type": "object", "description": "The form value" }, "roadsideAssistance": { "type": "object", "description": "Roadside Assistance" }, "richLink": { "type": "object", "description": "Rich Link" }, "messageReceipts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The id of the message receipt. Message receipts will have the same ID as the message they reference." }, "receiptTime": { "type": "string", "description": "Original time of the event (receipt). Example: delivery receipt time, read receipt time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "status": { "type": "string", "description": "The message receipt status" }, "reasons": { "type": "array", "description": "List of reasons for a message receipt that indicates the message has failed. Only used with Failed status." } } }, "description": "List of message receipts" } } }, "description": "Represents a messaging transcript" }, "name": { "type": "string", "description": "The name value" }, "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": "The path value" }, "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", "items": { "type": "object", "properties": { "body": { "type": "string", "description": "The message body" }, "id": { "type": "string", "description": "The id value" }, "to": { "type": "string", "description": "The message recipient" }, "from": { "type": "string", "description": "The message sender" }, "utc": { "type": "string", "description": "The utc value" }, "chat": { "type": "string", "description": "The interaction id (if available)" }, "message": { "type": "string", "description": "The message id" }, "type": { "type": "string", "description": "The type value" }, "bodyType": { "type": "string", "enum": [ "STANDARD", "ACTIVITY", "TYPING", "NOTICE", "MEMBERJOIN", "MEMBERLEAVE", "MEDIAREQUEST" ], "description": "Type of the message body (v2 chats only)" }, "senderCommunicationId": { "type": "string", "description": "Communication of sender (v2 chats only)" }, "participantPurpose": { "type": "string", "description": "Participant purpose of sender (v2 chats only)" }, "user": { "type": "object", "description": "The user value" } } }, "description": "Represents a chat transcript" }, "users": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "name": { "type": "string", "description": "The name value" }, "division": { "type": "object", "description": "The division value" }, "chat": { "type": "object", "description": "The chat value" }, "department": { "type": "string", "description": "The department value" }, "email": { "type": "string", "description": "The email value" }, "primaryContactInfo": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Email address or phone number for this contact type" }, "display": { "type": "string", "description": "Formatted version of the address property" }, "mediaType": { "type": "string" }, "type": { "type": "string" }, "extension": { "type": "string", "description": "Use internal extension instead of address. Mutually exclusive with the address field." }, "countryCode": { "type": "string" }, "integration": { "type": "string", "description": "Integration tag value if this number is associated with an external integration." } } }, "description": "Auto populated from addresses." }, "addresses": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Email address or phone number for this contact type" }, "display": { "type": "string", "description": "Formatted version of the address property" }, "mediaType": { "type": "string" }, "type": { "type": "string" }, "extension": { "type": "string", "description": "Use internal extension instead of address. Mutually exclusive with the address field." }, "countryCode": { "type": "string" }, "integration": { "type": "string", "description": "Integration tag value if this number is associated with an external integration." } } }, "description": "Email addresses and phone numbers for this user" }, "state": { "type": "string", "enum": [ "active", "inactive", "deleted" ], "description": "The current state for this user." }, "title": { "type": "string", "description": "The title value" }, "username": { "type": "string", "description": "The username value" }, "manager": { "type": "object", "description": "Circular schema reference: #/components/schemas/User" }, "images": { "type": "array", "items": { "type": "object", "properties": { "resolution": { "type": "string", "description": "Height and/or width of image. ex: 640x480 or x128" }, "imageUri": { "type": "string" } } }, "description": "The images value" }, "version": { "type": "integer", "format": "int32", "description": "Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH." }, "certifications": { "type": "array", "items": { "type": "string" }, "description": "The certifications value" }, "biography": { "type": "object", "description": "The biography value" }, "employerInfo": { "type": "object", "description": "Employer Info" }, "preferredName": { "type": "string", "description": "Preferred full name of the agent" }, "routingStatus": { "type": "object", "description": "Routing Status" }, "presence": { "type": "object", "description": "The presence value" }, "integrationPresence": { "type": "object", "description": "Integration Presence" }, "conversationSummary": { "type": "object", "description": "Conversation Summary" }, "outOfOffice": { "type": "object", "description": "Out Of Office" }, "geolocation": { "type": "object", "description": "The geolocation value" }, "station": { "type": "object", "description": "The station value" }, "authorization": { "type": "object", "description": "The authorization value" }, "profileSkills": { "type": "array", "items": { "type": "string" }, "description": "Profile skills possessed by the user" }, "locations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the location" }, "floorplanId": { "type": "string", "description": "Unique identifier for the location floorplan image" }, "coordinates": { "type": "object", "description": "Users coordinates on the floorplan. Only used when floorplanImage is set" }, "notes": { "type": "string", "description": "Optional description on the users location" }, "locationDefinition": { "type": "object" } } }, "description": "The user placement at each site location." }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "name": { "type": "string", "description": "The group name." }, "description": { "type": "string" }, "dateModified": { "type": "string", "description": "Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "memberCount": { "type": "integer", "description": "Number of members." }, "state": { "type": "string", "description": "Active, inactive, or deleted state." }, "version": { "type": "integer", "description": "Current version for this resource." }, "type": { "type": "string", "description": "Type of group." }, "images": { "type": "array" }, "addresses": { "type": "array" }, "rulesVisible": { "type": "boolean", "description": "Are membership rules visible to the person requesting to view the group" }, "visibility": { "type": "string", "description": "Who can view this group" }, "rolesEnabled": { "type": "boolean", "description": "Allow roles to be assigned to this group" }, "includeOwners": { "type": "boolean", "description": "Allow owners to be included as members of the group" }, "callsEnabled": { "type": "boolean", "description": "Allow calls to be placed to this group." }, "owners": { "type": "array", "description": "Owners of the group" }, "selfUri": { "type": "string", "description": "The URI for this object" } } }, "description": "The groups the user is a member of" }, "team": { "type": "object", "description": "The team value" }, "workPlanBidRanks": { "type": "object", "description": "Work Plan Bid Ranks" }, "skills": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "name": { "type": "string" }, "proficiency": { "type": "number", "description": "A rating from 0.0 to 5.0 that indicates how adept an agent is at a particular skill. When \"Best available skills\" is enabled for a queue in Genesys Cloud, ACD interactions in that queue are routed to agents with higher proficiency ratings." }, "state": { "type": "string", "description": "Activate or deactivate this routing skill." }, "skillUri": { "type": "string", "description": "URI to the organization skill used by this user skill." }, "selfUri": { "type": "string", "description": "The URI for this object" } } }, "description": "Routing (ACD) skills possessed by the user" }, "languages": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "name": { "type": "string" }, "proficiency": { "type": "number", "description": "A rating from 0.0 to 5.0 that indicates how fluent an agent is in a particular language. ACD interactions are routed to agents with higher proficiency ratings." }, "state": { "type": "string", "description": "Activate or deactivate this routing language." }, "languageUri": { "type": "string", "description": "URI to the organization language used by this user language." }, "selfUri": { "type": "string", "description": "The URI for this object" } } }, "description": "Routing (ACD) languages possessed by the user" }, "acdAutoAnswer": { "type": "boolean", "description": "acd auto answer" }, "languagePreference": { "type": "string", "description": "preferred language by the user" }, "lastTokenIssued": { "type": "object", "description": "Last Token Issued" }, "dateLastLogin": { "type": "string", "format": "date-time", "description": "The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "dateWelcomeSent": { "type": "string", "format": "date-time", "description": "The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "selfUri": { "type": "string", "format": "uri", "description": "The URI for this object" } }, "required": [ "version" ] }, "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` | object\[] | 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 | — | The name value | | `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 | — | The type value | | `user` | object | No | — | The user value | ```json theme={null} { "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", "items": { "type": "object" }, "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": "The name value" }, "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": "The type value" }, "user": { "type": "object", "description": "The user value", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "name": { "type": "string", "description": "The name value" }, "division": { "type": "object", "description": "The division value" }, "chat": { "type": "object", "description": "The chat value" }, "department": { "type": "string", "description": "The department value" }, "email": { "type": "string", "description": "The email value" }, "primaryContactInfo": { "type": "array", "items": { "type": "object" }, "description": "Auto populated from addresses." }, "addresses": { "type": "array", "items": { "type": "object" }, "description": "Email addresses and phone numbers for this user" }, "state": { "type": "string", "description": "The current state for this user.", "enum": [ "active", "inactive", "deleted" ] }, "title": { "type": "string", "description": "The title value" }, "username": { "type": "string", "description": "The username value" }, "manager": { "type": "object", "description": "Circular schema reference: #/components/schemas/User" }, "images": { "type": "array", "items": { "type": "object" }, "description": "The images value" }, "version": { "type": "integer", "description": "Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH." }, "certifications": { "type": "array", "items": { "type": "string" }, "description": "The certifications value" }, "biography": { "type": "object", "description": "The biography value" }, "employerInfo": { "type": "object", "description": "Employer Info" }, "preferredName": { "type": "string", "description": "Preferred full name of the agent" }, "routingStatus": { "type": "object", "description": "Routing Status" }, "presence": { "type": "object", "description": "The presence value" }, "integrationPresence": { "type": "object", "description": "Integration Presence" }, "conversationSummary": { "type": "object", "description": "Conversation Summary" }, "outOfOffice": { "type": "object", "description": "Out Of Office" }, "geolocation": { "type": "object", "description": "The geolocation value" }, "station": { "type": "object", "description": "The station value" }, "authorization": { "type": "object", "description": "The authorization value" }, "profileSkills": { "type": "array", "items": { "type": "string" }, "description": "Profile skills possessed by the user" }, "locations": { "type": "array", "items": { "type": "object" }, "description": "The user placement at each site location." }, "groups": { "type": "array", "items": { "type": "object" }, "description": "The groups the user is a member of" }, "team": { "type": "object", "description": "The team value" }, "workPlanBidRanks": { "type": "object", "description": "Work Plan Bid Ranks" }, "skills": { "type": "array", "items": { "type": "object" }, "description": "Routing (ACD) skills possessed by the user" }, "languages": { "type": "array", "items": { "type": "object" }, "description": "Routing (ACD) languages possessed by the user" }, "acdAutoAnswer": { "type": "boolean", "description": "acd auto answer" }, "languagePreference": { "type": "string", "description": "preferred language by the user" }, "lastTokenIssued": { "type": "object", "description": "Last Token Issued" }, "dateLastLogin": { "type": "string", "description": "The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "dateWelcomeSent": { "type": "string", "description": "The date & time the user was sent their welcome email. 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" } }, "required": [ "version" ] } }, "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 | — | The actions value | | `conditions` | object | No | — | The conditions value | | `createdDate` | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `description` | string | No | — | The description value | | `enabled` | boolean | No | — | The enabled value | | `id` | string | No | — | The globally unique identifier for the object. | | `mediaPolicies` | object | No | — | Media Policies | | `modifiedDate` | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `name` | string | No | — | The name value | | `order` | integer | No | — | The order value | | `policyErrors` | object | No | — | Policy Errors | | `selfUri` | string | No | — | The URI for this object | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "policyId": { "type": "string", "description": "Policy ID" }, "actions": { "type": "object", "description": "The actions value", "properties": { "retainRecording": { "type": "boolean", "description": "true to retain the recording associated with the conversation. Default = true" }, "deleteRecording": { "type": "boolean", "description": "true to delete the recording associated with the conversation. If retainRecording = true, this will be ignored. Default = false" }, "alwaysDelete": { "type": "boolean", "description": "true to delete the recording associated with the conversation regardless of the values of retainRecording or deleteRecording. Default = false" }, "assignEvaluations": { "type": "array", "items": { "type": "object" }, "description": "Assign Evaluations" }, "assignMeteredEvaluations": { "type": "array", "items": { "type": "object" }, "description": "Assign Metered Evaluations" }, "assignMeteredAssignmentByAgent": { "type": "array", "items": { "type": "object" }, "description": "Assign Metered Assignment By Agent" }, "assignCalibrations": { "type": "array", "items": { "type": "object" }, "description": "Assign Calibrations" }, "retentionDuration": { "type": "object", "description": "Retention Duration" }, "mediaTranscriptions": { "type": "array", "items": { "type": "object" }, "description": "Media Transcriptions" }, "integrationExport": { "type": "object", "description": "Integration Export" } } }, "conditions": { "type": "object", "description": "The conditions value", "properties": { "forUsers": { "type": "array", "items": { "type": "object" }, "description": "List of users to apply this policy to. Each user object can include the 'id' field containing the user's unique identifier. Example: [{\"id\":\"\"}]." }, "directions": { "type": "array", "items": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ] }, "description": "The directions value" }, "dateRanges": { "type": "array", "items": { "type": "string" }, "description": "Date Ranges" }, "mediaTypes": { "type": "array", "items": { "type": "string", "enum": [ "CALL", "CHAT" ] }, "description": "Media Types" }, "forQueues": { "type": "array", "items": { "type": "object" }, "description": "For Queues" }, "duration": { "type": "object", "description": "The duration value" }, "wrapupCodes": { "type": "array", "items": { "type": "object" }, "description": "Wrapup Codes" }, "timeAllowed": { "type": "object", "description": "Time Allowed" }, "teams": { "type": "array", "items": { "type": "object" }, "description": "Teams to match conversations against" }, "customerParticipation": { "type": "string", "description": "This condition is to filter out conversation with and without customer participation.", "enum": [ "YES", "NO" ] } } }, "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": "The description value" }, "enabled": { "type": "boolean", "description": "The enabled value" }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "mediaPolicies": { "type": "object", "description": "Media Policies", "properties": { "callPolicy": { "type": "object", "description": "Call Policy" }, "chatPolicy": { "type": "object", "description": "Chat Policy" }, "emailPolicy": { "type": "object", "description": "Email Policy" }, "messagePolicy": { "type": "object", "description": "Message Policy" } } }, "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 name value" }, "order": { "type": "integer", "description": "The order value" }, "policyErrors": { "type": "object", "description": "Policy Errors", "properties": { "policyErrorMessages": { "type": "array", "items": { "type": "object" }, "description": "Policy Error Messages" } } }, "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 | — | Job Id | | `state` | string | Yes | — | The desired state for the job to be set to. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "Job Id" }, "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 | — | The actions value | | `conditions` | object | No | — | The conditions value | | `createdDate` | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `description` | string | No | — | The description value | | `enabled` | boolean | No | — | The enabled value | | `id` | string | No | — | The globally unique identifier for the object. | | `mediaPolicies` | object | No | — | Media Policies | | `modifiedDate` | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `name` | string | No | — | The name value | | `order` | integer | No | — | The order value | | `policyErrors` | object | No | — | Policy Errors | | `selfUri` | string | No | — | The URI for this object | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "policyId": { "type": "string", "description": "Policy ID" }, "actions": { "type": "object", "description": "The actions value", "properties": { "retainRecording": { "type": "boolean", "description": "true to retain the recording associated with the conversation. Default = true" }, "deleteRecording": { "type": "boolean", "description": "true to delete the recording associated with the conversation. If retainRecording = true, this will be ignored. Default = false" }, "alwaysDelete": { "type": "boolean", "description": "true to delete the recording associated with the conversation regardless of the values of retainRecording or deleteRecording. Default = false" }, "assignEvaluations": { "type": "array", "items": { "type": "object" }, "description": "Assign Evaluations" }, "assignMeteredEvaluations": { "type": "array", "items": { "type": "object" }, "description": "Assign Metered Evaluations" }, "assignMeteredAssignmentByAgent": { "type": "array", "items": { "type": "object" }, "description": "Assign Metered Assignment By Agent" }, "assignCalibrations": { "type": "array", "items": { "type": "object" }, "description": "Assign Calibrations" }, "assignSurveys": { "type": "array", "items": { "type": "object" }, "description": "Assign Surveys" }, "retentionDuration": { "type": "object", "description": "Retention Duration" }, "initiateScreenRecording": { "type": "object", "description": "Initiate Screen Recording" }, "mediaTranscriptions": { "type": "array", "items": { "type": "object" }, "description": "Deprecated. The Voci and Call Journey transcription integrations are no longer supported." }, "integrationExport": { "type": "object", "description": "Integration Export" } } }, "conditions": { "type": "object", "description": "The conditions value", "properties": { "forUsers": { "type": "array", "items": { "type": "object" }, "description": "List of users to apply this policy to. Each user object can include the 'id' field containing the user's unique identifier. Example: [{\"id\":\"\"}]." }, "directions": { "type": "array", "items": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ] }, "description": "The directions value" }, "dateRanges": { "type": "array", "items": { "type": "string" }, "description": "Date Ranges" }, "mediaTypes": { "type": "array", "items": { "type": "string", "enum": [ "CALL", "CHAT" ] }, "description": "Media Types" }, "forQueues": { "type": "array", "items": { "type": "object" }, "description": "For Queues" }, "duration": { "type": "object", "description": "The duration value" }, "wrapupCodes": { "type": "array", "items": { "type": "object" }, "description": "Wrapup Codes" }, "timeAllowed": { "type": "object", "description": "Time Allowed" }, "teams": { "type": "array", "items": { "type": "object" }, "description": "Teams to match conversations against" }, "customerParticipation": { "type": "string", "description": "This condition is to filter out conversation with and without customer participation.", "enum": [ "YES", "NO" ] } } }, "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": "The description value" }, "enabled": { "type": "boolean", "description": "The enabled value" }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "mediaPolicies": { "type": "object", "description": "Media Policies", "properties": { "callPolicy": { "type": "object", "description": "Call Policy" }, "chatPolicy": { "type": "object", "description": "Chat Policy" }, "emailPolicy": { "type": "object", "description": "Email Policy" }, "messagePolicy": { "type": "object", "description": "Message Policy" } } }, "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 name value" }, "order": { "type": "integer", "description": "The order value" }, "policyErrors": { "type": "object", "description": "Policy Errors", "properties": { "policyErrorMessages": { "type": "array", "items": { "type": "object" }, "description": "Policy Error Messages" } } }, "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. | ```json theme={null} { "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 | — | The name value | | `period` | string | Yes | — | Value to set schedule to | | `selfUri` | string | No | — | The URI for this object | ```json theme={null} { "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": "The name value" }, "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` | string\[] | Yes | — | This is a list of ConversationIds. The list cannot exceed 100 conversationids. | ```json theme={null} { "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", "items": { "type": "string" }, "description": "This is a list of ConversationIds. The list cannot exceed 100 conversationids." } }, "required": [ "PCID", "conversationIds" ] } ``` *** ## 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 | ```json theme={null} { "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" ] } ```