api:pbx:recording:transcribeauto
Table of Contents
API : PBX : Recording Transcribe Auto (M2M)
Request
This request is invoked by the PBX servers when a recording has completed. It runs automatic transcription (and AI summarization) of the recording according to the setting of the recording owner: recording.transcribe on the employee for personal recordings, or recording.transcribe on the PBX settings for common recordings.
- DISABLED - nothing happens.
- TRANSCRIBE - the recording is transcribed.
- TRANSCRIBE_AND_SUMMARIZE - the recording is transcribed and an AI summary is generated in the language of the owner (the PBX default language for common recordings).
The language, transcription and summary are stored on the recording.
| URL | https://api.telecomx.dk/pbx/recording/RECORDING_ID/transcribe/auto | |
|---|---|---|
| Method | GET | |
| Access level | None - may only be invoked from PBX server IP addresses. | |
| Param | RECORDING_ID | Id of the recording (24 hex-char string) |
Query example
https://api.telecomx.dk/pbx/recording/12345678901234567890AAAA/transcribe/auto
Response
| JSON object | ||
|---|---|---|
| success | Boolean | True on success |
| transcribe | String | The setting that was applied: DISABLED, TRANSCRIBE or TRANSCRIBE_AND_SUMMARIZE |
Example
{ "success": true, "transcribe": "TRANSCRIBE_AND_SUMMARIZE" }
Errors
| Error code | Message | Description |
|---|---|---|
| 403 | access_denied | Not invoked from a PBX server |
| 404 | not_found | Recording not found |
| 500 | internal_error | <Unspecified> |
api/pbx/recording/transcribeauto.txt · Last modified: by Per Møller