Skip to main content

Uniphore Help Center Portal

Create Screen Recording Configuration

Use the screen recording create configuration request to configure screen recording for your system.

Endpoint

Method: POST

URL: /api/screen-recording/config

Request Parameter

Parameter Name	Data Type	Description	Required/Optional
`Id`	Number	An identifier for this screen recording configuration. If this parameter is not included in the request the system automatically generates one.	Optional
`featureEnables`	Boolean	Set to `true` to enable screen recording.	Required
`configuratorServiceUrl`	String	Enter the URL of the Ekisa Configurator Service to use.	Required
`screenServerUrl`	String	Enter the URL of the Ekisa Screen Server to use.	Required
`username`	String	Enter the username to use for Authentication with Ekisa.	Required
`password`	String	Enter the password to use for Authentication with Ekisa.	Required
`blankingText`	String	Determine the text displayed while the screen recording is suppressed.	Optional
`samplingPercentage`	Number	Determine the percentage of conversations to campture screen recordings for. Valid values are 0 to `100`.	Required
`createdAt`	Array	Enter the date and time for when the screen recording configuration is created. In the format YYYY-MM-DDTHH:MM:SS.000Z.	Optional
`updatedAt`	Array	Enter the date and time for when the screen recording is updated. In the format YYYY-MM-DDTHH:MM:SS.000Z.	Optional
`groupRecordingDestination`	Array	Determine which groups whose screens should be recorded. If an agent belongs to a listed group, their screen is recorded along with their calls.	Required
`ekisaIdmapping`	String	Determine how screen recording is triggered on Ekisa workstations. When a call starts, the system uses this mapping to determine what Agent metadata (that matches workstation metadata) to send to Ekisa to trigger recording on the workstation. Set to one of the following values: `EKISA_ID_MAPPING_AGENT_NUMBER` - Uses the agent number. `EKISA_ID_MAPPING_AGENT_NICKNAME` - Uses the Agent alias (nickname). `EKISA_ID_MAPPING_UNSPECIFIED` - Isn't specified, defaults to use agent number.	Required

For an example request, see Sample Request.

Response and Error Code

Response Code	Condition	Description
200	OK	Screen recording configuration has been added to the tenant.
400	Invalid	The configuration provided is invalid. Check the request body for errors.
409	Conflict	A screen recording configuration already exists for the tenant. Use the GET request to view the current configuration, click here for details. Use the PUT request to update the configuration, click here for details.
500	Internal Server Error	An internal server error occurred while adding the screen recording configuration to the tenant.

Sample Request

{
    "id": 36,
    "featureEnabled": true,
    "configuratorServiceUrl": "http://000.000.00.000:0000",
    "screenServerUrl": "http://000.000.00.000:0001",
    "username": "exampleusername",
    "password": "examplepassword",
    "blankingText": "Recording is Suppressed",
    "samplingPercentage": 80,
    "groupRecordingDestination": [
        "Support"
    ]
}

In this section: