Global settings

Read and write account-level settings (v2 manager API). Available as mgr.settings / mgr.Settings / mgr.settings, grouped by scope.

Groups: app (customerLogging, conversations, integrations, agentStatus), telephony (agentInbound, agentOutbound, agentRecording, agentWrapup, postCall), audit (default), ui (i18n), retention (periods), auth (refreshToken — see Refresh tokens).

In TypeScript and Go each group is read/written as its data payload — the SDK handles the { scope, key } envelope. In Rust each section is a flat mgr.settings.<scope>_<section>() reader and a set_<scope>_<section>(..) writer that return the section's typed response (read its item.data).

Read a setting

TypeScript

const recording = await mgr.settings.telephony.agentRecording.get();
console.log(recording.alwaysRecordOutbound);

const i18n = await mgr.settings.ui.i18n.get();

Go

recording, err := mgr.Settings.Telephony.AgentRecording.Get(ctx)
// recording.AlwaysRecordOutbound ...

i18n, _ := mgr.Settings.Ui.I18n.Get(ctx)

Rust

let recording = mgr.settings.telephony_agent_recording().await?;
// recording.item.data ...

let i18n = mgr.settings.ui_i18n().await?;

Update a setting

update returns the new value. The update payload is the request type (all fields optional, so you can send just what you want to change).

TypeScript

const updated = await mgr.settings.app.customerLogging.update({ enabled: true });

await mgr.settings.telephony.agentWrapup.update({
  cancelWrapUp: true,
  maxExtension: 30,
});

Go

enabled := true
_, _ = mgr.Settings.App.CustomerLogging.Update(ctx, managerapi.SettingsAppCustomerLoggingRequestData{
    Enabled: &enabled,
})

cancel, maxExt := true, 30
_, _ = mgr.Settings.Telephony.AgentWrapup.Update(ctx, managerapi.SettingsTelephonyAgentWrapupRequestData{
    CancelWrapUp: &cancel,
    MaxExtension: &maxExt,
})

Rust

mgr.settings.set_app_customer_logging(/* SettingsAppCustomerLoggingRequest */).await?;
mgr.settings.set_telephony_agent_wrapup(/* SettingsTelephonyAgentWrapupRequest */).await?;

Outbound calls during wrap-up

telephony/agent.wrapup has allowOutboundDuringWrapUp (off by default). When it is on, an agent in wrap-up may place an outbound call: the call ends the wrap-up and the agent goes straight to the call. When it is off, an outbound call from wrap-up is refused, as before. A backend that predates the setting leaves the field out of its answer, so treat a missing value as off.

TypeScript

const wrapup = await mgr.settings.telephony.agentWrapup.get();
await mgr.settings.telephony.agentWrapup.update({ ...wrapup, allowOutboundDuringWrapUp: true });

Go

allow := true
_, _ = mgr.Settings.Telephony.AgentWrapup.Update(ctx, managerapi.SettingsTelephonyAgentWrapupRequestData{
    AllowOutboundDuringWrapUp: &allow,
})

Rust

mgr.settings.set_telephony_agent_wrapup(/* SettingsTelephonyAgentWrapupRequest, data.allow_outbound_during_wrap_up = Some(true) */).await?;

List & clear settings generically

Beyond the typed section accessors, you can list or clear settings by scope/key without knowing the section type — useful for admin tooling that walks the whole configuration.

TypeScript

const all = await mgr.settings.listAll();
const appScope = await mgr.settings.listInScope("app");
await mgr.settings.clear("app", "customer.logging");
await mgr.settings.clearInScope("telephony");
await mgr.settings.clearAll();

Go

all, _ := mgr.Settings.ListAll(ctx)
appScope, _ := mgr.Settings.ListInScope(ctx, "app")
_, _ = mgr.Settings.Clear(ctx, "app", "customer.logging")
_, _ = mgr.Settings.ClearInScope(ctx, "telephony")
_, _ = mgr.Settings.ClearAll(ctx)

Rust

let all = mgr.settings.list_all().await?;
let app_scope = mgr.settings.list_in_scope("app").await?;
mgr.settings.clear("app", "customer.logging").await?;
mgr.settings.clear_in_scope("telephony").await?;
mgr.settings.clear_all().await?;

Reference

• REST API reference