Recording Label API

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.

Use this API to create and administer label definitions and label recordings.

Create a new page titled Recording Label API which will be under the Interaction Recording Web Services API on the left nav bar to document Label Definitions and Adding, Updating and Deleting Labels from Recordings, described below.
Put the following text in the 2 pages:

1. Recording Label API, right after the Pre-requisites
2. https://docs.genesys.com/Documentation/CR/DRAFT/Solution/Permissions, at the beginning of the section titled "Configuring permissions for Recording Labels"

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