GetRecordingPreferences

GetRecordingPreferences returns all recording options for an org.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Request for GetRecordingPreferences

field_mask

string

field_mask

optional

Field mask for get request

Example

{
    "field_mask": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Response for GetRecordingPreferences

recording_preferences

object (RecordingPreferences)

recording_preferences

optional

Recording preferences object

file_name_convention

object (RecordingsFileNamingConvention)

file_name_convention

optional

Controls file naming conventions for recordings

zip_file_name_convention

object (RecordingsZipFileNamingConvention)

zip_file_name_convention

optional

Controls file naming conventions for compressed recordings

export_file_type

enum<string>

export_file_type

optional

Export audio recordings as either .mp3 or .wav

Allowed values:

RECORDING_FILE_TYPE_WAVRECORDING_FILE_TYPE_MP3

convention_enabled

boolean

convention_enabled

optional

Controls whether custom file name convention is used

zip_convention_enabled

boolean

zip_convention_enabled

optional

Controls whether custom file name convention is used (for *.zip)

call_recording_redaction

boolean

call_recording_redaction

optional

LocalMixerOptions

Example

{
    "recording_preferences": {
        "file_name_convention": {
            "inbound": {
                "segments": [
                    {
                        "segment_type": "string",
                        "format_pattern": "string",
                        "time_zone_id": "string"
                    }
                ]
            },
            "manual": {
                "segments": [
                    {
                        "segment_type": "string",
                        "format_pattern": "string",
                        "time_zone_id": "string"
                    }
                ]
            },
            "outbound": {
                "segments": [
                    {
                        "segment_type": "string",
                        "format_pattern": "string",
                        "time_zone_id": "string"
                    }
                ]
            },
            "preview": {
                "segments": [
                    {
                        "segment_type": "string",
                        "format_pattern": "string",
                        "time_zone_id": "string"
                    }
                ]
            },
            "xml_client_property_sid": 0
        },
        "zip_file_name_convention": {
            "inbound": {
                "segments": [
                    {
                        "segment_type": "string",
                        "format_pattern": "string",
                        "time_zone_id": "string"
                    }
                ]
            },
            "manual": {
                "segments": [
                    {
                        "segment_type": "string",
                        "format_pattern": "string",
                        "time_zone_id": "string"
                    }
                ]
            },
            "outbound": {
                "segments": [
                    {
                        "segment_type": "string",
                        "format_pattern": "string",
                        "time_zone_id": "string"
                    }
                ]
            },
            "combined": {
                "segments": [
                    {
                        "segment_type": "string",
                        "format_pattern": "string",
                        "time_zone_id": "string"
                    }
                ]
            },
            "xml_client_property_sid": 0
        },
        "export_file_type": "RECORDING_FILE_TYPE_WAV",
        "convention_enabled": true,
        "zip_convention_enabled": true
    },
    "call_recording_redaction": true
}

🔴500Server Error