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

REST API

Описание маршуртов

Модуль позволяет получать готовые расшифровки и совершать другие действия с помощью REST API. Это может быть полезно для интеграций в сторонние ресурсы. Ниже приведена вся самая важная информация по REST API. Базовый путь:

/pbxcore/api/v3/module-cloud-speech-to-text
Назначение
Endpoint

Сводка и состояние

GET /dashboard, GET /health

Правила отбора

GET/PATCH /rule-sets/current

Режим и хранение

GET/PATCH /settings

Проверка подключения

POST /connection-checks

Управление обработкой

GET/PATCH /processing-controls

Очередь задач

GET /jobs

Отмена и повтор задачи

POST /job-cancellations

Список транскриптов

GET /transcripts

Экспорт транскрипта

GET /transcript-exports/{id}

Журнал модуля

GET /logs

Диагностические архивы

GET/POST /diagnostic-reports

Поиск транскрипта по звонку

GET /cdr-transcript-lookups

Интеграции: call-transcripts

Внешние модули читают готовые транскрипты через два выделенных ресурса — GET /call-transcripts и GET /call-transcript-events. Эти ресурсы принимают только специальный ключ интеграции и отдают полный неизменяемый контракт расшифровки: сегменты, объединенные реплики и простой текст.

Идентификация построена так, чтобы после чистой переустановки модуля внешняя система не пересчитывала анализ заново:

  • call_id — стабильный идентификатор звонка Asterisk (linkedid, либо UNIQUEID, когда linkedid пуст);

  • source_instance_id — идентификатор установки модуля;

  • semantic_hash — хеш содержимого расшифровки по профилю call-transcript-analysis-v1: совпадает, только если текст, участники и тайминги не изменились.

События call-transcript.completed, call-transcript.updated и call-transcript.deleted выдаются курсорной выдачей и идемпотентны. Публичная схема контракта — call-transcript.v1. После удаления транскрипта события больше не раскрывают call_id и хеши.

Last updated

Was this helpful?