Retrieve metadata information for a (completed) recording.
GET fw/Apps/Recorder/WebAPI/Recordings/{id}
Name | Type | Required | Description | Default | Example |
---|---|---|---|---|---|
id | GUID | required | The id of the recording | null | 75A90276-E47E-4e9e-B463-E3C743D5FF3A |
None
The response body is an application/json object with the following model:
Name | Type | Description |
---|---|---|
id | string | The identifier of the recording |
referenceNumber | string | A unique, friendly, identifier generated by Imagicle Call Recording of the recording |
pbxCallId | string | Number provided by the PBX to identify recordings which belong to the same conversation |
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 |
localPartyNumber | string | The telephone number of the IP phone recording the call |
remotePartyNumber | string | The telephone number remote party |
owner | User | The user who recorded the call |
preservingUser | User | The user who preserved the call (if any) |
note | Note | User's defined note for the recording |
size | long | Size in bytes of the recording |
hash | Hash | Hash that uniquely identify the recording |
Value | Description |
---|---|
0 | The direction of the recorded call was unknown |
1 | The recorded call was incoming |
2 | The recorded call was outgoing |
Value | Type | Description |
---|---|---|
username | string | IAS username |
firstName | string | The first name of the user |
lastName | string | The last name of the user |
phoneNumber | string | The primary extension of the user |
group | string | The name of the recording group of the user |
department | string | The name of the department of the user |
Value | Type | Description |
---|---|---|
owner | User | User who last edited the note |
text | string | The text of the note |
Value | Type | Description |
---|---|---|
SHA256 | string | The SHA-256 hash of the recording |
Id is not a valid GUID
No authentication provided or wrong user credentials
The authenticated user has no sufficient privileges to access the requested recording.
Missing id or recording does not exist.
In this example we get metdata of the recording having id "75A90276-E47E-4e9e-B463-E3C743D5FF3A":
GET fw/Apps/Recorder/WebAPI/Recordings/75A90276-E47E-4e9e-B463-E3C743D5FF3A
The response status is 200 Ok, and its body is:
In this example we try to get metadata of a recording that doesn't exist anymore:
GET fw/Apps/Recorder/WebAPI/Recordings/014309c0-cc7c-4be1-b6ee-6011a67441aa
The response status is 404 NotFound.