Returns a collection of completed recordings, sorted by most recent first.
To get detailed information about a single recording use the Get Recording function.
GET fw/Apps/Recorder/WebAPI/Recordings
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 |
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 |
Value | Description |
---|---|
0 | The direction of the recorded call was unknown |
1 | The recorded call was incoming |
2 | The recorded call was outgoing |
None
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 |
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 |
One or more of the given parameters are invalid
Name | Type | Description |
---|---|---|
reason | BadRequestReason | The reason why the request has been rejected |
message | string | A human readable message |
Value | Description |
---|---|
0 | Some filtering parameters are invalid |
1 | Some paging parameters are invalid |
No authentication provided or wrong user credentials
The authenticated user has not sufficient privileges
An unexpected error occurred
When the Call Recording service is down
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:
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.