UpdatePhonePreferences

POST

https://api.cbf.tcn.com/api/v1alpha1/org/preferences/phone/update

UpdatePhonePreferences updates preferences for phone dial options, call ID,
and other call properties.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "phone_preferences": {
        "org_id": "string",
        "agent_preview_dialing": true,
        "default_ring_length_threshold": 0,
        "display_ring_length_threshold": true,
        "show_caller_id": true,
        "default_use_caller_id": true,
        "override_linkback_recording": true,
        "caller_id_cfd_sid": 0,
        "default_dial_order": {
            "custom": {
                "dial_order_fields": [
                    {
                        "cfd_sid": 0,
                        "field_name": "string"
                    }
                ]
            }
        },
        "answering_machine_detection": "OPTIMIZE_MACHINE_DETECTION",
        "linkback_recording": true
    },
    "field_mask": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v1alpha1/org/preferences/phone/update' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "phone_preferences": {
        "org_id": "string",
        "agent_preview_dialing": true,
        "default_ring_length_threshold": 0,
        "display_ring_length_threshold": true,
        "show_caller_id": true,
        "default_use_caller_id": true,
        "override_linkback_recording": true,
        "caller_id_cfd_sid": 0,
        "default_dial_order": {
            "custom": {
                "dial_order_fields": [
                    {
                        "cfd_sid": 0,
                        "field_name": "string"
                    }
                ]
            }
        },
        "answering_machine_detection": "OPTIMIZE_MACHINE_DETECTION",
        "linkback_recording": true
    },
    "field_mask": "string"
}'

Responses

🟢200OK

application/json

Success

Body

Example

{}

🟢200Success

Modified at 2025-09-26 15:44:58

GetPhonePreferences

GetCompliancePreferences