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.

Permissions

See: Configuring Permissions for Recording Labels

Summary

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.

Request URL	HTTP method	Required features
POST	/recordings/{id}	schema-elasticsearch-v2-call-recording schema-elasticsearch-v2-screen-recording

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