Get Active Recordings

Get the current active recordings, filtered by device name, directory number, username and/or numeric user ID.

Available since 2019.Winter.1.

Resource URL

GET fw/Apps/Recorder/WebAPI/LiveRecordings

Resource Information

Request Content-Type: application/json
Response Content-Type: application/json
Requires authentication: Yes
Minimum authorization level: Call Recording Complete Management (lv. 10)

URL query string Parameters

Name	Type	Required	Description	Default	Example
deviceName	string	false	The device name of the phone to be monitored	null	SEP123456789ABC
directoryNumber	string	false	The directory number of the line to be monitored	null	123456
username	string	false	The username of the user to be monitored	null	user1
numericUserId	string	false	The numeric user ID of the user to be monitored	null	654321

Note

If multiple fitlers are applied, all of them have to be met in order for an active recording to be retrieved by the service.

If no filters are specifed, the service returns the complete list of all the active recordings.

If no active recording meeting the specified filters is found, an empty JSON array is returned.

Response

200 OK

Response body

The response body is an application/json object with the following model:

Name	Type	Description
id	string	Recording unique identifier
duration	ISO 8601 duration	Recording current duration
startedAt	ISO 8601 date	Recording start time
localParty	localParty	Details about the local party, i.e. the recording owner
remoteParty	remoteParty	Details about the remote party
isPaused	boolean	True if the recording is paused, false otherwise

localParty

Name	Type	Descritpion
username	string	IAS Username

remoteParty

Name	Type	Descritpion
firstName	string	Contact first name
lastName	string	Contact last name
phoneNumber	string	Remote party phone number

Error response

401 Unauthorized

No authentication provided or wrong user credentials.

403 Forbidden

The authenticated user has no sufficient privileges to access the requested recording.

500 Internal Server Error

An error occurred while processing the request.

Examples

Successful request

In this example we retrieve the active recordings associated to directory number 123456 and username user1

GET fw/Apps/Recorder/WebAPI/LiveRecordings?directoryNumber=123456&username=user1

The response status is 200 OK, and its body is:


{
    "id": "6b98303a-b295-473a-adae-19b78aca468d",
    "duration": "PT1M13S",
    "startedAt": "2018-07-02T15:07:00.0000000",
    "localParty": {
        "username": "user1"
    },
    "remoteParty": {
        "firstName": "John",
        "lastName": "Doe",
        "phoneNumber": "+1555123456"
    },
    "isPaused": false
}