Edit Settings

Use this page to edit tenant-wide settings from Configuration > 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

Section	Description
Settings - Canistracci Oil	Object-specific settings that change runtime behavior.
Dialing	Settings shown in the Dialing block.
Diversion field for External Agents	Agent assignment and queue membership behavior.
Autocreated Custom Destination	Settings shown in the Autocreated Custom Destination block.
Recording	Recording storage and recording-related options.
Voice Synthesizer	Voice calling behavior, caller handling, recording, and voice-specific limits.
Speech to Text	Settings shown in the Speech to Text block.
Generative Artificial Intelligent chat models	Settings shown in the Generative Artificial Intelligent chat models block.
Dial By Name Directory	Settings shown in the Dial By Name Directory block.
CNAM service	Settings shown in the CNAM service block.
Faxing	Fax handling, quality, storage, delivery, and fax-specific transport settings.
MS Teams integration	Settings shown in the MS Teams integration block.
API Interface	API-related credentials, restrictions, and integration controls.
Default Music On Hold	Settings shown in the Default Music On Hold block.
Unassigned DID destination	Settings shown in the Unassigned DID destination block.
General DID destination	Settings shown in the General DID destination block.
General Outbound destination	Settings shown in the General Outbound destination block.
Emergency numbers notification	Settings shown in the Emergency numbers notification block.
DB Data Retention	Tenant database retention overrides for call history, recording rows, recording metadata, voicemail, fax, queue, and IVR logs.

SecurityTenant security, limits, and access controls. Call SettingsObject-specific settings that change runtime behavior. Outbound CallsSettings shown in the Outbound Calls block. CSV ExportsSettings shown in the CSV Exports block. Voicemail SettingsVoice calling behavior, caller handling, recording, and voice-specific limits. Voicemail backupVoice calling behavior, caller handling, recording, and voice-specific limits.

Settings - Canistracci Oil

Object-specific settings that change runtime behavior.

Dialing

Settings shown in the Dialing block.

Diversion field for External Agents

Agent assignment and queue membership behavior.

Autocreated Custom Destination

Settings shown in the Autocreated Custom Destination block.

Recording

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:

FieldContent dataA JSON string with recording and call metadata. fileThe recording file uploaded as application/octet-stream. The upload filename is the base name of the recording file.

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"
}

JSON keyDescription filenameFull local path of the processed recording file on the PBX server at the time of the POST. formatRecording format after conversion, such as wav, mp3, or ogg. The current payload can include surrounding single quotes. uniqueidAsterisk/MiRTA PBX recording unique id. The current payload can include surrounding single quotes, so parse it as an opaque string. tenantTenant code. tenantidNumeric tenant id. startRecording or call start date/time received by the upload process. emailrecordingEmail recipients configured for recording delivery, including any recipients added while the recording was running. srcOriginal source caller or extension value. realsrcResolved real source value used by the call flow. firstdstFirst destination dialed for the call. lastdstFinal destination reached by the call. dispositionFinal call disposition, such as answered, busy, failed, or no answer. clidCaller ID string associated with the call. sizeProcessed recording file size in bytes. wherelandedDestination or extension where the call landed, when available. whereladedcidnameCaller ID name for the landing destination, when available. The key is currently spelled whereladedcidname; keep this spelling when parsing the payload.

Voice Synthesizer

Voice calling behavior, caller handling, recording, and voice-specific limits.

Speech to Text

The Speech to Text block configures the recognition engine used by the selected tenant. The screenshots use fictional values in the Canistracci Oil tenant. Do not save these values on a production system.

Choose System Default when the tenant should inherit the global engine and credentials. Choose a specific engine when this tenant needs its own language, endpoint, credentials, model, or provider-specific options.

System Default

Settings FieldMeaningshown

EngineUse System Default to inheritin the global Speech to Text engine. This is the normal choice when all tenants share the same transcription provider. LanguageLeave as System Default to inherit the global language selection. If a tenant override is available, select the language expected for that tenant audio. Speech To Text Engine API passwordLeave empty to inherit the global secret. Fill it only when the tenant must override the credential used by the inherited engine. Minimum call time for transcriptCalls shorter than this number of seconds are not sent for transcription. This avoids sending very short recordings to the external service. Test speech recognitionUpload a WAV file and select Test to verify the currently selected engine configuration before relying on it for call transcripts.

IBM Watson TTS

FieldMeaning EngineSelects IBM Watson as the tenant Speech to Text provider. The historical engine name includes TTS, but this block is used for speech recognition. Full Endpoint URLWatson recognition endpoint, including the service instance path. Use the recognize endpoint supplied by IBM for the tenant account or service instance. LanguageRecognition model used by Watson, such as an American English broadband model. Choose the model that matches the audio language and expected bandwidth. Speech To Text Engine API usernameWatson credential username. Many IBM deployments use apikey as the username when authenticating with an API key. Speech To Text Engine API passwordWatson API key or password. The screenshot uses a fictional value. Minimum call time for transcriptMinimum recording duration, in seconds, before MiRTA PBX attempts transcription. Test speech recognitionRuns a test upload through the configured Watson settings.

Nexiwave

FieldMeaning EngineSelects Nexiwave as the tenant Speech to Text provider. LanguageLanguage sent to Nexiwave for recognition. The installed option shown in the example is English. Speech To Text Engine API usernameNexiwave account username for the tenant-specific integration. Speech To Text Engine API passwordNexiwave password or API secret. The screenshot uses a fictional value. Minimum call time for transcriptMinimum recording duration before the call is eligible for transcription. Test speech recognitionUploads a WAV file to test the configured Nexiwave credentials and language.

Google Cloud Speech to Text

FieldMeaning EngineSelects Google Cloud Speech to Text for tenant transcription. LanguageGoogle recognition language code. Choose the language that best matches the callers; the example uses English (United States). Speech To Text Engine API passwordGoogle API key used when audio is submitted directly without a storage bucket. Leave empty only when the deployment inherits the value elsewhere. JSON Service Account keyService account JSON used when audio is uploaded to Google Cloud Storage before transcription. The account must have access to the bucket. Bucket NameGoogle Cloud Storage bucket used to stage audio for transcription. The bucket must already exist and be accessible by the service account. Profanity filterControls whether Google should attempt to mask profanity in returned transcripts. Use System Default to inherit the global behavior, or force Yes or No for this tenant. Minimum call time for transcriptMinimum recording duration before MiRTA PBX sends the call to Google. Test speech recognitionUploads a WAV file and validates the Google configuration.

AssemblyAI

FieldMeaning EngineSelects AssemblyAI as the tenant Speech to Text provider. Endpoint serverAssemblyAI API host. Leave empty for the platform default, or set a host such as api.assemblyai.com when documenting or overriding the endpoint. ModelAssemblyAI model used for the transcript request. Use the stronger model when accuracy matters, or a fallback combination when availability is more important. LanguageLanguage sent to AssemblyAI. Automatic lets AssemblyAI detect the language, while a specific language restricts recognition to that language. Speech To Text Engine API passwordAssemblyAI API token. The screenshot uses a fictional value. Minimum call time for transcriptMinimum recording duration before the call is eligible for transcription. Test speech recognitionUploads a WAV file to test the AssemblyAI endpoint, model, token, and language choices.

Some installations also render AssemblyAI tuning fields for key terms and custom spelling. When present, use key terms to bias recognition toward tenant names or PBX terminology, and use custom spelling for corrections such as heard term:correct spelling.block.

GeminiAI

FieldMeaning EngineSelects GeminiAI for speech recognition through a generative AI model. ModelGemini model used for transcription. Select the model according to the required balance of speed, cost, and accuracy. Model commandInstruction sent to the model for the transcription task. Leave it empty to use the default command, or provide tenant-specific instructions such as speaker separation and terminology handling. Voicemail model commandInstruction sent to GeminiAI when transcribing voicemail messages. Leave it empty to use the regular model command, then the default command. LanguageRecognition language. The GeminiAI language list can be left at the inherited value or set to an available language option such as any language. Speech To Text Engine API passwordGemini API key. The screenshot uses a fictional value. Minimum call time for transcriptMinimum recording duration before MiRTA PBX asks GeminiAI to transcribe the call. Test speech recognitionUploads a WAV file and verifies the GeminiAI model, command, key, and language settings.

Operational Notes

Speech recognition is an external-service workflow. Confirm provider cost, privacy, retention, and data-processing requirements before enabling it for a tenant. The selected engine, language, credentials, and provider-specific fields are read when a recording is submitted for transcription. Changing these settings affects future transcription attempts. Use the test upload after changing credentials, language, endpoint, bucket, or model options. A successful test is the quickest confirmation that the tenant-level override is usable.

Generative Artificial Intelligent chat models

Settings shown in the Generative Artificial Intelligent chat models block.

Dial By Name Directory

Settings shown in the Dial By Name Directory block.

CNAM service

Settings shown in the CNAM service block.

Faxing

Fax handling, quality, storage, delivery, and fax-specific transport settings.

MS Teams integration

Settings shown in the MS Teams integration block.

API Interface

API-related credentials, restrictions, and integration controls.

Default Music On Hold

Settings shown in the Default Music On Hold block.

Unassigned DID destination

Settings shown in the Unassigned DID destination block.

General DID destination

Settings shown in the General DID destination block.

General Outbound destination

Settings shown in the General Outbound destination block.

Emergency numbers notification

Settings shown in the Emergency numbers notification block.

DB Data Retention

Use this block to override database-retention periods for the selected tenant. Empty tenant values use the corresponding Admin Settings default. The recording metadata value can be left empty to follow Recording holding days.

Field or option	Purpose
Call history days	Sets how many days tenant call history rows remain before housekeeping removes them. Leave empty to use the system default.
SMS history days	Sets how many days SMS history rows remain before cleanup. Leave empty to use the system default.
SMS retention days	Sets how long the platform keeps trying to send pending SMS messages.
Call Steps (CEL) history days	Sets how many days call steps and CEL records remain for this tenant.
Queue history days	Sets how many days queue call history remains for this tenant.
Queue history days (informative data)	Sets how many days queue informational events remain, such as no-free-agent and not-the-right-time events.
Activity log history days	Sets how many days activity log rows remain for this tenant.
Recording holding days	Sets how many days recording rows remain before housekeeping removes them.
Recording metadata holding days	Sets how many days recording metadata such as transcripts, summaries, sentiment analysis, and AI analysis details remain in rm_recordingmetadatas. Leave empty to follow Recording holding days.
Voicemail message holding days	Sets how many days voicemail messages remain before cleanup.
Fax holding days	Sets how many days fax records remain before cleanup.
IVR log holding days	Sets how many days IVR log rows remain before cleanup.

Security

Tenant security, limits, and access controls.

Call Settings

Object-specific settings that change runtime behavior.

Outbound Calls

Settings shown in the Outbound Calls block.

CSV Exports

Settings shown in the CSV Exports block.

Voicemail Settings

Voice calling behavior, caller handling, recording, and voice-specific limits.

Voicemail backup

Voice calling behavior, caller handling, recording, and voice-specific limits.

Saving changes

Task	How to do it
Edit	Change the required tenant settings in the relevant block, then select Save.
Linked pages	Use the buttons inside Settings to open related management pages such as CNAM cache, manager users, routing rules, and PIN codes.
Delete	Settings itself is not deleted. Delete actions are handled on the linked object pages.