API getrecordingtranscript: Difference between revisions
API docs: add recording transcript/summary endpoints |
API docs regenerated from func=help (operator catalogue) |
||
| Line 1: | Line 1: | ||
''7Kas VoIP REST API function. Available to: ''' | ''7Kas VoIP REST API function. Available to: '''Operator, Client'''.'' | ||
== Description == | == Description == | ||
| Line 27: | Line 27: | ||
---- | ---- | ||
Back to [[API VoIP]] · '''[[API Console|▶ Try it live]]''' · Profiles: | Back to [[API VoIP]] · '''[[API Console|▶ Try it live]]''' · Profiles: [[API profile Operator]], [[API profile Client (of operator)]], [[API profile Client (direct)]] | ||
[[Category:API Operator]][[Category:API Client]][[Category:API function]] | |||
Latest revision as of 13:47, 5 November 2026
7Kas VoIP REST API function. Available to: Operator, Client.
Description
Returns the transcription of one of the caller's recordings, with or without the summary (resumen). Select the recording by id OR uniqueid. format=json returns an object; format=text returns a downloadable text/plain .txt (transcript, plus a "--- RESUMEN ---" block when summary=1). Scoped to the caller's (root, accountcode) by the key.
Call
GET …/7Kas?func=getrecordingtranscript&ukey=YOUR_KEY&…
Requires the ukey parameter.
Parameters
| Parameter | Type | Required | Default | Meaning |
|---|---|---|---|---|
id |
integer | No | — | Recording id. Provide id OR uniqueid. |
uniqueid |
string | No | — | Call uniqueid. Provide id OR uniqueid. (max 80) |
summary |
integer | No | — | 1 = include the summary (resumen) when available. |
format |
string | No | json |
text) |
Example
https://api.7kas.com:9080/7Kas?func=getrecordingtranscript&ukey=KEY&id=5270558&summary=1&format=text
Response
json: {transcript, summary(or null), lang, engine, confidence, src, dst, daterecord}. text: text/plain body (Content-Disposition attachment "<uniqueid>.txt").
Back to API VoIP · ▶ Try it live · Profiles: API profile Operator, API profile Client (of operator), API profile Client (direct)