# Settings

<p></p>

# Overview

The **Settings** page edits tenant-wide dialing, recording, AI, fax, API, destination, security, and call settings. Open it from **Configuration > Settings**.

The page works against the tenant currently selected in the top bar. The screenshots and demo rows were captured in the **Canistracci OIL** tenant.

<figure id="bkmrk-settings-list-page-i">![Settings list page in the Canistracci OIL tenant.](https://manual.mirtapbx.com/uploads/images/gallery/2026-06/3OJsettings-list.png)<figcaption>Settings list page in the Canistracci OIL tenant.</figcaption></figure>## Working with objects

<table id="bkmrk-taskhow-to-do-it-edi"><thead><tr><th>Task</th><th>How to do it</th></tr></thead><tbody><tr><td>Edit</td><td>Change the required settings and select Save. The page edits tenant settings directly.</td></tr><tr><td>Delete</td><td>There is no delete action for the Settings page itself. Delete actions are handled on the linked object pages.</td></tr></tbody></table>

## Page functions

<table id="bkmrk-actiondescription-ed"><thead><tr><th>Action</th><th>Description</th></tr></thead><tbody><tr><td>Edit</td><td>Runs the Edit action.</td></tr><tr><td>Speech to Text</td><td>Runs the Speech to Text action.</td></tr><tr><td>Test</td><td>Runs a test for the selected configuration.</td></tr><tr><td>Autofill</td><td>Runs the Autofill action.</td></tr><tr><td>Manage CNAM Cache</td><td>Opens the related management page.</td></tr><tr><td>Generate</td><td>Generates a value for the adjacent field.</td></tr><tr><td>Exceptions</td><td>Runs the Exceptions action.</td></tr><tr><td>Manage IP List</td><td>Opens the related management page.</td></tr><tr><td>Save</td><td>Saves the current form.</td></tr><tr><td>Manager Users</td><td>Opens the related management page.</td></tr><tr><td>Pickup group names</td><td>Runs the Pickup group names action.</td></tr><tr><td>Internal Phone Book</td><td>Runs the Internal Phone Book action.</td></tr><tr><td>Internal Routing Rules</td><td>Runs the Internal Routing Rules action.</td></tr><tr><td>Outbound PIN codes</td><td>Runs the Outbound PIN codes action.</td></tr></tbody></table>

# Edit Settings

Use this page to edit tenant-wide settings from **Configuration &gt; Settings**. The settings are stored directly for the selected tenant, so review each block before saving.

The screenshots below show the form block by block in the **Canistracci OIL** tenant.

## Form sections

<table id="bkmrk-sectiondescription-s"><thead><tr><th>Section</th><th>Description</th></tr></thead><tbody><tr><td>Settings - Canistracci Oil</td><td>Object-specific settings that change runtime behavior.</td></tr><tr><td>Dialing</td><td>Settings shown in the Dialing block.</td></tr><tr><td>Diversion field for External Agents</td><td>Agent assignment and queue membership behavior.</td></tr><tr><td>Autocreated Custom Destination</td><td>Settings shown in the Autocreated Custom Destination block.</td></tr><tr><td>Recording</td><td>Recording storage and recording-related options.</td></tr><tr><td>Voice Synthesizer</td><td>Voice calling behavior, caller handling, recording, and voice-specific limits.</td></tr><tr><td>Speech to Text</td><td>Settings shown in the Speech to Text block.</td></tr><tr><td>Generative Artificial Intelligent chat models</td><td>Settings shown in the Generative Artificial Intelligent chat models block.</td></tr><tr><td>Dial By Name Directory</td><td>Settings shown in the Dial By Name Directory block.</td></tr><tr><td>CNAM service</td><td>Settings shown in the CNAM service block.</td></tr><tr><td>Faxing</td><td>Fax handling, quality, storage, delivery, and fax-specific transport settings.</td></tr><tr><td>MS Teams integration</td><td>Settings shown in the MS Teams integration block.</td></tr><tr><td>API Interface</td><td>API-related credentials, restrictions, and integration controls.</td></tr><tr><td>Default Music On Hold</td><td>Settings shown in the Default Music On Hold block.</td></tr><tr><td>Unassigned DID destination</td><td>Settings shown in the Unassigned DID destination block.</td></tr><tr><td>General DID destination</td><td>Settings shown in the General DID destination block.</td></tr><tr><td>General Outbound destination</td><td>Settings shown in the General Outbound destination block.</td></tr><tr><td>Emergency numbers notification</td><td>Settings shown in the Emergency numbers notification block.</td></tr><tr><td>Security</td><td>Tenant security, limits, and access controls.</td></tr><tr><td>Call Settings</td><td>Object-specific settings that change runtime behavior.</td></tr><tr><td>Outbound Calls</td><td>Settings shown in the Outbound Calls block.</td></tr><tr><td>CSV Exports</td><td>Settings shown in the CSV Exports block.</td></tr><tr><td>Voicemail Settings</td><td>Voice calling behavior, caller handling, recording, and voice-specific limits.</td></tr><tr><td>Voicemail backup</td><td>Voice calling behavior, caller handling, recording, and voice-specific limits.</td></tr></tbody></table>

### Settings - Canistracci Oil

<figure id="bkmrk-settings---canistrac-1">![Settings - Canistracci Oil section on the page.](https://manual.mirtapbx.com/uploads/images/gallery/2026-06/qivsettings-page-section-1.png)<figcaption>Settings - Canistracci Oil section on the page.</figcaption></figure>Object-specific settings that change runtime behavior.

### Dialing

<figure id="bkmrk-dialing-section-on-t">![Dialing section on the page.](https://manual.mirtapbx.com/uploads/images/gallery/2026-06/73Tsettings-page-section-2.png)<figcaption>Dialing section on the page.</figcaption></figure>Settings shown in the Dialing block.

### Diversion field for External Agents

<figure id="bkmrk-diversion-field-for--1">![Diversion field for External Agents section on the page.](https://manual.mirtapbx.com/uploads/images/gallery/2026-06/Yglsettings-page-section-3.png)<figcaption>Diversion field for External Agents section on the page.</figcaption></figure>Agent assignment and queue membership behavior.

### Autocreated Custom Destination

<figure id="bkmrk-autocreated-custom-d-1">![Autocreated Custom Destination section on the page.](https://manual.mirtapbx.com/uploads/images/gallery/2026-06/HHbsettings-page-section-4.png)<figcaption>Autocreated Custom Destination section on the page.</figcaption></figure>Settings shown in the Autocreated Custom Destination block.

### Recording

<figure id="bkmrk-recording-section-on">![Recording section on the page.](https://manual.mirtapbx.com/uploads/images/gallery/2026-06/yiesettings-page-section-5.png)<figcaption>Recording section on the page.</figcaption></figure>Recording storage and recording-related options.

#### Post recording payload format

Use **Post recording** to send each completed call recording to an external HTTP endpoint after MiRTA PBX has processed the recording file. The URL can contain `%%TENANTID%%` and `%%UNIQUEID%%`; MiRTA PBX replaces them before making the HTTP request. Treat the unique id replacement as an opaque value because the current server value can include surrounding single quotes.

The request is an HTTP `POST` using `multipart/form-data`. It contains these form fields:

<table id="bkmrk-fieldcontent-dataa-j"><thead><tr><th>Field</th><th>Content</th></tr></thead><tbody><tr><td>`data`</td><td>A JSON string with recording and call metadata.</td></tr><tr><td>`file`</td><td>The recording file uploaded as `application/octet-stream`. The upload filename is the base name of the recording file.</td></tr></tbody></table>

If **Post recording header** is configured, MiRTA PBX sends it as one raw HTTP header with the request, for example `Authorization: Bearer token-value`. Leave it empty when the receiving endpoint does not require a custom header.

The `data` form field contains JSON in this format:

```
{
  "filename": "/var/spool/asterisk/monitor/example.wav",
  "format": "'wav'",
  "uniqueid": "'srv01-1710000000.123'",
  "tenant": "tenant-code",
  "tenantid": "1",
  "start": "2026-06-08 12:34:56",
  "emailrecording": "recordings@example.com",
  "src": "100",
  "realsrc": "100",
  "firstdst": "200",
  "lastdst": "200",
  "disposition": "ANSWERED",
  "clid": "\"Caller Name\" <100>",
  "size": 123456,
  "wherelanded": "200",
  "whereladedcidname": "Agent Name"
}
```

<table id="bkmrk-json-keydescription-"><thead><tr><th>JSON key</th><th>Description</th></tr></thead><tbody><tr><td>`filename`</td><td>Full local path of the processed recording file on the PBX server at the time of the POST.</td></tr><tr><td>`format`</td><td>Recording format after conversion, such as `wav`, `mp3`, or `ogg`. The current payload can include surrounding single quotes.</td></tr><tr><td>`uniqueid`</td><td>Asterisk/MiRTA PBX recording unique id. The current payload can include surrounding single quotes, so parse it as an opaque string.</td></tr><tr><td>`tenant`</td><td>Tenant code.</td></tr><tr><td>`tenantid`</td><td>Numeric tenant id.</td></tr><tr><td>`start`</td><td>Recording or call start date/time received by the upload process.</td></tr><tr><td>`emailrecording`</td><td>Email recipients configured for recording delivery, including any recipients added while the recording was running.</td></tr><tr><td>`src`</td><td>Original source caller or extension value.</td></tr><tr><td>`realsrc`</td><td>Resolved real source value used by the call flow.</td></tr><tr><td>`firstdst`</td><td>First destination dialed for the call.</td></tr><tr><td>`lastdst`</td><td>Final destination reached by the call.</td></tr><tr><td>`disposition`</td><td>Final call disposition, such as answered, busy, failed, or no answer.</td></tr><tr><td>`clid`</td><td>Caller ID string associated with the call.</td></tr><tr><td>`size`</td><td>Processed recording file size in bytes.</td></tr><tr><td>`wherelanded`</td><td>Destination or extension where the call landed, when available.</td></tr><tr><td>`whereladedcidname`</td><td>Caller ID name for the landing destination, when available. The key is currently spelled `whereladedcidname`; keep this spelling when parsing the payload.</td></tr></tbody></table>

### Voice Synthesizer

<figure id="bkmrk-voice-synthesizer-se">![Voice Synthesizer section on the page.](https://manual.mirtapbx.com/uploads/images/gallery/2026-06/H2rsettings-page-section-6.png)<figcaption>Voice Synthesizer section on the page.</figcaption></figure>Voice calling behavior, caller handling, recording, and voice-specific limits.

### Speech to Text

<figure id="bkmrk-speech-to-text-secti">![Speech to Text section on the page.](https://manual.mirtapbx.com/uploads/images/gallery/2026-06/XlIsettings-page-section-7.png)<figcaption>Speech to Text section on the page.</figcaption></figure>Settings shown in the Speech to Text block.

### Generative Artificial Intelligent chat models

<figure id="bkmrk-generative-artificia-1">![Generative Artificial Intelligent chat models section on the page.](https://manual.mirtapbx.com/uploads/images/gallery/2026-06/ZHesettings-page-section-8.png)<figcaption>Generative Artificial Intelligent chat models section on the page.</figcaption></figure>Settings shown in the Generative Artificial Intelligent chat models block.

### Dial By Name Directory

<figure id="bkmrk-dial-by-name-directo-1">![Dial By Name Directory section on the page.](https://manual.mirtapbx.com/uploads/images/gallery/2026-06/kGwsettings-page-section-9.png)<figcaption>Dial By Name Directory section on the page.</figcaption></figure>Settings shown in the Dial By Name Directory block.

### CNAM service

<figure id="bkmrk-cnam-service-section">![CNAM service section on the page.](https://manual.mirtapbx.com/uploads/images/gallery/2026-06/nvysettings-page-section-10.png)<figcaption>CNAM service section on the page.</figcaption></figure>Settings shown in the CNAM service block.

### Faxing

<figure id="bkmrk-faxing-section-on-th">![Faxing section on the page.](https://manual.mirtapbx.com/uploads/images/gallery/2026-06/1Gmsettings-page-section-11.png)<figcaption>Faxing section on the page.</figcaption></figure>Fax handling, quality, storage, delivery, and fax-specific transport settings.

### MS Teams integration

<figure id="bkmrk-ms-teams-integration-1">![MS Teams integration section on the page.](https://manual.mirtapbx.com/uploads/images/gallery/2026-06/sxlsettings-page-section-12.png)<figcaption>MS Teams integration section on the page.</figcaption></figure>Settings shown in the MS Teams integration block.

### API Interface

<figure id="bkmrk-api-interface-sectio">![API Interface section on the page.](https://manual.mirtapbx.com/uploads/images/gallery/2026-06/al8settings-page-section-13.png)<figcaption>API Interface section on the page.</figcaption></figure>API-related credentials, restrictions, and integration controls.

### Default Music On Hold

<figure id="bkmrk-default-music-on-hol-1">![Default Music On Hold section on the page.](https://manual.mirtapbx.com/uploads/images/gallery/2026-06/Hv0settings-page-section-14.png)<figcaption>Default Music On Hold section on the page.</figcaption></figure>Settings shown in the Default Music On Hold block.

### Unassigned DID destination

<figure id="bkmrk-unassigned-did-desti-1">![Unassigned DID destination section on the page.](https://manual.mirtapbx.com/uploads/images/gallery/2026-06/QOqsettings-page-section-15.png)<figcaption>Unassigned DID destination section on the page.</figcaption></figure>Settings shown in the Unassigned DID destination block.

### General DID destination

<figure id="bkmrk-general-did-destinat-1">![General DID destination section on the page.](https://manual.mirtapbx.com/uploads/images/gallery/2026-06/iuvsettings-page-section-16.png)<figcaption>General DID destination section on the page.</figcaption></figure>Settings shown in the General DID destination block.

### General Outbound destination

<figure id="bkmrk-general-outbound-des-1">![General Outbound destination section on the page.](https://manual.mirtapbx.com/uploads/images/gallery/2026-06/hHksettings-page-section-17.png)<figcaption>General Outbound destination section on the page.</figcaption></figure>Settings shown in the General Outbound destination block.

### Emergency numbers notification

<figure id="bkmrk-emergency-numbers-no-1">![Emergency numbers notification section on the page.](https://manual.mirtapbx.com/uploads/images/gallery/2026-06/tWssettings-page-section-18.png)<figcaption>Emergency numbers notification section on the page.</figcaption></figure>Settings shown in the Emergency numbers notification block.

### Security

<figure id="bkmrk-security-section-on-">![Security section on the page.](https://manual.mirtapbx.com/uploads/images/gallery/2026-06/84ysettings-page-section-19.png)<figcaption>Security section on the page.</figcaption></figure>Tenant security, limits, and access controls.

### Call Settings

<figure id="bkmrk-call-settings-sectio">![Call Settings section on the page.](https://manual.mirtapbx.com/uploads/images/gallery/2026-06/Q8Vsettings-page-section-20.png)<figcaption>Call Settings section on the page.</figcaption></figure>Object-specific settings that change runtime behavior.

### Outbound Calls

<figure id="bkmrk-outbound-calls-secti">![Outbound Calls section on the page.](https://manual.mirtapbx.com/uploads/images/gallery/2026-06/8Zisettings-page-section-21.png)<figcaption>Outbound Calls section on the page.</figcaption></figure>Settings shown in the Outbound Calls block.

### CSV Exports

<figure id="bkmrk-csv-exports-section-">![CSV Exports section on the page.](https://manual.mirtapbx.com/uploads/images/gallery/2026-06/Q9Ysettings-page-section-22.png)<figcaption>CSV Exports section on the page.</figcaption></figure>Settings shown in the CSV Exports block.

### Voicemail Settings

<figure id="bkmrk-voicemail-settings-s">![Voicemail Settings section on the page.](https://manual.mirtapbx.com/uploads/images/gallery/2026-06/ht5settings-page-section-23.png)<figcaption>Voicemail Settings section on the page.</figcaption></figure>Voice calling behavior, caller handling, recording, and voice-specific limits.

### Voicemail backup

<figure id="bkmrk-voicemail-backup-sec">![Voicemail backup section on the page.](https://manual.mirtapbx.com/uploads/images/gallery/2026-06/10tsettings-page-section-24.png)<figcaption>Voicemail backup section on the page.</figcaption></figure>Voice calling behavior, caller handling, recording, and voice-specific limits.

## Saving changes

<table id="bkmrk-taskhow-to-do-it-edi"><thead><tr><th>Task</th><th>How to do it</th></tr></thead><tbody><tr><td>Edit</td><td>Change the required tenant settings in the relevant block, then select Save.</td></tr><tr><td>Linked pages</td><td>Use the buttons inside Settings to open related management pages such as CNAM cache, manager users, routing rules, and PIN codes.</td></tr><tr><td>Delete</td><td>Settings itself is not deleted. Delete actions are handled on the linked object pages.</td></tr></tbody></table>