Skip to main content

Uniphore Help Center Portal

Update Screen Recording Configuration

Use the screen recording update configuration request to update your system's screen recording configuration.

Endpoint

Method: PUT

URL: /api/screen-recording/config

Request Parameter

Parameter Name

Data Type

Description

Required/Optional

Id

String

Update the identifier for this screen recording configuration.

Required

featureEnabled

Boolean

Enable (true) or disable (false) screen recording for your tenant.

Optional

configuratorServiceUrl

String

Update the URL of the Ekisa Configurator Service to use.

Optional

screenServerUrl

String

Update the URL of the Ekisa Screen Server to use.

Optional

username

String

Update the username to use for Authentication with Ekisa.

Optional

password

String

Update the password to use for Authentication with Ekisa.

Optional

blankedText

String

Update the text displayed while the screen recording is suppressed.

Optional

samplingPercentage

Number

Update the percentage of conversations to campture screen recordings for. Valid values are 0 to 100.

Optional

createdAt

Array

Update the date and time for when the screen recording configuration is created. In the format YYYY-MM-DDTHH:MM:SS.000Z.

Optional

updatedAt

Array

Update the date and time for when the screen recording is updated. In the format YYYY-MM-DDTHH:MM:SS.000Z.

Optional

groupRecordingDesination

Array

Update the list of groups whose screens should be recorded. If an agent belongs to a listed group, their screen is recorded along with their calls.

Optional

ekisaIdMapping

String

Update 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.

Optional

For an example request, see Sample Request.

Response and Error Code

Response Code

Condition

Description

200

OK

The configuration has been updated successfully.

400

Invalid

The configuration was invalid or missing a valid ID in the request.

404

Not Found

The configuration was not found for the provided ID.

500

Internal Server Error

An internal server error occurred while updating the configuration.

Sample Request
{
    "id": 37,
    "featureEnabled": true,
    "configuratorServiceUrl": "http://000.000.00.000:0002",
    "screenServerUrl": "http://000.000.00.000:0003",
    "username": "exampleupdatedusername",
    "password": "exampleupdatedpassword",
    "blankingText": "Recording is Now Suppressed",
    "samplingPercentage": 85,
    "groupRecordingDestination": [
        "Sales"
    ]
}
In this section: