Maintenance script: API docs (generated from func=help)

2026-07-23T19:38:31Z

API docs (generated from func=help)

← Older revision		Revision as of 19:38, 23 July 2026
Line 15:		Line 15:
	\|-		\|-
	\| <code>to</code> \|\| string \|\| No \|\| — \|\| End date (inclusive). Default: today. <small>(YYYY-MM-DD)</small>		\| <code>to</code> \|\| string \|\| No \|\| — \|\| End date (inclusive). Default: today. <small>(YYYY-MM-DD)</small>
			\|-
			\| <code>hour</code> \|\| integer \|\| No \|\| — \|\| Filter to one hour of the day. Returns recordings whose start time falls in that hour (e.g. hour=14 => 14:00-14:59). <small>(0-23)</small>
	\|-		\|-
	\| <code>withtranscript</code> \|\| integer \|\| No \|\| — \|\| 1 = only recordings that already have a transcript.		\| <code>withtranscript</code> \|\| integer \|\| No \|\| — \|\| 1 = only recordings that already have a transcript.

Maintenance script: API docs: add recording transcript/summary endpoints

2026-07-22T22:25:58Z

API docs: add recording transcript/summary endpoints

New page

''7Kas VoIP REST API function. Available to: '''SuperRoot, Operator, Client'''.''

== Description ==
Lists the caller's call recordings with availability flags (has_transcript, has_summary, has_audio). Clients see only their own (root, accountcode) — forced from the key; operators their root; SuperRoot all. Use it to find a recording id/uniqueid to download.

== Call ==
GET …/7Kas?func=getrecordings&ukey=YOUR_KEY&…
Requires the <code>ukey</code> parameter.

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>from</code> || string || No || — || Start date. Default: 31 days ago. (YYYY-MM-DD)
|-
| <code>to</code> || string || No || — || End date (inclusive). Default: today. (YYYY-MM-DD)
|-
| <code>withtranscript</code> || integer || No || — || 1 = only recordings that already have a transcript.
|-
| <code>withsummary</code> || integer || No || — || 1 = only recordings that already have a summary.
|-
| <code>accountcode</code> || integer || No || — || Operators/SuperRoot only: filter to one account. Ignored/forced for clients. (string, max 20)
|-
| <code>root</code> || integer || No || — || SuperRoot only: filter to one operator root.
|-
| <code>limit</code> || integer || No || <code>100</code> || Max rows (up to 1000).
|-
| <code>offset</code> || integer || No || <code>0</code> || Pagination offset.
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getrecordings&ukey=KEY&from=2026-07-01&to=2026-07-31</nowiki>

== Response ==
FillRecords2JSON records: id, uniqueid, daterecord, src, dst, nota, status, has_transcript, has_summary, has_audio, engine, lang, confidence.

----
Back to [[API VoIP]] · '''[[API Console|▶ Try it live]]''' · Profiles: [[API profile SuperRoot]], [[API profile Operator]], [[API profile Client (of operator)]], [[API profile Client (direct)]]
[[Category:API SuperRoot]][[Category:API Operator]][[Category:API Client]][[Category:API function]]

API getrecordings - Revision history

Maintenance script: API docs (generated from func=help)

Maintenance script: API docs: add recording transcript/summary endpoints