Add the AWS S3 recording bulk actions integration
You can export recordings, screen recordings, attachments and metadata, in bulk and store them in a configured S3 bucket.
To add the integration:
- Click Admin.
- Under Integrations, click Integrations.
- Click the Integration button.
- Select AWS S3 Recording Bulk Actions Integration and click Install.
- Click the Configuration tab.
- Enter the name of the S3 bucket you created.
- Optional: Enter a public key.
- Click the Credentials tab.
- Click Configure.
- The Configure Credentials dialog box appears.
- Enter the following information:
- Role ARN: The role in your AWS account that has access to your AWS S3 bucket. This credential allows Genesys Cloud to access the AWS S3 bucket associated with this role.
- Click OK.
- Click Save. A list of all integrations that you have installed appears.
- Enter the following information:
- Activate the integration.
Note: If you do not activate the integration, then any recording bulk actions associated with the integration will not appear in Genesys Cloud applications.
The integration is now active. You can edit, deactivate, or delete an installed integration. For more information, see Edit, deactivate, or delete an integration. - Create or edit a policy and enable Export Recording with Integration.
The structure of the file content that is exported into the S3 bucket includes the following metadata fields. The S3 bucket can be found in the following folder structure:
s3://{remoteBucket}/{organizationId}/year={year}/{month={month}/day={day}/hour={hourOfDay}/conversation_id={conversationId}/
Metadata field | Description |
---|---|
aniDisplayable |
Displayed ANI |
aniNormalized |
ANI |
conversationEndTime |
Conversation end time |
conversationStartTime |
Conversation start time |
dnisDisplayable |
Displayed DNIS |
dnisNormalized |
DNIS |
durationMs |
Recording duration |
endTime |
Recording end time |
filePath |
Original recording path |
fileSize |
Recording file size |
initialDirection |
Initial direction of the conversation (inbound/outbound) |
languageIds |
Language identifier |
mediaType |
Media Type (call, chat, email, message, callback, or screen) |
messageType |
The message platform from which the message originated. For example, sms, twitter, line, facebook, whatsapp, web messaging, open, or instagram. |
organizationId |
Unique conversation ID |
provider |
Recording provider. For example, edge. |
queueIds |
Recording queue IDs |
recordingId |
Unique recording ID |
screenInformation |
Screen specific information. For example, screen ID, X and Y position, and resolution information. |
startTime |
Recording start time |
userIds |
User list |
wrapupCodes |
Conversation wrap-up codes |
- Exported recordings are exported using standard storage class.
- You can export archived recordings, but the process will take many hours to complete.
- Orphan recordings are not exported unless the recording is recovered later.
- Genesys Cloud exports recordings one time. If you create an export that matches a recording that has already been exported, that recording will be skipped.
- A Genesys Cloud organization can only have a single instance of this integration active at a time.
- If you configure a recording to be exported and deleted at the same time, the recording will first be exported and then deleted.
- For the query parameters pageNumber and pageSize, values that are not valid are changed to the default values.