API : PBX : Recording Consent Records
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.
When the PBX settings use opt-out consent (recording.consentMode = OPT_OUT, see PBX settings), the caller is told the call is recorded and may press 0 to refuse. A caller who does not press 0 gets a one-time record with basis set to NOT_OBJECTED and no key. That is not a consent - silence can never be consent - but it links the recordings to the caller, so they can be found and deleted like recordings made on a consent.
Every recording made on a record carries the id of the record in its consent property. Revoking a record with deleteRecordings deletes all of them, see Invalidate. The record itself is kept, as documentation that the consent was given and later withdrawn.
To let callers revoke their consent and have their recordings deleted themselves, see Self-service page for callers.
All recording consent records are deleted when the customers PBX is deleted or the customer is deleted.
| Section | Description |
|---|---|
| List | List recording consent records |
| Get | Get a recording consent record |
| Invalidate | Invalidate (revoke) a recording consent record, optionally deleting every recording made on it |
| Recordings | List the recordings made on a recording consent record |
| Self-service | How to build a self-service page where callers revoke consent and have their recordings deleted |