api:pbx:recordingconsentrecords:recordings
Table of Contents
API : PBX : Recording consent record recordings
Introduction
Every recording made on a recording consent record carries the id of the record in its consent property. This request lists those recordings, for example to see what revoking with deleteRecordings would delete.
A recording the requesting user may not open is listed as existing and nothing more: date, length and whose recording it is - no phone numbers, transcription, AI summary or link. The rule is the same as for getting a recording: a common (PBX wide) recording may be opened by VIEWER and above, a personal recording only by the employee who owns it.
Request
| URL | https://api.telecomx.dk/pbx/recordingconsent/records/CONSENT_RECORD_ID/recordings | |
|---|---|---|
| Method | GET | |
| Access level | VIEWER, MANAGER or OWNER if the record belongs to the users own customer. RESELLER if the customer belongs to the reseller. RESELLER_ADMIN. ADMIN. |
|
| Param | CONSENT_RECORD_ID | Id of the consent record (24 hex-char string) |
| Query | offset | [optional] Index of the first recording to return, default 0. |
| limit | [optional] The number of recordings to return, default 100, min 1, max 1000. |
|
Query examples
https://api.telecomx.dk/pbx/recordingconsent/records/1234567890ABCDEF12345678/recordings https://api.telecomx.dk/pbx/recordingconsent/records/1234567890ABCDEF12345678/recordings?limit=20&offset=20
Response
The recordings are returned newest first.
| JSON object | ||
|---|---|---|
| Property | Type | Description |
| count | Number | Number of recordings made on the consent, regardless of offset and limit. |
| recordings | Array | The recordings, see below. |
| Recording object | ||
|---|---|---|
| Property | Type | Description |
| _id | Id | Id of the recording. |
| date | Date | When the recording was made. |
| length | Number | Length of the recording in seconds. |
| employee | Object | The employee who owns the recording: _id and name. Null for a common (PBX wide) recording. |
| access | Boolean | True if the requesting user may open the recording with Get recording. |
Example
{ count: 2, recordings: [ { _id: '1234567890ABCDEF1234AAAA', date: '2026-09-20T08:00:00.000Z', length: 184, employee: { _id: '1234567890ABCDEF1234BBBB', name: 'Anne Hansen' }, access: false }, { _id: '1234567890ABCDEF1234CCCC', date: '2026-09-19T14:12:00.000Z', length: 61, employee: null, access: true } ] }
Errors
| Error code | Message | Description |
|---|---|---|
| 400 | invalid_data | Id is not a valid ObjectId |
| 403 | access_denied | Insufficient access level |
| 404 | not_found | Recording consent record not found |
| 500 | internal_error | <Unspecified> |
api/pbx/recordingconsentrecords/recordings.txt · Last modified: by Telecom X AI