For the complete documentation index, see llms.txt. This page is also available as Markdown.

Cloud Speech-to-Text

Module description

The Cloud Speech-to-Text module automatically transcribes recorded MikoPBX calls and saves the completed transcripts on the PBX.

The module is fully autonomous: no separate worker application is required. If audio recordings cannot be sent to an external service, use the Local Speech To Text module.

Example of a call transcript created by the Cloud Speech-to-Text module

Requirements and compatibility

  • An active MIKO license with the cloud transcription option and a positive balance.

  • Call recording enabled for the required routes, queues, or employees.

  • Direct outbound HTTPS access to speech.mikolab.ru:443.

Installing the module

  1. Open the MikoPBX web interface. Go to Modules → Module Marketplace.

MikoPBX Module Marketplace section
  1. Find the Cloud Transcription module and install it.

The Cloud Transcription module in the Marketplace
  1. Open the list of installed modules and enable the module. Click the settings button to the right of the module version.

Enabling the module and opening its page from the installed modules list.

First launch

The setup wizard opens when you launch the module for the first time. On the first page, the module warns that selected call recordings are sent to speech.mikolab.ru for recognition. Confirm your consent by clicking Continue.

The Privacy step of the first-launch setup wizard.

At the second onboarding step, click Check connection: the module checks the service API availability, license authorization, and balance status.

The Connection step of the first-launch setup wizard.

At the next step, review the call selection rules (directions, employees, and limits). Confirm that automatic selection should be enabled and click Activate module. The first submission will occur only after an eligible recording appears.

Call selection rules in the Rules and activation step of the first-launch setup wizard.
Confirmation of automatic call selection and module activation in the Rules and activation step

Overview tab

This tab opens by default and shows the module status:

  • Processing, Transcripts, Incidents, and Balance cards with a refresh button;

  • the Successfully transcribed in the last 7 days chart, showing minutes of recognized audio by day;

  • the Recent jobs list with statuses and a link to the queue.

The module's main screen, showing the Overview tab.

Transcripts tab

This tab contains recognition results stored locally. You can filter the list by call period using the calendar or Today, and search by number, employee, or transcript text. The table shows the date, direction, counterparty, employee, status (complete or partial), duration, and update time.

The Transcripts tab in the Cloud Speech-to-Text module

Click a transcript to open its card. It contains:

  • conversation turns with timestamps and participant roles: employee/client;

  • a built-in player with playback speed controls and recording download;

  • search;

  • export to JSON or TXT;

  • transcript deletion.

Clicking a turn moves the player to the corresponding point in the recording.

A transcript card with conversation turns and the recording player.

Queue tab

This tab manages the local job queue. It provides a status filter, a period filter (1 day or all time), search by number or direction, and pagination.

Filter group
Job states

Waiting

Discovered, Waiting for recording, Ready to submit, Waiting for safe submission

Processing

Submitting, Accepted by service, Recognizing

Needs attention

Submission outcome unknown, Local failure, Service failure, Invalid result, Processing stalled, Result expired

Completed

Completed, Result discarded after deletion, Cancelled

Technical information is available for each job: job ID, run number (generation), processing stage, error code, HTTP status and network error type, CDR ID, audio size, and audio format.

Action
Availability and behavior

Cancel job

Available only before audio upload begins. No confirmation is required.

Retry job

Requires explicit confirmation of a paid action. Creates a new job generation and may cause another charge. The module does not retry jobs automatically.

Open transcript

Opens the completed transcript on the Transcripts tab.

The Queue tab in the Cloud Speech-to-Text module

Settings tab

This tab configures call recognition settings: which calls to recognize and which to skip. The parameters in each settings section are summarized below.

Directions and participants

Setting
Purpose

Process incoming calls

Whether to recognize calls received by internal extensions.

Process outgoing calls

Whether to recognize calls initiated by employees to external numbers.

Process internal calls

Whether to recognize conversations between employees.

Employees

Which employees' calls to recognize or exclude from recognition.

Number rules

Rules include or exclude numbers from processing. Each rule specifies the direction (either direction, incoming, or outgoing), match type (exact number or prefix), number, and action (include or exclude).

The Number rules settings section

Processing limits

This section also defines which calls to process and which to skip. It sets the daily limit and the number of concurrent jobs. The table below describes these settings in more detail.

Setting
Purpose

Minimum duration

Calls shorter than this value are not submitted.

Maximum duration

Calls longer than this value are not submitted.

Daily limit

How many minutes of audio can be submitted for recognition per day.

Concurrent cloud jobs

How many recordings the service recognizes simultaneously; the remaining recordings wait in the local queue.

When the daily limit of minutes is exhausted, new jobs wait until the next day. If the administrator increases the limit, submissions resume immediately.

Mode and retention

This section sets the recognition language and mode, as well as the retention period for completed transcripts.

Setting
Purpose

Recognition mode

Deferred (deferred-general) costs less, but processing a recording can take up to approximately 12 hours. Standard (general) is faster but costs more.

Recognition language

The language used to recognize the recordings.

Transcript retention

Limited (1–3650 days) or unlimited.

After the retention period expires, transcripts are deleted during scheduled daily cleanup. MikoPBX CDR records and audio recordings are not affected.

Processing limits, Mode and retention settings

Pausing processing

The Pause recording processing button in the module header temporarily stops the selection and submission of new recordings, for example during maintenance or while investigating an incident. Jobs already accepted by the service continue to be polled until completion. The Resume recording processing button returns the module to normal operation.

The button for pausing recording processing in the module header

Transcript in call history

In the MikoPBX Call history section, a call with a completed transcript provides a Call transcript dialog containing the conversation text and an Open transcript button to open it in the module.

The button for opening a call transcript from the MikoPBX call history
A transcript opened from the MikoPBX call history

Last updated

Was this helpful?