Table of Contents

API : PBX : Recording consent record get

Introduction

When a caller gives consent to have their call recorded via a Recording consent dialplan item, the consent is stored as a recording consent record.

A record is valid until its notValidAfter date and time. A one-time consent has when and notValidAfter set to the same date and time.

Request

This request will return a single recording consent record.

URL https://api.telecomx.dk/pbx/recordingconsent/records/CONSENT_RECORD_ID
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 examples

https://api.telecomx.dk/pbx/recordingconsent/records/1234567890ABCDEF12345678

Response

JSON object
Property Type Description
_id Id Unique id of the consent record.
customer Id Id of the customer the consent was given to.
when Date When the consent was given.
callerNumber String The callers phone number.
callerName String The callers name, if available. Null if not.
calleeNumber String The phone number that was called.
key String The key the caller pressed to give consent: 1 - 9.
notValidAfter Date The date and time after which the consent is no longer valid. Equal to when for one-time consents.

Example

{
  _id: '12345678901234567890ABCD',
  customer: '12345678901234567890AAAA',
  when: '2026-07-20T10:15:30.000Z',
  callerNumber: '4512345678',
  callerName: 'Anders And',
  calleeNumber: '4587654321',
  key: '1',
  notValidAfter: '2027-07-20T10:15:30.000Z'
}

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>