Get Screen Recording Configuration

Use the screen recording get configuration request to view your tenant's current screen recording configuration.

Endpoint

Method: GET

URL: /api/screen-recording/config

Note

Unlike other API requests, the get configuration request does not require any body or header parameters beyond authentication.

Response and Error Code

Response Code	Condition	Description
200	OK	Returns the tenant's screen recording configuration.
404	Not Found	No screen recording configuration was found for the tenant.
500	Internal Server Error	An internal server error occurred while retrieving the tenant's screen recording configuration.

Response Parameter

Parameter Name	Data Type	Description
`configurations`	Array	An array that details the screen recording configuration for your tenant, consisting of the following parameters in this table.
`id`	Number	The unique identifier for this screen recording configuration.
`featureEnabled`	Boolean	If screen recording is enabled for the tenant.
`configuratorServiceUrl`	String	The URL of the Ekisa Configurator Service.
`screenServerUrl`	String	The URL of the Ekisa Screen Server.
`username`	String	The username to use for Authentication with Ekisa.
`password`	String	The password to use for authentication with Ekisa.
`blankingText`	String	The text displayed while the screen recording is suppressed.
`samplingPercentage`	Number	The percentage of conversations to campture screen recordings for. Valid values are 0 to `100`.
`CreatedAt`	Date/Time	When the screen recording configuration was initially added to the tenant. In the format YYYY-MM-DDTHH:MM:SS.000Z.
`UpdatedAt`	Date/Time	When the screen recording configuration was last updated. In the format YYYY-MM-DDTHH:MM:SS.000Z.
`groupRecordingDestination`	Array	A list of groups that determine whose screens should be recorded. If an agent belongs to a listed group, their screen is recorded along with their calls.
`ekisaIdmapping`	String	Determines 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. The following values are used: `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.

For an example successful response, see Sample Response.

Sample Response

{
  "configurations": [
    {
      "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:

Uniphore Help Center Portal