Appearance
Recording policy
Whether calls are recorded is decided at three levels: your account's default, a tenant's settings.recording.enabled, and a line's recording_enabled. A level that doesn't choose (null or omitted) follows the one above it, and a level that sets enforced decides for every level below it, whatever they chose (their own choices are kept for when it stops).
| Method | Path | Body | Response |
|---|---|---|---|
GET | /v1/recording-policy | — | { recordingPolicy: { enabled, enforced } } |
PUT | /v1/recording-policy | { enabled, enforced? } | { recordingPolicy } |
enabled(required, default for a new accountfalse): whether calls are recorded where no tenant or line says otherwise.enforced(omitted =false):truerecords (or doesn't) every call of every tenant and line asenabledsays.
Tenants and lines report what applies to them as recording: { enabled, from, enforcedBy }: from is the level that decided (CONSUMER, TENANT or LINE), enforcedBy the level that doesn't let the ones below choose, or null. A recording also needs the tenant's storage quota; the line's call otherwise ends with recording.failed.