Skip to content
vocapable.Docs

Every line's recording policy

GET
/v1/mobile/workspace/recording-policies
curl --request GET \
  --url https://api.vocapable.com/v1/mobile/workspace/recording-policies \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceLineRecordingPolicies
object
data
required
Data
Array<object>
WorkspaceLineRecordingPolicy
object
line_id
required
Line Id
string
line_name
required
Line Name
string
mode
required
Mode
string
Allowed values: off record_all on_demand
announcement_text
required
Announcement Text
string
announcement_voice
required
Announcement Voice
string
Allowed values: receptionist carrier
receptionist_voice_available
required
Receptionist Voice Available
boolean
retention_days
required
Retention Days
integer
retention_max_days
required
Retention Max Days
integer
opt_out_digit
Any of:
string
Allowed values: 3 4 5 6 7 8
notice
required
WorkspaceRecordingNotice
object
version
required
Version
string
text
required
Text
string
accepted_version
required
Any of:
string
accepted_at
required
Any of:
string format: date-time
accepted_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
staff
required
WorkspaceRecordingStaffControls

What staff decided for the company (E6-R11), shown read-only to the owner.

object
force_announce_all
required
Force Announce All
boolean
recording_disabled
required
Recording Disabled
boolean
max_retention_days
required
Max Retention Days
integer
reason
required
Any of:
string
announces_on_every_call
required
Announces On Every Call
boolean
covers_monitoring
required
Covers Monitoring
boolean
supervision_enabled
required
Supervision Enabled
boolean
announcements
required
Announcements
Array<object>
WorkspaceAnnouncementText
object
kind
required
Kind
string
Allowed values: greeting answer mid_call paused resumed
text
required
Text
string
voiced
required
Voiced
boolean
covers_monitoring
required
Covers Monitoring
boolean
limitations
required
Limitations
Array<string>
revision
required
Revision
integer
updated_at
required
Any of:
string format: date-time
updated_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
consent
required
WorkspaceRecordingConsentFacts

The versioned all-party state list, the processors, and the notice version.

object
states_version
required
States Version
string
states
required
States
Array<object>
WorkspaceAllPartyState
object
code
required
Code
string
name
required
Name
string
citation
required
Citation
string
note
required
Note
string
processors
required
Processors
Array<object>
WorkspaceProcessorCategory

A category of processor that touches call audio (E6-R10, Apple 5.1.2(i)).

object
category
required
Category
string
Allowed values: carrier storage speech_to_text language_model
description
required
Description
string
notice_version
required
Notice Version
string
area_code_rule
required
Area Code Rule
string
Example
{
  "data": [
    {
      "mode": "off",
      "announcement_voice": "receptionist",
      "opt_out_digit": "3",
      "announcements": [
        {
          "kind": "greeting"
        }
      ]
    }
  ],
  "consent": {
    "processors": [
      {
        "category": "carrier"
      }
    ]
  }
}