Skip to main content

Uniphore Help Center Portal

Test Screen Recording Configuration

Use the screen recording test configuration request to test if your screen recording configuration works.

Endpoint

Method: POST

URL: /api/screen-recording/config/test

Request Parameter

Parameter Name	Data Type	Description	Required/Optional
`id`	Number	The unique identifier for this screen recording configuration to test.	Required
`featureEnabled`	Boolean	If screen recording is enabled for the tenant.	Required
`configuratorServiceUrl`	String	The URL of the Ekisa Configurator Service to test.	Required
`screenServerUrl`	String	The URL of the Ekisa Screen Server to test.	Required
`username`	String	The username to use for Authentication with Ekisa.	Required
`password`	String	The password to use for authentication with Ekisa.	Required
`blankingText`	String	The text displayed while the screen recording is suppressed.	Optional
`samplingPercentage`	Number	The percentage of conversations to campture screen recordings for. Valid values are 0 to `100`.	Required
`createdAt`	Date/Time	When the screen recording configuration was initially added to the tenant. In the format YYYY-MM-DDTHH:MM:SS.000Z.	Optional
`updatedAt`	Date/Time	When the screen recording configuration was last updated. In the format YYYY-MM-DDTHH:MM:SS.000Z.	Optional
`groupRecordingDestination`	Array	A list of test groups to determine whose screens should be recorded. If an agent belongs to a listed group, their screen is recorded along with their calls.	Required
`ekisaIdmapping`	String	Test the method in which 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. Use 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 was tested successfully.
400	Invalid	The configuration provided is invalid. Check the request body for validation errors.
401	Unauthorized	The unauthorized specified does not provide the required access.
404	Not Found	The screen recording server configuration was not found or is invalid.
500	Internal Server Error	There was an internal server error during the connection or validation test.

Sample Request

{
      "id": 36,
      "configuratorServiceUrl": "http://00.00.00.000:0001",
      "screenServerUrl": "http://00.00.00.000:0002",
      "username": "exampleusername",
      "password": "examplepassword",
      "samplingPercentage": 80,
      "createdAt": "2025-04-30T15:46:51.156Z",
      "updatedAt": "2026-05-02T08:18:24.804Z",
      "groupRecordingDestination": [
        "Support"
      ],
      "ekisaIdMapping": "EKISA_ID_MAPPING_UNSPECIFIED"
    }

In this section: