Get Recording

Article ID: 536

Last updated: 30 Jan, 2019

Retrieve metadata information for a (completed) recording.

Resource URL

GET fw/Apps/Recorder/WebAPI/Recordings/{id}

Resource Information

Request Content-Type: application/json
Response Content-Type: application/json
Requires authentication: Yes
Minimum authorization level: Call Recording Base Access (lv. 2)

URL Parameters

Name	Type	Required	Description	Default	Example
id	GUID	required	The id of the recording	null	75A90276-E47E-4e9e-B463-E3C743D5FF3A

Request body

None

Response

200 OK

Response body

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

Direction

Value	Description
0	The direction of the recorded call was unknown
1	The recorded call was incoming
2	The recorded call was outgoing

User

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

Note

Value	Type	Description
owner	User	User who last edited the note
text	string	The text of the note

Hash

Value	Type	Description
SHA256	string	The SHA-256 hash of the recording

Error response

400 Bad Request

Id is not a valid GUID

401 Unauthorized

No authentication provided or wrong user credentials

403 Forbidden

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

404 Not Found

Missing id or recording does not exist.

Examples

Successful request

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:


{
    "id": "75A90276-E47E-4e9e-B463-E3C743D5FF3A",
    "referenceNumber": "2017000000175",
    "pbxCallId": "32158149",
    "startTime": "2017-06-14T14:39:15.0000000+02:00",
    "duration": "PT1M31.87S",
    "direction": 2,
    "localPartyNumber": "229",
    "remotePartyNumber": "9800",
    "owner": {
        "username": "user1",
        "firstName": "John",
        "lastName": "Doe",
        "phoneNumber": "101",
        "group": "Group1",
        "department": "Sales"
    },
    "preservingUser": {
        "username": "user2",
        "firstName": "Jane",
        "lastName": "Doe",
        "phoneNumber": "102",
        "group": "Group1",
        "department": "Sales"
    },
    "note": {
        "owner": {
            "username": "user1",
            "firstName": "John",
            "lastName": "Doe",
            "phoneNumber": "101",
            "group": "Group1",
            "department": "Sales"
        },
        "text": "Ref. invoice No.1234ABC"
    },
    "size": 356112,
    "hash": {
        "SHA256": "1DDAE20272E67699E325C31C8813720B770AC04BC1604C9B3B8967FEAEE1037F"
    }
}

Request failure

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.

Article ID: 536

Last updated: 30 Jan, 2019

Revision: 14

Print Export to PDF Subscribe Share

Prev		Next
Get Recordings List		Download Recording