Recording Label API

ENTIRE PAGE IS NEW

Pre-requisite

Set Elasticsearch schema v2 in Interaction Recording Web Services, to enable it to use labels and non-deletion features. For existing deployments, follow the migration steps here: Migrating an Existing Elasticsearch Deployment to Schema V2). New deployments after GIR version 8.5.2xx.xx (TBD) will have Elasticsearch schema v2 enabled by default.

Configuring permissions for recording labels

A label definition defines a label, which can then be applied to a recording. For example, a date-and-time abbreviation.

You can configure the recording permissions using Genesys Administrator Extension (GAX), or in the Configuration Manager view, the IRWS_Cluster (or WS_Cluster where applicable) application object, Agent Group object (if applicable) or the Person object.

To enable recording permissions, do this:

Add a new recording settings group to the Annex/Application options group for the IRWS_Cluster (or WS_Cluster where applicable) application object, or update the existing recording group. For details, refer to Genesys # Administrator Extension User Guide > Configuration Manager and https://docs.genesys.com/Documentation/CR/DRAFT/Solution/IRWSInstall.
Configure one or all of the following options in the recording settings as follows:

[recording]
RECORDING_PERMISSION_ADD_LABEL_DEFINITION = true
RECORDING_PERMISSION_DELETE_LABEL_DEFINITION = true
RECORDING_PERMISSION_ADD_LABEL = true
RECORDING_PERMISSION_DELETE_LABEL = true

Apply the options settings in the following order:

Default settings that are defined in the application code, which can be overridden by:
Settings that are specified in the Application, which can be overridden by:
Settings that are specified in the Agent Group(s) to which an agent belongs, which can be overridden by:
Settings that are specified in the Person object that corresponds to the agent.

<<<The following permissions are required to allow users of role supervisor or agent to be able to access and use the different label operations.>>>

Permission	Description	Applies to	Checks against
RECORDING_PERMISSION_ADD_LABEL_DEFINITION	Permission to create a label definition	Add Labels Definitions Update Existing Label Definitions	Supervisor Agent
RECORDING_PERMISSION_DELETE_LABEL_DEFINITION	Permission to delete a label definition	Delete a label definition	Supervisor Agent
RECORDING_PERMISSION_ADD_LABEL	Permission to add/update label(s) on a recording	Add Labels To Recordings Update Existing Label For Recording	Supervisor Agent
RECORDING_PERMISSION_DELETE_LABEL	Permission to delete label(s) from a recording	Delete Label From Recording	Supervisor Agent

Use this API to create and administer label definitions and label recordings.
A Label Definition provides the basic definition of a label, with a name, displayName and description.
A Label can then be added to a voice recording by referring to the name of the label definition.

Label Definitions

Creating Label Definitions

Method	Path	Required Roles	Required Permissions	Notes
POST	/api/v2/recording-label-definitions	Supervisor Agent	RECORDING_PERMISSION_ADD_LABEL_DEFINITION	Create the label definition if it does not already exist

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

FUNCTION/OPERATION

Overview

XXX

Request URL	???
HTTP method	POST??
Required features	???

Parameters

Parameter	Value
operationName	StartCallRecording

Sample

Request

POST /api/v2/me/calls/01RCC3N118B1V0SL8O7GK2LAES00000V
{
  "operationName": "StartCallRecording"
}

HTTP response

{
  "statusCode": 0
}

CometD notification

SOURCE CODE xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Contents