Knowlege base

Get Recordings List

Article ID: 628
Last updated: 27 Apr, 2022

Returns a collection of completed recordings, sorted by most recent first.

To get detailed information about a single recording use the Get Recording function.

Resource URL

GET fw/Apps/Recorder/WebAPI/Recordings

Resource Information

  • Request Content-Type: application/json
  • Response Content-Type: application/json
  • Requires authentication: Yes
  • Minimum authorization level: Call Recording Base Access

URL Parameters

Paging
Name Type Required Description Default Example
page int false The 0-based page index you want to be returned null 2
pageSize int false Number of records in a single page null 25
Filtering

This function supports filtering using the RHS colon syntax.

Name Type Operators Required Description Default Example
startTime DateTime ISO-8601 [equals], before, after, between false Filter the returned recordings according to their start time null after:2018-11-01T00:00:00Z
endTime DateTime ISO-8601 [equals], before, after, between false Filter the returned recordings according to their end time null after:2018-11-01T00:00:00Z
localPartyNumber string [equals] false Filter the recordings having given local party number null 225
remotePartyNumber string [equals], contains false Filter the recordings whose remote party number is or contains given value null contains:+39
ownerUsername string [equals] false Filter the recordings of the given user null john_doe
direction Direction [equals] false Filter the recordings having given direction null 1
Direction
Value Description
0 The direction of the recorded call was unknown
1 The recorded call was incoming
2 The recorded call was outgoing

Request body

None

Response

200 OK

Response body

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

Name Type Description
totalCount int The total number of recordings that match given filters
recordings Recording[] An array containing the requested recordings page or all the matching recordings if no paging is requested 
Recording
Name Type Description
id GUID The identifier of the recording
referenceNumber string A unique, friendly, identifier generated by Imagicle Call Recording of the recording
startTime DateTime ISO-8601 Date and time when the recording begun
duration Duration ISO-8601 Duration of the recording
direction Direction Direction of the recorded call (0: unknown, 1: incoming, 2: outgoing)
ownerUsername string The username of the user who recorded the call
localPartyNumber string The telephone number of the phone recording the call
remotePartyNumber string The telephone number remote party
Error response

400 Bad Request

One or more of the given parameters are invalid

Response body
Name Type Description
reason BadRequestReason The reason why the request has been rejected
message string A human readable message
BadRequestReason
Value Description
0 Some filtering parameters are invalid
1 Some paging parameters are invalid

401 Unauthorized

No authentication provided or wrong user credentials

403 Forbidden

The authenticated user has not sufficient privileges

500 Internal Server Error

An unexpected error occurred

504 Gateway Timeout

When the Call Recording service is down

Examples

Successful request

In this example we request the second page of size 2 of all the recordings of the incoming calls started on the 1st of November 2018 and whose remote party number contains "02":

GET fw/Apps/Recorder/WebAPI/Recordings?page=1&pageSize=2&startTime=between:2018-11-01T00:00:00Z;2018-11-02T00:00:00Z&remotePartyNumber=contains:02&direction=1

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


{
    "totalCount": 50,
    "recordings": [
        {
            "id": "75A90276-E47E-4e9e-B463-E3C743D5FF3A",
            "referenceNumber": "2017000000175",
            "startTime": "2018-11-01T16:39:15.0000000+02:00",
            "duration": "PT1M31.87S",
            "direction": 1,
            "localPartyNumber": "229",
            "remotePartyNumber": "980200",
            "ownerUsername": "user1"
        },
        {
            "id": "966B4AF0-CC56-4724-A640-7025142652EF",
            "referenceNumber": "2017000000193",
            "startTime": "2018-11-01T10:20:59.0000000+01:00",
            "duration": "PT2M20.65S",
            "direction": 1,
            "localPartyNumber": "132",
            "remotePartyNumber": "+390244548866",
            "ownerUsername": "user2"
        }
    ]
}

Request failure

In this example we try to filter the recordings with invalid filters:

GET fw/Apps/Recorder/WebAPI/Recordings?startTime=before:2018/45/01&direction=5

The response status is 400 BadRequest.

Article ID: 628
Last updated: 27 Apr, 2022
Revision: 36
Views: 1030
Print Export to PDF Subscribe Share
Prev   Next
Stop Recording     Get Recording