Overview

The Face-to-Face Interaction Recorder API is a collection of RESTful web services for recording audio and screen activity from a laptop or desktop computer. It exposes recording control and tagging capabilities to third-party applications running on the local desktop.

Use this API to start, stop, pause, resume, and tag audio and screen activity recorded through your microphone, speaker, and screen.

Features

You can use the API to control the Face-to-Face Interaction Recorder application. You can also use it in conjunction with the Face-to-Face Interaction Recorder User Interface (UI) to augment the recording process, for example, by providing a customer account number or other information from a third-party application on the desktop. With this API you can:

Start and stop the recording process.
Media can be independently controlled by the API. For example, you can start audio recording, start screen recording, start both, stop audio, stop screen, or stop both.

Avoid these operations if you are using the Face-to-Face Interaction Recorder UI to control the recording process, to prevent a conflict between the application and the API.
Pause and resume the recording of different media.
Tag recordings with supplemental data.
The system automatically tags recordings with default system information, but extra data from third-party applications can also be tagged with the API. For example, you can tag a recording with the customer name, telephone number, account number, or other information.
Get the status of the currently active recording.
You can query whether the recording is still in progress (Active), is paused, has stopped (Closed), or if it is in a wrap-up phase.
Get the status of the Face-to-Face Interaction Recorder application.
You can find out whether the application is recording or not, or if it is in an error state.
Select recording type.
You can specify if the audio is to be recorded from the microphone or the speaker device.

HTTP Headers

The Face-to-Face Interaction Recorder API uses the following content types:

Content-Type: application/json
Accept: application/json

Limitations

When the API starts recording, it is not possible to control or tag recordings through the user interface. Conversely, when a user starts recording through the user interface, the API can tag recordings, but not stop, pause, or resume.