Wiki 7Kas - User contributions [en]

TuCloudAPI

2026-11-05T14:20:33Z

Maintenance script: TuCloudAPI calendar: year-end periods (year_wrap) and 29/02

{{Note|1=New here? Start with '''[[TuCloudAPI help|the self-discovery endpoint]]'''. This reference is generated from <code>func=help</code>, so it never drifts.}}

== Overview ==
'''TuCloudAPI''' is the REST API to manage '''FuturePBX''' (the multi-tenant cloud PBX). '''HTTPS + JSON''', GET or POST (parameters form-urlencoded; audio uploads POST the file as the body). Base URL:
https://tucloudapi.7kas.com:9087/tucloud?func=NAME&ukey=YOUR_KEY&pbx=PBX_NAME

== Authentication & tenant ==
Every call needs an '''API key''' (<code>ukey</code>). Every PBX-scoped function also needs <code>pbx</code> — the PBX '''name''' (e.g. <code>tucall</code>). The <code>(ukey, pbx)</code> pair is the tenant boundary: the server resolves the PBX name to its id and verifies that the key's OWN account owns it — for every role, SuperRoot included. A PBX that does not exist and one the key does not own both answer <code>forbidden</code>. It never trusts a numeric tenant from the caller.

== Response format ==
'''Always HTTP 200.''' Every PBX-scoped function always returns a JSON envelope: success <code>{"ok":true, ...}</code>, empty <code>{"ok":true,"rows":[]}</code>, error <code>{"ok":false,"code":...,"message":...}</code> (common codes: <code>missing_pbx, forbidden, invalid_param, not_found, conflict, in_use, db_error, server_busy</code>). IDs are exposed as <code>_id</code>. A missing or invalid <code>ukey</code> answers a bare <code>{}</code> and nothing else. The legacy account functions return their data object directly, <code>{}</code> when there is nothing.

== Functions ==
=== Dashboard (landing counts) ===
* [[TuCloudAPI getdashboard]] — Landing-page dashboard: per-tenant object counts + a cheap health metric, in one call.
=== Extensions (Extensiones) ===
* [[TuCloudAPI getextensions]] — List the PBX extensions (safe display fields; NEVER the SIP password).
* [[TuCloudAPI getextension]] — Get one extension with all editable fields (NO password).
* [[TuCloudAPI getextlookups]] — Tenant-scoped option lists for the extension form selects: caller IDs (clis), music-on-hold (music), outgoing services (outs), the extension list (exts, for Enviar a / backup monitor), registration servers (servers) and next_free: the create-form number prefill for a REGISTERED extension (3-4 digits, the same check as checkextnum), a string, or null when no number is free.
* [[TuCloudAPI checkextnum]] — Is this number free for a NEW extension of this PBX? The same check addextension runs under its lock, so the two never disagree.
* [[TuCloudAPI addextension]] — Create an extension.
* [[TuCloudAPI updateextension]] — Edit an extension.
* [[TuCloudAPI deleteextension]] — Delete an extension after a tenant + dependency check.
* [[TuCloudAPI setextpassword]] — Rotate ONE extension's SIP password.
* [[TuCloudAPI getextpassword]] — Plaintext SIP password for ONE extension (the portal's «Clave SIP» eye toggle).
* [[TuCloudAPI getextqr]] — SIP provisioning QR for one extension, rendered server-side to a PNG (base64).
=== CLIs / DIDs (Numeracion) ===
* [[TuCloudAPI getclis]] — List the PBX CLIs / DIDs (inbound numbers) with the grid fields.
* [[TuCloudAPI getcli]] — Get one CLI with all editable fields, including the full 192-key timer matrix under "timers".
* [[TuCloudAPI getclilookups]] — Tenant-scoped option lists for the CLI form: routes (all route selects), schedule profiles (template_h), and defined calendar templates (template_c helper).
* [[TuCloudAPI addcli]] — Create a CLI / DID.
* [[TuCloudAPI updatecli]] — Edit a CLI.
* [[TuCloudAPI deletecli]] — Delete a CLI after a tenant + dependency check.
=== Routes (Rutas) ===
* [[TuCloudAPI getroutes]] — List inbound routes for the PBX with step counts.
* [[TuCloudAPI getroute]] — Get one route header plus its ordered steps (destinations).
* [[TuCloudAPI getroutelookups]] — Tenant-scoped destination pickers for the step editor: the app enum plus extensions, groups, locutions, schedules, calendars, routes and queues (app=10 "Cola": _id = the stable voip_queue.id stored in the step appdata, label = the queue title).
* [[TuCloudAPI addroute]] — Create an inbound route (header only; add steps with addroutestep).
* [[TuCloudAPI updateroute]] — Rename/annotate a route header.
* [[TuCloudAPI deleteroute]] — Delete a route.
* [[TuCloudAPI addroutestep]] — Append a step to a route (priority = max+1).
* [[TuCloudAPI updateroutestep]] — Change a step's app/appdata/timer (and optionally priority).
* [[TuCloudAPI deleteroutestep]] — Remove a step; the remaining steps' priorities are auto-compacted to 1..N by the DB trigger.
=== Blacklist (inbound intercept) ===
* [[TuCloudAPI getblacklist]] — List the inbound-intercept rules for the PBX.
* [[TuCloudAPI getblacklistlookups]] — Tenant-scoped pickers for the rule form: routes (the divert target) and CLIs/DIDs (cli_id; 0 = all DIDs / generic rule).
* [[TuCloudAPI addblacklist]] — Create an inbound-intercept rule.
* [[TuCloudAPI updateblacklist]] — Edit an inbound-intercept rule.
* [[TuCloudAPI deleteblacklist]] — Delete an inbound-intercept rule.
=== Contacts (Agenda) ===
* [[TuCloudAPI getcontacts]] — List the PBX contacts (address book).
* [[TuCloudAPI addcontact]] — Create a contact.
* [[TuCloudAPI updatecontact]] — Edit a contact.
* [[TuCloudAPI deletecontact]] — Delete a contact.
=== Calendar (date overrides) ===
* [[TuCloudAPI getcalendars]] — List the PBX calendar date-overrides (one row = one recurring month/day + time window that reroutes inbound to a route for CLIs on that template).
* [[TuCloudAPI getcalendar]] — Get one calendar row.
* [[TuCloudAPI getcalendarlookups]] — Tenant-scoped pickers: routes (the destination) and the set of template values already in use (suggestions for the template spinner).
* [[TuCloudAPI addcalendar]] — Create a calendar date-override.
* [[TuCloudAPI updatecalendar]] — Edit a calendar row (same fields and period rule as addcalendar).
* [[TuCloudAPI deletecalendar]] — Delete a calendar row.
=== Ring groups (Grupos) ===
* [[TuCloudAPI getgroups]] — List the PBX ring/hunt groups with a member count.
* [[TuCloudAPI getgroup]] — Get one group.
* [[TuCloudAPI getgrouplookups]] — Tenant-scoped pickers: extensions (members), music (MOH), and CLIs (for the admin forward caller-id).
* [[TuCloudAPI addgroup]] — Create a ring group.
* [[TuCloudAPI updategroup]] — Edit a ring group (same fields as addgroup; gr editable, conflict on collision).
* [[TuCloudAPI deletegroup]] — Delete a ring group.
=== Locutions / IVR (Locuciones) ===
* [[TuCloudAPI getlocutions]] — List the PBX locutions / IVR prompts.
* [[TuCloudAPI getlocution]] — Get one locution with its DTMF digit->route map (+ resolved route names), has_audio and audio_url.
* [[TuCloudAPI getlocutionlookups]] — Tenant-scoped route picker for the 11 DTMF digit destinations.
* [[TuCloudAPI addlocution]] — Create a locution / IVR.
* [[TuCloudAPI updatelocution]] — Edit a locution (name, waitext, digit routes).
* [[TuCloudAPI deletelocution]] — Delete a locution.
* [[TuCloudAPI getlocutionvoices]] — Catalogo para el selector de texto a voz: voces disponibles e idiomas admitidos.
* [[TuCloudAPI synthlocution]] — Genera el audio de una locucion a partir de un texto y lo deja PENDIENTE DE ACEPTAR: NO sustituye la locucion.
* [[TuCloudAPI uploadlocution]] — Sube un fichero de audio y lo deja COMO el audio de una locucion.
* [[TuCloudAPI commitlocution]] — Acepta el audio pendiente (el generado por synthlocution o subido por uploadlocution) y lo convierte en la locucion.
* [[TuCloudAPI discardlocution]] — Tira el audio pendiente sin tocar la locucion.
=== Music on hold (MOH) ===
* [[TuCloudAPI getmusics]] — List the PBX music-on-hold classes with has_audio (whether the track exists) and audio_url (the getaudio player URL).
* [[TuCloudAPI getmusic]] — Get one MOH class (+ has_audio, audio_url).
* [[TuCloudAPI addmusic]] — Create a MOH class.
* [[TuCloudAPI uploadmusic]] — Sube un fichero de audio para una clase de musica y lo deja PENDIENTE DE ACEPTAR: NO sustituye la que suena.
* [[TuCloudAPI commitmusic]] — Acepta el audio pendiente y lo convierte en la musica que suena.
* [[TuCloudAPI discardmusic]] — Tira el audio pendiente sin tocar la musica.
* [[TuCloudAPI deletemusic]] — Delete a MOH class.
=== Schedules (Horarios) ===
* [[TuCloudAPI getschedules]] — List the PBX weekly schedules (the WHEN grid a CLI's schedule profile points at).
* [[TuCloudAPI getschedule]] — Get one schedule with the full 84-cell weekly grid under "slots".
* [[TuCloudAPI addschedule]] — Create a weekly schedule.
* [[TuCloudAPI updateschedule]] — Edit a schedule (template/name/grid).
* [[TuCloudAPI deleteschedule]] — Delete a schedule.
=== Outbound routing (Rutas de salida) ===
* [[TuCloudAPI getoutgoings]] — List the outbound-routing profiles (Servicios de salida) with rule counts.
* [[TuCloudAPI getoutgoing]] — Get one outbound profile plus its ordered allow/deny rules (longest-prefix first).
* [[TuCloudAPI getoutgoinglookups]] — Tenant-scoped route picker for a rule's divert destination (route_id; 0 = block).
* [[TuCloudAPI addoutgoing]] — Create an outbound-routing profile (header; add rules with addoutrule).
* [[TuCloudAPI updateoutgoing]] — Rename/annotate an outbound profile.
* [[TuCloudAPI deleteoutgoing]] — Delete an outbound profile.
* [[TuCloudAPI addoutrule]] — Append an allow/deny rule to a profile.
* [[TuCloudAPI updateoutrule]] — Edit an outbound rule (dst/denyallow/route_id/nota).
* [[TuCloudAPI deleteoutrule]] — Remove an outbound rule.
=== Phonebooks (Agendas) ===
* [[TuCloudAPI getphonebooks]] — List the PBX phonebooks (address books) with contact counts.
* [[TuCloudAPI getphonebook]] — Get one phonebook plus its contacts.
* [[TuCloudAPI addphonebook]] — Create a phonebook.
* [[TuCloudAPI updatephonebook]] — Edit a phonebook.
* [[TuCloudAPI deletephonebook]] — Delete a phonebook and all its contacts (DB cascade).
* [[TuCloudAPI addphonebookcontact]] — Add a contact to a phonebook.
* [[TuCloudAPI updatephonebookcontact]] — Edit a phonebook contact (tenant-checked via the row).
* [[TuCloudAPI deletephonebookcontact]] — Remove a phonebook contact (tenant-checked).
=== Call queues / ACD (Colas) ===
* [[TuCloudAPI getqueues]] — List the PBX call queues (ACD) with member counts.
* [[TuCloudAPI getqueue]] — Get one queue's config.
* [[TuCloudAPI getqueuelookups]] — Tenant-scoped pickers for the queue form: music (MOH classes), the strategy enum, and next_free (the create-form exten prefill = first free 3-digit queue number, null if 900-999 full).
* [[TuCloudAPI addqueue]] — Create a call queue.
* [[TuCloudAPI updatequeue]] — Edit a queue's config.
* [[TuCloudAPI deletequeue]] — Delete a queue.
=== Agents / queue members (Agentes) ===
* [[TuCloudAPI getagents]] — List the PBX agents (queue members) with the queue title and the agent's extension name resolved.
* [[TuCloudAPI getagentlookups]] — Dropdown data for the agent screens: this PBX's queues (assign an agent to a queue) and its extensions {_id,num,name}.
* [[TuCloudAPI addagent]] — Add an extension to a queue as a static member.
* [[TuCloudAPI updateagent]] — Update a queue member's penalty / paused / reason_paused (partial — only the fields sent are changed).
* [[TuCloudAPI deleteagent]] — Remove a queue member (agent) by _id.
=== Portal admin users (Usuarios) ===
* [[TuCloudAPI getadminusers]] — List this PBX's portal users (tucloud_sec_users).
* [[TuCloudAPI getadminuser]] — Get one portal user by login (_id) within this PBX.
* [[TuCloudAPI getadminuserlookups]] — Picker for the user form: the distinct roles used in this PBX (free-text datalist suggestions), and invite:true: users are created by email invitation, with no username and no password (always true on this build).
* [[TuCloudAPI addadminuser]] — Invite a new portal user to THIS PBX.
* [[TuCloudAPI updateadminuser]] — Edit a portal user in THIS PBX: name, active, priv_admin, role and phone are replaced as sent; disable_2fa=1 turns 2FA off and clears the secret (never enables).
* [[TuCloudAPI requestadminuseremail]] — Ask to change a portal user's EMAIL (their magic-link login), the twin of requestpbxemail.
* [[TuCloudAPI resendadminuseremail]] — Mail again the link of the user's open email change (the invitation of an invited user, or a change), pending or expired, with a fresh 24 hours; the previous link is then ignored.
* [[TuCloudAPI canceladminuseremail]] — Drop the user's open email change (pending, or expired): its link is then ignored.
* [[TuCloudAPI getadminuseremailchange]] — Status of the user's latest email change, from tucloudapi's own state (never magiclogin): none | pending (email, expires_in) | expired (until resent or cancelled) | done (notice: sent|failed|skipped, the informational mail to the old address) | failed (reason taken|error) | cancelled, with invite (true when it is the invitation) and its Spanish message.
* [[TuCloudAPI deleteadminuser]] — Delete a portal user by login within this PBX; their open email change is cancelled with them.
=== PBX settings (Configuracion) ===
* [[TuCloudAPI getpbxconfig]] — Get this PBX's settings (single record, no id needed, tenant from the binding).
* [[TuCloudAPI getpbxconfiglookups]] — Picker for the admin_ext_id field: this PBX's extensions.
* [[TuCloudAPI updatepbxconfig]] — Update this PBX's settings (strict set).
* [[TuCloudAPI requestpbxemail]] — Ask to change this PBX's MASTER EMAIL (tucloud_pbx.email: the administrator's magic-link and password login).
* [[TuCloudAPI getpbxemailchange]] — Status of this PBX's latest master-email change, from tucloudapi's own state (never magiclogin): none | pending (email, expires_in) | done (email, notice: sent|failed|skipped, the informational mail to the old address) | expired | failed (reason taken|error) | cancelled, each with its Spanish message.
* [[TuCloudAPI cancelpbxemail]] — Cancel this PBX's pending master-email change (its link is then ignored).
=== Security profiles / ACL (Perfiles) ===
* [[TuCloudAPI getprofiles]] — List this PBX's security profiles (Perfiles) with member counts.
* [[TuCloudAPI getprofile]] — Get one profile + its full app-permission matrix (all catalog apps, with app_type).
* [[TuCloudAPI getprofileapps]] — Get a profile's app-permission matrix only (the Aplicaciones/Perfiles editor).
* [[TuCloudAPI getseclookups]] — Pickers for the security section: the global app catalog (matrix columns) + this PBX's profiles (membership picker).
* [[TuCloudAPI getprofileusers]] — List the admin users assigned to a profile (read-only "Miembros" list; edits stay per-user via setuserprofiles).
* [[TuCloudAPI getuserprofiles]] — Get an admin user's profile membership + the profile picker (this PBX only).
* [[TuCloudAPI addprofile]] — Create a security profile in this PBX.
* [[TuCloudAPI updateprofile]] — Rename a profile (description).
* [[TuCloudAPI deleteprofile]] — Delete a profile.
* [[TuCloudAPI getsections]] — The catalog of portal sections (login v2, 2026-10-31): one row per section of the new web, in sidebar order, from the NEW table tucloud_sec_sections (24 rows; pbx_config is the PBX administrator's and has no row).
* [[TuCloudAPI getprofilesections]] — One profile's section access (login v2): every catalog section with access Y/N, from the NEW table tucloud_sec_groups_sections; a section without a row answers N.
* [[TuCloudAPI setprofilesections]] — FULL replace of one profile's section access (login v2; the «mantenimiento de accesos de los grupos» the operator asked for on 2026-10-31).
* [[TuCloudAPI setprofileapps]] — RETIRED 2026-10-31 (operator: the legacy matrix is never altered again).
* [[TuCloudAPI setprofileapp]] — RETIRED 2026-10-31 (operator: the legacy matrix is never altered again).
* [[TuCloudAPI setuserprofiles]] — Full-replace an admin user's profile membership (this PBX only).
=== Call detail records (CDR) ===
* [[TuCloudAPI getcdr]] — List a period of this PBX's call detail records (Registro de llamadas), newest first.
* [[TuCloudAPI getcdrlookups]] — CDR form pickers: the selectable years + the result (disposition) label set.
=== Reports / statistics (Informes) ===
* [[TuCloudAPI getreports]] — Call-volume statistics (Informes / Estadisticas de Llamadas) for a month — VOLUME ONLY, no prices.
=== AI assistant (Asistente IA) ===
* [[TuCloudAPI aichat]] — AI assistant for this PBX (Spanish).
=== Scheduled tasks (Tareas programadas) ===
* [[TuCloudAPI gettasks]] — List scheduled tasks (tareas programadas) for the PBX, with schedule + status labels and step counts.
* [[TuCloudAPI gettask]] — Get one scheduled task and its ordered steps.
* [[TuCloudAPI gettasksteps]] — Get the ordered steps of a task (tenant-checked).
* [[TuCloudAPI gettasklog]] — Get the last 100 execution-log rows for a task (read-only history), newest first.
* [[TuCloudAPI getapps]] — List the 8 target entity types ("apps") a task step can act on.
* [[TuCloudAPI getappactions]] — List the configurable fields ("actions") for an app — the dynamic-form catalog (field, type 0-5, data, metadata).
* [[TuCloudAPI getappsrecords]] — List this PBX's selectable records for an app (the record picker), via the tenant-scoped lookup function.
* [[TuCloudAPI getactiondata]] — List the selectable value options for an action (the value picker), for select/checkbox action types, via the tenant-scoped lookup function.
* [[TuCloudAPI getpbxs]] — List the PBXs assigned to the calling ukey's account (post-login selector; show only if >1).
* [[TuCloudAPI addtask]] — Create a scheduled task (status forced 0).
* [[TuCloudAPI updatetask]] — Edit a task (does not change status).
* [[TuCloudAPI deletetask]] — Delete a task (DB cascade of steps/log + crontab removal via the operator trigger).
* [[TuCloudAPI addtaskstep]] — Append a step to a task.
* [[TuCloudAPI updatetaskstep]] — Change a step's value (blank -> NULL).
* [[TuCloudAPI deletetaskstep]] — Remove a step.
=== Call simulator ===
* [[TuCloudAPI simulatecall]] — Simulate how a call routes (inbound DID / outbound / internal) WITHOUT placing a real call, returning the ordered decision trace (flujo).
=== Audio files ===
* [[TuCloudAPI getaudio]] — General-purpose audio file server (not only for the simulator): serve a locution or music-on-hold audio file base64-encoded (audio/wav) — for hover-preview, players, downloads, etc.
=== FuturePBX ===
* [[TuCloudAPI getpbxloclog]] — FuturePBX IVR/locution DTMF key-press log for a period.
=== Meta / discovery ===
* [[TuCloudAPI help]] — Lists the API functions available to the role of the calling ukey, with each function's description, parameters (meaning, optional/default), an example call and the response format.
=== Diagnostics ===
* [[TuCloudAPI helloworld]] — Health check / connectivity test.
=== Administration ===
* [[TuCloudAPI SetDebugLevel]] — Sets the runtime debug/log verbosity level.
* [[TuCloudAPI ReloadUsersKeys]] — Hot-reloads the API keys from the database without restarting the service.
* [[TuCloudAPI resetinternalkey]] — Regenerates the non-showable internal API key for an account.
=== Account management (inherited) ===
* [[TuCloudAPI getaccountcodeid]] — Lists (id, accountcode) pairs of the accounts under the caller.
* [[TuCloudAPI getaccountcodedata]] — Returns full account profile rows (view_voip_users_api) for the caller's accounts.
* [[TuCloudAPI lockaccountcode]] — Blocks (locks) an account (blocked=SI).
* [[TuCloudAPI unlockaccountcode]] — Unblocks (unlocks) an account (blocked=NO).
* [[TuCloudAPI addaccountcode]] — Creates a new account (client) under the caller.
* [[TuCloudAPI getcredit]] — Returns credit and status (credit, credit_limit, creditalarm, email, blocked).
=== auth ===
* [[TuCloudAPI authrequest]] — Ask for a magic-link e-mail.
* [[TuCloudAPI authpoll]] — Has the user authorized the magic link? PUBLIC, like authrequest.
* [[TuCloudAPI authchallenge]] — A proof-of-work captcha challenge (ALTCHA protocol, SHA-256).
* [[TuCloudAPI authlogin]] — The password door.
* [[TuCloudAPI authwhoami]] — The current session context, and it refreshes the idle timer.
* [[TuCloudAPI authlogout]] — Destroy the session and clear the cookie.
=== queue_live ===
* [[TuCloudAPI getqueueevents]] — Today's events of ONE queue (local day), newest first, at most 200, with the same deduplication as getqueuestats (core events; module EXITQUEUE FULL/JOINEMPTY kept as refused).
* [[TuCloudAPI getlivestatus]] — LIVE state of the PBX as ONE snapshot of the presence feed: each extension's state (unregistered/idle/ringing/busy, "unknown" when it is not published) and its calls in progress (ringing/talking/hold/dialing, the other party, seconds since start and since answer), and each queue's live picture (agents logged in / available / paused, the waiting calls in queue order with their wait, every member with its status).
=== queue_stats ===
* [[TuCloudAPI getqueuestats]] — Call-center history from voip_queue_log (gabpbx contract v1, 2026-10-31): totals, per interval, per queue and per agent between two local days (Europe/Madrid, inclusive).

== Related ==
Full technical reference (architecture, auth model, side effects): see the project repo <code>doc/TUCLOUDAPI_REFERENCE.md</code>. Scheduled-tasks engine: the 6 <code>tucloud_pbx_tasks*</code> tables + the <code>.231</code> crontab trigger.

[[Category:TuCloudAPI]]

TuCloudAPI updatecalendar

2026-11-05T14:20:33Z

Maintenance script: TuCloudAPI calendar: year-end periods (year_wrap) and 29/02

''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.''

{{Note|1=Requires the <code>pbx</code> parameter (the PBX '''name''', e.g. <code>tucall</code>). The server verifies that your <code>ukey</code>'s own account owns that PBX, whatever its role; otherwise, and also for a PBX that does not exist, it returns <code>{"ok":false,"code":"forbidden"}</code>.}}

== Description ==
Edit a calendar row (same fields and period rule as addcalendar). hold ABSENT keeps the stored value. With hold 0, expires_on is kept while the period (start and end) does not change, and computed again from today when it does or when the row goes from 1 to 0; hold 1 clears it. 404 if not in the caller's PBX. Requires a non-readonly ukey.

== Call ==
https://tucloudapi.7kas.com:9087/tucloud?func=updatecalendar&ukey=YOUR_KEY&pbx=PBX_NAME
GET, or POST with the parameters form-urlencoded in the body. Requires the <code>ukey</code> parameter. Always HTTP 200; the response is a JSON envelope.

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>pbx</code> || string || Yes || — || FuturePBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX.
|-
| <code>id</code> || integer || Yes || — || Calendar row id (_id).
|-
| <code>template</code> || integer || Yes || — || Calendar-template group 1-99.
|-
| <code>monthstart</code> || integer || Yes || — || Start month 1-12.
|-
| <code>monthend</code> || integer || Yes || — || End month 1-12.
|-
| <code>dayend</code> || integer || Yes || — || End day 1-31.
|-
| <code>destination</code> || integer || Yes || — || Route _id to divert to (required, in-tenant).
|-
| <code>daystart</code> || integer || No || <code>0</code> || Start day 1-31, or 0/blank = all days (Todos).
|-
| <code>timestart</code> || string || No || <code>00:00</code> || Start time HH:MM.
|-
| <code>timeend</code> || string || No || <code>00:00</code> || End time HH:MM.
|-
| <code>hold</code> || integer || No || — || «Repetir cada año» 1/0; absent = keep the stored value.
|-
| <code>nota</code> || string || No || — || Free note (max 256).
|}
== Example ==
<nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=updatecalendar&ukey=KEY&pbx=tucall&id=81522&template=1&monthstart=1&daystart=1&monthend=1&dayend=1&destination=197</nowiki>

== Response ==
{ok, calendar:{...}}.

== Errors ==
Always HTTP 200. On failure the body is <code>{"ok":false,"code":"...","message":"..."}</code>. Common codes: <code>missing_pbx</code>, <code>forbidden</code>, <code>invalid_param</code>, <code>not_found</code>, <code>conflict</code>, <code>in_use</code>, <code>db_error</code>, <code>server_busy</code>; the Response section above lists any specific to this function.

----
Back to [[TuCloudAPI]]
[[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI Client]][[Category:TuCloudAPI]]

TuCloudAPI addcalendar

2026-11-05T14:20:33Z

Maintenance script: TuCloudAPI calendar: year-end periods (year_wrap) and 29/02

''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.''

{{Note|1=Requires the <code>pbx</code> parameter (the PBX '''name''', e.g. <code>tucall</code>). The server verifies that your <code>ukey</code>'s own account owns that PBX, whatever its role; otherwise, and also for a PBX that does not exist, it returns <code>{"ok":false,"code":"forbidden"}</code>.}}

== Description ==
Create a calendar date-override. Fields: template 1-99 (the calendar group a CLI's template_c selects), monthstart/monthend 1-12, daystart/dayend 1-31, timestart/timeend HH:MM (blank = 00:00), destination = an in-tenant route _id (required), hold «Repetir cada año» 1/0, nota (max 256). A period that crosses the year end (start after end) is accepted when it lasts at most 62 days, both ends included, counted in a non-leap year (23/12 -> 01/01 = 10); a longer one -> invalid_param, field monthend, reason year_wrap. «Repetir cada año» (operator 2026-11-05): 1 = the row repeats every year on those dates; 0 = only its next occurrence: expires_on is the last day of it (Europe/Madrid) and the day after, the row is deleted by itself. The next occurrence is this year's when its end day is today or later, else next year's. The trigger derives the MMDD/HHMM columns + root; the API writes only the editable fields. No dedup (duplicates allowed, per legacy). Requires a non-readonly ukey.

== Call ==
https://tucloudapi.7kas.com:9087/tucloud?func=addcalendar&ukey=YOUR_KEY&pbx=PBX_NAME
GET, or POST with the parameters form-urlencoded in the body. Requires the <code>ukey</code> parameter. Always HTTP 200; the response is a JSON envelope.

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>pbx</code> || string || Yes || — || FuturePBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX.
|-
| <code>template</code> || integer || Yes || — || Calendar-template group 1-99.
|-
| <code>monthstart</code> || integer || Yes || — || Start month 1-12.
|-
| <code>monthend</code> || integer || Yes || — || End month 1-12.
|-
| <code>dayend</code> || integer || Yes || — || End day 1-31.
|-
| <code>destination</code> || integer || Yes || — || Route _id to divert to (required, in-tenant).
|-
| <code>daystart</code> || integer || No || <code>0</code> || Start day 1-31, or 0/blank = all days (Todos).
|-
| <code>timestart</code> || string || No || <code>00:00</code> || Start time HH:MM.
|-
| <code>timeend</code> || string || No || <code>00:00</code> || End time HH:MM.
|-
| <code>hold</code> || integer || No || <code>1</code> || «Repetir cada año»: 1 = every year (the default), 0 = only the next occurrence, then deleted by itself.
|-
| <code>nota</code> || string || No || — || Free note (max 256).
|}
== Example ==
<nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=addcalendar&ukey=KEY&pbx=tucall&template=1&monthstart=12&daystart=25&monthend=12&dayend=25&destination=197</nowiki>

== Response ==
{ok, calendar:{...}}.

== Errors ==
Always HTTP 200. On failure the body is <code>{"ok":false,"code":"...","message":"..."}</code>. Common codes: <code>missing_pbx</code>, <code>forbidden</code>, <code>invalid_param</code>, <code>not_found</code>, <code>conflict</code>, <code>in_use</code>, <code>db_error</code>, <code>server_busy</code>; the Response section above lists any specific to this function.

----
Back to [[TuCloudAPI]]
[[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI Client]][[Category:TuCloudAPI]]

MediaWiki:Common.js

2026-11-05T13:51:30Z

Maintenance script: API console regenerated from func=help (operator catalogue)

/* === BEGIN restapi-generated (wikidocs/gen_assets.py) -- do not edit inside, it is overwritten ===
MediaWiki:Common.js is SHARED with other teams (tucloudapi appends its own page-gated
loaders after the END marker). publish.sh preserves everything outside these markers. */
/* 7Kas API Console -- interactive explorer for [[API Console]].
SAFE BY DESIGN: pure client-side URL builder. No wiki proxy, no cross-origin fetch;
"Run" opens the real 7Kas API (api.7kas.com) in a new tab using the reader's OWN ukey.
Identity is enforced server-side and each key is rate-limited (taskslimit), so this adds
no attack surface beyond what the public API already exposes. */
(function(){
if (mw.config.get('wgPageName') !== 'API_Console') { return; }
var API = 'https://api.7kas.com:9080/7Kas';
var CAT = {"help":{"cat":"meta","ex":"https://api.7kas.com:9080/7Kas?func=help&ukey=KEY","params":[{"n":"name","req":false,"def":"","type":"string","d":"Return only this function's documentation. Omit for the full catalogue.","notes":""}]},"helloworld":{"cat":"health","ex":"https://api.7kas.com:9080/7Kas?func=helloworld&ukey=KEY","params":[]},"getaccountcodeid":{"cat":"accounts","ex":"https://api.7kas.com:9080/7Kas?func=getaccountcodeid&ukey=OPKEY&limit=100","params":[{"n":"accountcode","req":false,"def":"","type":"string","d":"Filter by account code (exact). Omit for all.","notes":"max length 20"},{"n":"limit","req":false,"def":"100","type":"integer","d":"Max rows (up to 10000).","notes":""},{"n":"offset","req":false,"def":"0","type":"integer","d":"Pagination offset.","notes":""}]},"getaccountcodedata":{"cat":"accounts","ex":"https://api.7kas.com:9080/7Kas?func=getaccountcodedata&ukey=OPKEY&accountcodeid=123","params":[{"n":"accountcodeid","req":false,"def":"","type":"integer","d":"Filter by account id. Omit for all.","notes":""},{"n":"limit","req":false,"def":"1000","type":"integer","d":"Max rows.","notes":""},{"n":"offset","req":false,"def":"0","type":"integer","d":"Pagination offset.","notes":""}]},"lockaccountcode":{"cat":"accounts","ex":"https://api.7kas.com:9080/7Kas?func=lockaccountcode&ukey=OPKEY&accountcodeid=123","params":[{"n":"accountcodeid","req":true,"def":"","type":"integer","d":"Account id to lock.","notes":""}]},"unlockaccountcode":{"cat":"accounts","ex":"https://api.7kas.com:9080/7Kas?func=unlockaccountcode&ukey=OPKEY&accountcodeid=123","params":[{"n":"accountcodeid","req":true,"def":"","type":"integer","d":"Account id to unlock.","notes":""}]},"addaccountcode":{"cat":"accounts","ex":"https://api.7kas.com:9080/7Kas?func=addaccountcode&ukey=OPKEY&accountcode=NEW1&credit=0&password=secret&name=John","params":[{"n":"accountcode","req":true,"def":"","type":"string","d":"Account code (login). Required. Max 20.","notes":""},{"n":"credit","req":true,"def":"","type":"string","d":"Initial credit. Required. Max 20.","notes":""},{"n":"password","req":true,"def":"","type":"string","d":"Account password. Required. Max 40.","notes":""},{"n":"name","req":true,"def":"","type":"string","d":"Contact/holder name. Required. Max 100.","notes":""},{"n":"company","req":false,"def":"","type":"string","d":"Company name.","notes":"max 100"},{"n":"address","req":false,"def":"","type":"string","d":"Postal address.","notes":"max 200"},{"n":"phone","req":false,"def":"","type":"string","d":"Phone.","notes":"max 20"},{"n":"email","req":false,"def":"","type":"string","d":"Primary e-mail.","notes":"max 100"},{"n":"date_added","req":false,"def":"","type":"string","d":"Creation date.","notes":"max 20"},{"n":"description","req":false,"def":"","type":"string","d":"Free description.","notes":"max 200"},{"n":"language","req":false,"def":"","type":"string","d":"UI language code.","notes":"max 5"},{"n":"postal_code","req":false,"def":"","type":"string","d":"Postal code.","notes":"max 10"},{"n":"city","req":false,"def":"","type":"string","d":"City.","notes":"max 50"},{"n":"province","req":false,"def":"","type":"string","d":"Province.","notes":"max 50"},{"n":"nif","req":false,"def":"","type":"string","d":"Tax id (NIF/CIF).","notes":"max 20"},{"n":"blocked","req":false,"def":"","type":"string","d":"Blocked flag (SI/NO).","notes":"max 4"},{"n":"postpaid","req":false,"def":"","type":"string","d":"Postpaid flag.","notes":"max 4"},{"n":"admin","req":false,"def":"","type":"string","d":"Admin flag.","notes":"max 4"},{"n":"accountcode_comis","req":false,"def":"","type":"string","d":"Commissioner account this account belongs to.","notes":"max 20"},{"n":"comisionista","req":false,"def":"","type":"string","d":"Is-commissioner flag (SI/NO).","notes":"max 4"},{"n":"groups","req":false,"def":"","type":"string","d":"Group memberships.","notes":"max 100"},{"n":"movil_sms","req":false,"def":"","type":"string","d":"Mobile for SMS.","notes":"max 20"},{"n":"email2","req":false,"def":"","type":"string","d":"Secondary e-mail.","notes":"max 100"},{"n":"fax","req":false,"def":"","type":"string","d":"Fax.","notes":"max 20"},{"n":"nota","req":false,"def":"","type":"string","d":"Internal note.","notes":"max 500"},{"n":"web","req":false,"def":"","type":"string","d":"Website.","notes":"max 100"},{"n":"flags","req":false,"def":"","type":"string","d":"Account flags.","notes":"max 20"},{"n":"tariff","req":false,"def":"","type":"string","d":"Tariff code.","notes":"max 20"},{"n":"daycallmail","req":false,"def":"","type":"string","d":"Daily-call report e-mail(s).","notes":"max 100"},{"n":"root","req":false,"def":"","type":"integer","d":"Parent operator root. Forced to the caller's own unless SuperRoot.","notes":"numeric, max 10"},{"n":"credit_limit","req":false,"def":"","type":"integer","d":"Credit limit.","notes":"numeric"},{"n":"comis_minutos","req":false,"def":"","type":"integer","d":"Commission minutes.","notes":"numeric"},{"n":"ratio","req":false,"def":"","type":"integer","d":"Commission ratio.","notes":"numeric"},{"n":"creditalarm","req":false,"def":"","type":"integer","d":"Credit alarm threshold.","notes":"numeric"},{"n":"aindirecto_coste","req":false,"def":"","type":"integer","d":"Indirect-access cost.","notes":"numeric"},{"n":"intlimit","req":false,"def":"","type":"integer","d":"International limit.","notes":"numeric"},{"n":"daycall","req":false,"def":"","type":"integer","d":"Daily-call limit.","notes":"numeric"},{"n":"intlock","req":false,"def":"","type":"integer","d":"International lock flag.","notes":"numeric"}]},"getcredit":{"cat":"accounts","ex":"https://api.7kas.com:9080/7Kas?func=getcredit&ukey=KEY","params":[{"n":"accountcode","req":false,"def":"","type":"string","d":"Account to query (operators/SuperRoot only). Omit for your own.","notes":"max length 20"}]},"getcdr":{"cat":"cdr","ex":"https://api.7kas.com:9080/7Kas?func=getcdr&ukey=KEY&year=2026&month=7&limit=100","params":[{"n":"year","req":true,"def":"","type":"integer","d":"Year of the records (e.g. 2026).","notes":""},{"n":"month","req":true,"def":"","type":"integer","d":"Month, 1-12.","notes":""},{"n":"day","req":false,"def":"","type":"integer","d":"Filter by day of month (1-31).","notes":""},{"n":"hour","req":false,"def":"","type":"integer","d":"Filter by hour (0-23).","notes":"only valid together with day"},{"n":"accountcodeid","req":false,"def":"","type":"integer","d":"Filter by account id. Ignored/forced to the caller's own for clients.","notes":""},{"n":"userfield","req":false,"def":"","type":"string","d":"Filter by tucloud PBX id (the CDR userfield column). One accountcode can host several PBXs, so accountcodeid alone does not isolate a switchboard.","notes":"strict: rows whose userfield is empty never match"},{"n":"limit","req":false,"def":"100","type":"integer","d":"Max rows. SHM fast-path up to 10000, PostgreSQL fallback up to 1000.","notes":""},{"n":"offset","req":false,"def":"0","type":"integer","d":"Pagination offset.","notes":""}]},"getcallsbilling":{"cat":"billing","ex":"https://api.7kas.com:9080/7Kas?func=getcallsbilling&ukey=KEY&year=2026&month=7&model=voc&limit=100","params":[{"n":"year","req":true,"def":"","type":"integer","d":"Year (e.g. 2026).","notes":""},{"n":"month","req":true,"def":"","type":"integer","d":"Month, 1-12.","notes":""},{"n":"model","req":false,"def":"voc","type":"string","d":"voc = detailed calls; toc = totals.","notes":"valid: voc|toc (case-insensitive)"},{"n":"accountcode","req":false,"def":"","type":"string","d":"Filter by account code (non-clients). Forced to own for clients.","notes":"max 20"},{"n":"day","req":false,"def":"","type":"integer","d":"Filter by day (1-31).","notes":"model=voc only"},{"n":"hour","req":false,"def":"","type":"integer","d":"Filter by hour (0-23).","notes":"model=voc only, requires day"},{"n":"limit","req":false,"def":"100","type":"integer","d":"Max rows. SHM up to 10000, PostgreSQL up to 1000.","notes":""},{"n":"offset","req":false,"def":"0","type":"integer","d":"Pagination offset.","notes":""},{"n":"search","req":false,"def":"","type":"string","d":"Server-side search pattern.","notes":"max 40"},{"n":"search_fields","req":false,"def":"","type":"string","d":"Comma-separated fields (whitelist: dst, cid_num, cid_name, cli_billing, dial_cid_num, accountcode, prefix, dtype, context, tariff, fromuri).","notes":"max 200"},{"n":"search_mode","req":false,"def":"contains","type":"string","d":"Match mode.","notes":"prefix|suffix|contains|exact"}]},"getcallsbillingtotalroot":{"cat":"billing","ex":"https://api.7kas.com:9080/7Kas?func=getcallsbillingtotalroot&ukey=SRKEY&year=2026&month=7&root=5","params":[{"n":"year","req":true,"def":"","type":"integer","d":"Year.","notes":""},{"n":"month","req":true,"def":"","type":"integer","d":"Month, 1-12.","notes":""},{"n":"root","req":false,"def":"","type":"integer","d":"Root/operator id. Required for SuperRoot; operators use their own.","notes":"required when SuperRoot"}]},"getcallsbillingcount":{"cat":"billing","ex":"https://api.7kas.com:9080/7Kas?func=getcallsbillingcount&ukey=KEY&year=2026&month=7&model=voc","params":[{"n":"year","req":true,"def":"","type":"integer","d":"Year.","notes":""},{"n":"month","req":true,"def":"","type":"integer","d":"Month, 1-12.","notes":""},{"n":"model","req":false,"def":"voc","type":"string","d":"voc or toc.","notes":"valid: voc|toc"},{"n":"accountcode","req":false,"def":"","type":"string","d":"Filter by account code (non-clients).","notes":"max 20"},{"n":"day","req":false,"def":"","type":"integer","d":"Filter by day.","notes":"model=voc only"},{"n":"hour","req":false,"def":"","type":"integer","d":"Filter by hour.","notes":"model=voc only, requires day"}]},"getcallsbillingtotal":{"cat":"billing","ex":"https://api.7kas.com:9080/7Kas?func=getcallsbillingtotal&ukey=KEY&year=2026&month=7","params":[{"n":"year","req":true,"def":"","type":"integer","d":"Year.","notes":""},{"n":"month","req":true,"def":"","type":"integer","d":"Month, 1-12.","notes":""}]},"getcallsbillingaccounttotal":{"cat":"billing","ex":"https://api.7kas.com:9080/7Kas?func=getcallsbillingaccounttotal&ukey=OPKEY&year=2026&month=7&accountcode=CLI1","params":[{"n":"year","req":true,"def":"","type":"integer","d":"Year.","notes":""},{"n":"month","req":true,"def":"","type":"integer","d":"Month, 1-12.","notes":""},{"n":"accountcode","req":false,"def":"","type":"string","d":"Account code to total.","notes":"max 20"}]},"getcallsbillingdetailtotal":{"cat":"billing","ex":"https://api.7kas.com:9080/7Kas?func=getcallsbillingdetailtotal&ukey=KEY&year=2026&month=7","params":[{"n":"year","req":true,"def":"","type":"integer","d":"Year.","notes":""},{"n":"month","req":true,"def":"","type":"integer","d":"Month, 1-12.","notes":""},{"n":"accountcode","req":false,"def":"","type":"string","d":"Filter by account code (non-clients).","notes":"max 20"},{"n":"day","req":false,"def":"","type":"integer","d":"Filter by day (1-31).","notes":""},{"n":"hour","req":false,"def":"","type":"integer","d":"Filter by hour.","notes":"requires day"},{"n":"search","req":false,"def":"","type":"string","d":"Server-side search pattern.","notes":"max 40"},{"n":"search_fields","req":false,"def":"","type":"string","d":"Comma-separated searchable fields.","notes":"max 200"},{"n":"search_mode","req":false,"def":"contains","type":"string","d":"Match mode.","notes":"prefix|suffix|contains|exact"}]},"getcallsbillingcomis":{"cat":"billing","ex":"https://api.7kas.com:9080/7Kas?func=getcallsbillingcomis&ukey=COMISKEY&year=2026&month=7","params":[{"n":"year","req":false,"def":"","type":"integer","d":"Year. Optional (defaults applied server-side).","notes":""},{"n":"month","req":false,"def":"","type":"integer","d":"Month, 1-12. Optional.","notes":""}]},"getservices":{"cat":"services","ex":"https://api.7kas.com:9080/7Kas?func=getservices&ukey=KEY&year=2026&month=7&limit=100","params":[{"n":"year","req":true,"def":"","type":"integer","d":"Year.","notes":""},{"n":"month","req":true,"def":"","type":"integer","d":"Month, 1-12.","notes":""},{"n":"service","req":false,"def":"","type":"string","d":"Service prefix (e.g. osttrc). Omit for all services.","notes":"max 20"},{"n":"accountcode","req":false,"def":"","type":"string","d":"Filter by account (non-clients). Forced to own for clients.","notes":"max 20"},{"n":"day","req":false,"def":"","type":"integer","d":"Filter by day (1-31).","notes":""},{"n":"hour","req":false,"def":"","type":"integer","d":"Filter by hour.","notes":"requires day"},{"n":"limit","req":false,"def":"100","type":"integer","d":"Max rows (SHM up to 10000, PostgreSQL up to 1000).","notes":""},{"n":"offset","req":false,"def":"0","type":"integer","d":"Pagination offset.","notes":""}]},"getservicestotal":{"cat":"services","ex":"https://api.7kas.com:9080/7Kas?func=getservicestotal&ukey=KEY&year=2026&month=7","params":[{"n":"year","req":true,"def":"","type":"integer","d":"Year.","notes":""},{"n":"month","req":true,"def":"","type":"integer","d":"Month, 1-12.","notes":""},{"n":"service","req":false,"def":"","type":"string","d":"Service prefix. Omit for all.","notes":"max 20"},{"n":"accountcode","req":false,"def":"","type":"string","d":"Filter by account (non-clients).","notes":"max 20"}]},"getincomingcalls":{"cat":"incomingcalls","ex":"https://api.7kas.com:9080/7Kas?func=getincomingcalls&ukey=KEY&year=2026&month=7&model=vic&limit=100","params":[{"n":"year","req":true,"def":"","type":"integer","d":"Year (e.g. 2026).","notes":""},{"n":"month","req":true,"def":"","type":"integer","d":"Month, 1-12.","notes":""},{"n":"model","req":false,"def":"vic","type":"string","d":"vic = detail records; tic = totals.","notes":"valid: vic|tic (case-insensitive)"},{"n":"accountcodeid","req":false,"def":"","type":"integer","d":"Filter by account id (non-clients). Forced to own for clients.","notes":""},{"n":"day","req":false,"def":"","type":"integer","d":"Filter by day (1-31).","notes":"model=vic only"},{"n":"hour","req":false,"def":"","type":"integer","d":"Filter by hour (0-23).","notes":"model=vic only, requires day"},{"n":"limit","req":false,"def":"100","type":"integer","d":"Max rows. SHM up to 10000, PostgreSQL up to 1000.","notes":""},{"n":"offset","req":false,"def":"0","type":"integer","d":"Pagination offset.","notes":""},{"n":"search","req":false,"def":"","type":"string","d":"Server-side search pattern.","notes":"max 40"},{"n":"search_fields","req":false,"def":"","type":"string","d":"Comma-separated fields to search (whitelist: src, dst).","notes":"max 200"},{"n":"search_mode","req":false,"def":"contains","type":"string","d":"Match mode.","notes":"prefix|suffix|contains|exact"}]},"getincomingcallstotalroot":{"cat":"incomingcalls","ex":"https://api.7kas.com:9080/7Kas?func=getincomingcallstotalroot&ukey=SRKEY&year=2026&month=7&root=5","params":[{"n":"year","req":true,"def":"","type":"integer","d":"Year.","notes":""},{"n":"month","req":true,"def":"","type":"integer","d":"Month, 1-12.","notes":""},{"n":"root","req":false,"def":"","type":"integer","d":"Root/operator id. Required for SuperRoot; operators use their own.","notes":"required when SuperRoot"}]},"getincomingcallscount":{"cat":"incomingcalls","ex":"https://api.7kas.com:9080/7Kas?func=getincomingcallscount&ukey=KEY&year=2026&month=7&model=vic","params":[{"n":"year","req":true,"def":"","type":"integer","d":"Year.","notes":""},{"n":"month","req":true,"def":"","type":"integer","d":"Month, 1-12.","notes":""},{"n":"model","req":false,"def":"vic","type":"string","d":"vic or tic.","notes":"valid: vic|tic"},{"n":"accountcodeid","req":false,"def":"","type":"integer","d":"Filter by account id (non-clients).","notes":""},{"n":"day","req":false,"def":"","type":"integer","d":"Filter by day.","notes":"model=vic only"},{"n":"hour","req":false,"def":"","type":"integer","d":"Filter by hour.","notes":"model=vic only, requires day"}]},"getincomingcallstotal":{"cat":"incomingcalls","ex":"https://api.7kas.com:9080/7Kas?func=getincomingcallstotal&ukey=KEY&year=2026&month=7","params":[{"n":"year","req":true,"def":"","type":"integer","d":"Year.","notes":""},{"n":"month","req":true,"def":"","type":"integer","d":"Month, 1-12.","notes":""}]},"getincomingcallsaccounttotal":{"cat":"incomingcalls","ex":"https://api.7kas.com:9080/7Kas?func=getincomingcallsaccounttotal&ukey=OPKEY&year=2026&month=7&accountcodeid=123","params":[{"n":"year","req":true,"def":"","type":"integer","d":"Year.","notes":""},{"n":"month","req":true,"def":"","type":"integer","d":"Month, 1-12.","notes":""},{"n":"accountcodeid","req":true,"def":"","type":"integer","d":"Account id.","notes":""}]},"getincomingcallsdetailtotal":{"cat":"incomingcalls","ex":"https://api.7kas.com:9080/7Kas?func=getincomingcallsdetailtotal&ukey=KEY&year=2026&month=7","params":[{"n":"year","req":true,"def":"","type":"integer","d":"Year.","notes":""},{"n":"month","req":true,"def":"","type":"integer","d":"Month, 1-12.","notes":""},{"n":"accountcodeid","req":false,"def":"","type":"integer","d":"Filter by account id (non-clients).","notes":""},{"n":"day","req":false,"def":"","type":"integer","d":"Filter by day (1-31).","notes":""},{"n":"hour","req":false,"def":"","type":"integer","d":"Filter by hour.","notes":"requires day"}]},"getclis":{"cat":"clis","ex":"https://api.7kas.com:9080/7Kas?func=getclis&ukey=KEY&limit=100","params":[{"n":"accountcode","req":false,"def":"","type":"string","d":"Filter by account code. Forced to the caller's own for clients.","notes":"max length 20"},{"n":"active","req":false,"def":"","type":"string","d":"Filter by active flag.","notes":"max length 2"},{"n":"route","req":false,"def":"","type":"string","d":"Filter by route.","notes":"max length 32"},{"n":"type","req":false,"def":"","type":"string","d":"Filter by CLI type.","notes":"max length 2"},{"n":"limit","req":false,"def":"1000","type":"integer","d":"Maximum rows to return (capped at 1000).","notes":""},{"n":"offset","req":false,"def":"0","type":"integer","d":"Pagination offset.","notes":""}]},"getwgpeers":{"cat":"wireguard","ex":"https://api.7kas.com:9080/7Kas?func=getwgpeers&ukey=OPKEY&server_id=1","params":[{"n":"server_id","req":true,"def":"","type":"integer","d":"WireGuard server id.","notes":""}]},"setwgstatus":{"cat":"wireguard","ex":"https://api.7kas.com:9080/7Kas?func=setwgstatus&ukey=OPKEY&host=h1&root=5&status=1","params":[{"n":"host","req":true,"def":"","type":"string","d":"Peer host id.","notes":""},{"n":"root","req":true,"def":"","type":"integer","d":"Operator root the peer belongs to.","notes":""},{"n":"status","req":true,"def":"","type":"integer","d":"New status (e.g. 0=disabled, 1=enabled).","notes":""}]},"registerwgserver":{"cat":"wireguard","ex":"https://api.7kas.com:9080/7Kas?func=registerwgserver&ukey=OPKEY&server_id=1&wg_pubkey=...&wg_listen_port=51820&wg_endpoint=vpn.example.com:51820","params":[{"n":"server_id","req":true,"def":"","type":"integer","d":"Server id.","notes":""},{"n":"wg_pubkey","req":true,"def":"","type":"string","d":"Server WireGuard public key (max 44).","notes":""},{"n":"wg_listen_port","req":true,"def":"","type":"integer","d":"UDP listen port.","notes":""},{"n":"wg_endpoint","req":true,"def":"","type":"string","d":"Public endpoint host:port (max 64).","notes":""}]},"registerwgdevice":{"cat":"wireguard","ex":"https://api.7kas.com:9080/7Kas?func=registerwgdevice&ukey=OPKEY&mac=AA:BB:CC:DD:EE:FF&wg_pubkey=...","params":[{"n":"mac","req":true,"def":"","type":"string","d":"Device MAC address (max 17).","notes":""},{"n":"wg_pubkey","req":true,"def":"","type":"string","d":"Device WireGuard public key (max 44).","notes":""}]},"getwgconfig":{"cat":"wireguard","ex":"https://api.7kas.com:9080/7Kas?func=getwgconfig&ukey=KEY&password=DEVICEPASS","params":[{"n":"password","req":true,"def":"","type":"string","d":"The device vpnpassword (max 128).","notes":""}]},"registervpnwgdevice":{"cat":"wireguard","ex":"https://api.7kas.com:9080/7Kas?func=registervpnwgdevice&ukey=KEY&host=h1&password=PASS&wg_pubkey=...","params":[{"n":"host","req":true,"def":"","type":"string","d":"VPN host id (max 32).","notes":""},{"n":"password","req":true,"def":"","type":"string","d":"VPN password (max 128).","notes":""},{"n":"wg_pubkey","req":true,"def":"","type":"string","d":"Device WireGuard public key (max 44).","notes":""}]},"getvpnwgconfig":{"cat":"wireguard","ex":"https://api.7kas.com:9080/7Kas?func=getvpnwgconfig&ukey=KEY&host=h1&password=PASS","params":[{"n":"host","req":true,"def":"","type":"string","d":"VPN host id (max 32).","notes":""},{"n":"password","req":true,"def":"","type":"string","d":"VPN password (max 128).","notes":""}]},"getpbxloclog":{"cat":"tucloud","ex":"https://api.7kas.com:9080/7Kas?func=getpbxloclog&ukey=KEY&year=2026&month=7&limit=100","params":[{"n":"year","req":true,"def":"","type":"integer","d":"Year (e.g. 2026).","notes":""},{"n":"month","req":true,"def":"","type":"integer","d":"Month, 1-12.","notes":""},{"n":"day","req":false,"def":"","type":"integer","d":"Filter by day of month (1-31).","notes":""},{"n":"hour","req":false,"def":"","type":"integer","d":"Filter by hour (0-23).","notes":"only valid together with day"},{"n":"accountcodeid","req":false,"def":"","type":"integer","d":"Filter by account id (non-clients). Forced to own for clients.","notes":""},{"n":"tucloudpbx_id","req":false,"def":"","type":"integer","d":"Filter by virtual PBX id.","notes":""},{"n":"loc_id","req":false,"def":"","type":"integer","d":"Filter by locution/IVR id.","notes":""},{"n":"pbxname","req":false,"def":"","type":"string","d":"Filter by PBX name.","notes":"max length 32"},{"n":"pressed","req":false,"def":"","type":"string","d":"Filter by DTMF key(s) pressed.","notes":"max length 80"},{"n":"src","req":false,"def":"","type":"string","d":"Filter by source number.","notes":"max length 80"},{"n":"dst","req":false,"def":"","type":"string","d":"Filter by destination number.","notes":"max length 80"},{"n":"limit","req":false,"def":"100","type":"integer","d":"Max rows (PostgreSQL up to 1000).","notes":""},{"n":"offset","req":false,"def":"0","type":"integer","d":"Pagination offset.","notes":""}]},"getrecordings":{"cat":"recordings","ex":"https://api.7kas.com:9080/7Kas?func=getrecordings&ukey=KEY&from=2026-07-01&to=2026-07-31","params":[{"n":"from","req":false,"def":"","type":"string","d":"Start date. Default: 31 days ago.","notes":"YYYY-MM-DD"},{"n":"to","req":false,"def":"","type":"string","d":"End date (inclusive). Default: today.","notes":"YYYY-MM-DD"},{"n":"hour","req":false,"def":"","type":"integer","d":"Filter to one hour of the day. Returns recordings whose start time falls in that hour (e.g. hour=14 => 14:00-14:59).","notes":"0-23"},{"n":"withtranscript","req":false,"def":"","type":"integer","d":"1 = only recordings that already have a transcript.","notes":""},{"n":"withsummary","req":false,"def":"","type":"integer","d":"1 = only recordings that already have a summary.","notes":""},{"n":"accountcode","req":false,"def":"","type":"integer","d":"Operators/SuperRoot only: filter to one account. Ignored/forced for clients.","notes":"string, max 20"},{"n":"root","req":false,"def":"","type":"integer","d":"SuperRoot only: filter to one operator root.","notes":""},{"n":"limit","req":false,"def":"100","type":"integer","d":"Max rows (up to 1000).","notes":""},{"n":"offset","req":false,"def":"0","type":"integer","d":"Pagination offset.","notes":""}]},"getrecordingtranscript":{"cat":"recordings","ex":"https://api.7kas.com:9080/7Kas?func=getrecordingtranscript&ukey=KEY&id=5270558&summary=1&format=text","params":[{"n":"id","req":false,"def":"","type":"integer","d":"Recording id. Provide id OR uniqueid.","notes":""},{"n":"uniqueid","req":false,"def":"","type":"string","d":"Call uniqueid. Provide id OR uniqueid.","notes":"max 80"},{"n":"summary","req":false,"def":"","type":"integer","d":"1 = include the summary (resumen) when available.","notes":""},{"n":"format","req":false,"def":"json","type":"string","d":"json = object; text = downloadable .txt.","notes":"json|text"}]},"getrecordingfile":{"cat":"recordings","ex":"https://api.7kas.com:9080/7Kas?func=getrecordingfile&ukey=KEY&id=5270558&dl=1","params":[{"n":"id","req":false,"def":"","type":"integer","d":"Recording id. Provide id OR uniqueid.","notes":""},{"n":"uniqueid","req":false,"def":"","type":"string","d":"Call uniqueid. Provide id OR uniqueid.","notes":"max 80"},{"n":"dl","req":false,"def":"","type":"integer","d":"1 = force download (Content-Disposition attachment).","notes":""}]},"getrecordingcertification":{"cat":"recordings","ex":"https://api.7kas.com:9080/7Kas?func=getrecordingcertification&ukey=KEY&id=5270558","params":[{"n":"id","req":false,"def":"","type":"integer","d":"Recording id. Provide id OR uniqueid.","notes":""},{"n":"uniqueid","req":false,"def":"","type":"string","d":"Call uniqueid. Provide id OR uniqueid.","notes":"max 80"}]}};
function el(t,a,x){var e=document.createElement(t);if(a){for(var k in a){e.setAttribute(k,a[k]);}}if(x!=null){e.textContent=x;}return e;}
function byId(id){return document.getElementById(id);}
function group(){var g={};Object.keys(CAT).forEach(function(n){var c=CAT[n].cat||'other';(g[c]=g[c]||[]).push(n);});return g;}
function buildURL(){
var uk=byId('ac-ukey').value.trim(), fn=byId('ac-func').value;
var qs='?func='+encodeURIComponent(fn)+'&ukey='+encodeURIComponent(uk||'YOUR_KEY');
(CAT[fn].params||[]).forEach(function(p){var e=byId('ac-p-'+p.n);var v=e?(''+e.value).trim():'';if(v){qs+='&'+encodeURIComponent(p.n)+'='+encodeURIComponent(v);}});
var url=API+qs; byId('ac-url').value=url; return url;
}
function renderParams(){
var fn=byId('ac-func').value, box=byId('ac-params'); box.innerHTML='';
(CAT[fn].params||[]).forEach(function(p){
var row=el('div',{'class':'ac-p'}), lab=el('label',{'for':'ac-p-'+p.n});
lab.appendChild(el('span',null,p.n+' '));
lab.appendChild(el('small',null,'('+p.type+(p.req?', required':', optional')+')'));
if(p.req){lab.appendChild(el('span',{'class':'ac-req'},' *'));}
row.appendChild(lab);
var inp=el('input',{id:'ac-p-'+p.n,type:'text',placeholder:(p.d||'')+(p.notes?' -- '+p.notes:'')});
if(p.def){inp.value=p.def;}
inp.addEventListener('input',buildURL); row.appendChild(inp); box.appendChild(row);
});
buildURL();
}
$(function(){
var host=byId('api-console-app'); if(!host||host.getAttribute('data-done')){return;} host.setAttribute('data-done','1'); host.innerHTML='';
var r1=el('div',{'class':'ac-row'});
r1.appendChild(el('label',{'for':'ac-ukey'},'Your API key (ukey)'));
r1.appendChild(el('input',{id:'ac-ukey',type:'text',placeholder:'paste your ukey here',autocomplete:'off',spellcheck:'false'})); host.appendChild(r1);
var r2=el('div',{'class':'ac-row'});
r2.appendChild(el('label',{'for':'ac-func'},'Function'));
var sel=el('select',{id:'ac-func'}), g=group();
Object.keys(g).sort().forEach(function(c){var og=el('optgroup',{label:c});g[c].sort().forEach(function(n){og.appendChild(el('option',{value:n},n));});sel.appendChild(og);});
sel.addEventListener('change',renderParams); r2.appendChild(sel); host.appendChild(r2);
host.appendChild(el('div',{id:'ac-params'}));
var r3=el('div',{'class':'ac-row'});
r3.appendChild(el('label',{'for':'ac-url'},'Request URL'));
r3.appendChild(el('textarea',{id:'ac-url',readonly:'readonly'})); host.appendChild(r3);
var bar=el('div',{'class':'ac-row'});
var run=el('button',null,'Run ▶ (open result)'); run.addEventListener('click',function(){window.open(buildURL(),'_blank','noopener');});
var cp=el('button',null,'Copy URL'); cp.addEventListener('click',function(){byId('ac-url').select();try{document.execCommand('copy');}catch(e){}});
bar.appendChild(run); bar.appendChild(cp); host.appendChild(bar);
var note=el('div',{'class':'ac-note'}); note.innerHTML='This runs a real call with your key. You only ever see your own data (identity is forced server-side). The result opens in a new tab as JSON.';
host.appendChild(note);
if(sel.options.length){ sel.value=('getcdr' in CAT)?'getcdr':sel.options[0].value; renderParams(); }
});
})();
/* === END restapi-generated === */
/* TuCloudAPI Console loader (tucloudapi) -- gated to its own page; bulk in MediaWiki:TuCloudAPIConsole.js. */
if (mw.config.get('wgPageName') === 'TuCloudAPI_Console') {
mw.loader.load('/index.php?title=MediaWiki:TuCloudAPIConsole.js&action=raw&ctype=text/javascript');
}

API unlockaccountcode

2026-11-05T13:47:47Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Unblocks (unlocks) an account (blocked=NO). Requires write permission (operator/SuperRoot, not read-only).

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>accountcodeid</code> || integer || Yes || — || Account id to unlock.
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=unlockaccountcode&ukey=OPKEY&accountcodeid=123</nowiki>

== Response ==
Object confirming the unlock.

----
Back to [[API VoIP]] · '''[[API Console|▶ Try it live]]''' · Profiles: [[API profile Operator]]
[[Category:API Operator]][[Category:API function]]

API setwgstatus

2026-11-05T13:47:47Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Enables/disables a WireGuard peer. Operators/SuperRoot only (client ukeys rejected).

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>host</code> || string || Yes || — || Peer host id.
|-
| <code>root</code> || integer || Yes || — || Operator root the peer belongs to.
|-
| <code>status</code> || integer || Yes || — || New status (e.g. 0=disabled, 1=enabled).
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=setwgstatus&ukey=OPKEY&host=h1&root=5&status=1</nowiki>

== Response ==
Object confirming the change.

----
Back to [[API VoIP]] · '''[[API Console|▶ Try it live]]''' · Profiles: [[API profile Operator]]
[[Category:API Operator]][[Category:API function]]

API registerwgserver

2026-11-05T13:47:46Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Registers/updates a WireGuard server (public key, listen port, endpoint). Operators/SuperRoot only.

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>server_id</code> || integer || Yes || — || Server id.
|-
| <code>wg_pubkey</code> || string || Yes || — || Server WireGuard public key (max 44).
|-
| <code>wg_listen_port</code> || integer || Yes || — || UDP listen port.
|-
| <code>wg_endpoint</code> || string || Yes || — || Public endpoint host:port (max 64).
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=registerwgserver&ukey=OPKEY&server_id=1&wg_pubkey=...&wg_listen_port=51820&wg_endpoint=vpn.example.com:51820</nowiki>

== Response ==
Object confirming registration.

----
Back to [[API VoIP]] · '''[[API Console|▶ Try it live]]''' · Profiles: [[API profile Operator]]
[[Category:API Operator]][[Category:API function]]

API registerwgdevice

2026-11-05T13:47:46Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Registers an SSIP device's WireGuard public key (keyed by device MAC). Operators/SuperRoot only.

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>mac</code> || string || Yes || — || Device MAC address (max 17).
|-
| <code>wg_pubkey</code> || string || Yes || — || Device WireGuard public key (max 44).
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=registerwgdevice&ukey=OPKEY&mac=AA:BB:CC:DD:EE:FF&wg_pubkey=...</nowiki>

== Response ==
Object confirming registration.

----
Back to [[API VoIP]] · '''[[API Console|▶ Try it live]]''' · Profiles: [[API profile Operator]]
[[Category:API Operator]][[Category:API function]]

API registervpnwgdevice

2026-11-05T13:47:45Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Registers a non-SSIP VPN WireGuard device, authenticated by (host, password) of the VPN pair (voip_vtun). No role gate.

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>host</code> || string || Yes || — || VPN host id (max 32).
|-
| <code>password</code> || string || Yes || — || VPN password (max 128).
|-
| <code>wg_pubkey</code> || string || Yes || — || Device WireGuard public key (max 44).
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=registervpnwgdevice&ukey=KEY&host=h1&password=PASS&wg_pubkey=...</nowiki>

== Response ==
Object confirming registration.

----
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]]

API profile Operator

2026-11-05T13:47:45Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

''Profile '''Operator''' (reseller): 37 functions over its own root. Sees account and root prices and profit (VOC). No SuperRoot-only functions.''

== Meta / discovery ==
* [[API help]] — Lists the API functions available to the role of the calling ukey, with each function's description, parameters (meaning, optional/default), an example call and the response format.
== Outgoing call billing ==
* [[API getcallsbilling]] — Outgoing-call billing records for a period.
* [[API getcallsbillingtotalroot]] — Monthly billing total for one root/operator (TOC).
* [[API getcallsbillingcount]] — Row count for the given filter (smart pagination).
* [[API getcallsbillingtotal]] — Grand billing total for the caller's scope for the month.
* [[API getcallsbillingaccounttotal]] — Monthly billing total for one account.
* [[API getcallsbillingdetailtotal]] — Total over VOC detail rows matching the filter (with total_rows for pagination).
* [[API getcallsbillingcomis]] — Commission billing for a commissioner: aggregates the calls of the accounts assigned to the caller (accountcode_comis) and returns commission minutes/amount — never exposing costs.
== Pay-per-use services ==
* [[API getservices]] — Detail of pay-per-use services (dtype=SERVICIOS, e.g.
* [[API getservicestotal]] — Aggregate total of pay-per-use services for the period (all services, or one via service=<prefix>).
== Incoming calls ==
* [[API getincomingcalls]] — Incoming-call records for a period.
* [[API getincomingcallstotalroot]] — Monthly incoming total for one root/operator (TIC).
* [[API getincomingcallscount]] — Row count for the given filter (smart pagination).
* [[API getincomingcallstotal]] — Grand incoming total for the caller's scope for the month.
* [[API getincomingcallsaccounttotal]] — Monthly incoming total for one account.
* [[API getincomingcallsdetailtotal]] — Total over VIC detail rows matching the filter (with total_rows for pagination).
== CDR (call detail) ==
* [[API getcdr]] — Call Detail Records (CDR) for a period.
== Call recordings ==
* [[API getrecordings]] — Lists the caller's call recordings with availability flags (has_transcript, has_summary, has_audio).
* [[API getrecordingtranscript]] — Returns the transcription of one of the caller's recordings, with or without the summary (resumen).
* [[API getrecordingfile]] — Downloads the audio recording (stereo MP3) of one of the caller's calls.
* [[API getrecordingcertification]] — Downloads the integrity/veracity certification of one of the caller's recordings: file, user, date, time, uniqueid, src, dst and the SHA-512 hash (matches voip_callrecord.recordhash).
== CLIs / lines ==
* [[API getclis]] — Lists CLIs (caller-line identities / DDIs) for the account.
== Tucloud PBX ==
* [[API getpbxloclog]] — Tucloud PBX IVR/locution DTMF key-press log for a period.
== Account management ==
* [[API getaccountcodeid]] — Lists (id, accountcode) pairs of the accounts under the caller.
* [[API getaccountcodedata]] — Returns full account profile rows (view_voip_users_api) for the caller's accounts.
* [[API lockaccountcode]] — Blocks (locks) an account (blocked=SI).
* [[API unlockaccountcode]] — Unblocks (unlocks) an account (blocked=NO).
* [[API addaccountcode]] — Creates a new account (client) under the caller.
* [[API getcredit]] — Returns credit and status (credit, credit_limit, creditalarm, email, blocked).
== WireGuard / VPN ==
* [[API getwgpeers]] — Lists WireGuard peers of a server (SSIP-transparent union of SSIP + VPN pairs).
* [[API setwgstatus]] — Enables/disables a WireGuard peer.
* [[API registerwgserver]] — Registers/updates a WireGuard server (public key, listen port, endpoint).
* [[API registerwgdevice]] — Registers an SSIP device's WireGuard public key (keyed by device MAC).
* [[API getwgconfig]] — Returns the WireGuard config for an SSIP device, authenticated by the device's vpnpassword (no role gate — any valid ukey with the correct password).
* [[API registervpnwgdevice]] — Registers a non-SSIP VPN WireGuard device, authenticated by (host, password) of the VPN pair (voip_vtun).
* [[API getvpnwgconfig]] — Returns the WireGuard config for a non-SSIP VPN device, authenticated by (host, password) of the VPN pair.
== Diagnostics ==
* [[API helloworld]] — Health check / connectivity test.

----
[[API VoIP]] · [[API Console|▶ Try it live]]
[[Category:API profile]]

API profile Client (of operator)

2026-11-05T13:47:44Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

''Profile '''Client of an operator''' (root>0): 24 functions, own data only. Sees '''only its own selling price''' (root column). Identity forced by the server.''

== Meta / discovery ==
* [[API help]] — Lists the API functions available to the role of the calling ukey, with each function's description, parameters (meaning, optional/default), an example call and the response format.
== Outgoing call billing ==
* [[API getcallsbilling]] — Outgoing-call billing records for a period.
* [[API getcallsbillingcount]] — Row count for the given filter (smart pagination).
* [[API getcallsbillingtotal]] — Grand billing total for the caller's scope for the month.
* [[API getcallsbillingdetailtotal]] — Total over VOC detail rows matching the filter (with total_rows for pagination).
* [[API getcallsbillingcomis]] — Commission billing for a commissioner: aggregates the calls of the accounts assigned to the caller (accountcode_comis) and returns commission minutes/amount — never exposing costs.
== Pay-per-use services ==
* [[API getservices]] — Detail of pay-per-use services (dtype=SERVICIOS, e.g.
* [[API getservicestotal]] — Aggregate total of pay-per-use services for the period (all services, or one via service=<prefix>).
== Incoming calls ==
* [[API getincomingcalls]] — Incoming-call records for a period.
* [[API getincomingcallscount]] — Row count for the given filter (smart pagination).
* [[API getincomingcallstotal]] — Grand incoming total for the caller's scope for the month.
* [[API getincomingcallsdetailtotal]] — Total over VIC detail rows matching the filter (with total_rows for pagination).
== CDR (call detail) ==
* [[API getcdr]] — Call Detail Records (CDR) for a period.
== Call recordings ==
* [[API getrecordings]] — Lists the caller's call recordings with availability flags (has_transcript, has_summary, has_audio).
* [[API getrecordingtranscript]] — Returns the transcription of one of the caller's recordings, with or without the summary (resumen).
* [[API getrecordingfile]] — Downloads the audio recording (stereo MP3) of one of the caller's calls.
* [[API getrecordingcertification]] — Downloads the integrity/veracity certification of one of the caller's recordings: file, user, date, time, uniqueid, src, dst and the SHA-512 hash (matches voip_callrecord.recordhash).
== CLIs / lines ==
* [[API getclis]] — Lists CLIs (caller-line identities / DDIs) for the account.
== Tucloud PBX ==
* [[API getpbxloclog]] — Tucloud PBX IVR/locution DTMF key-press log for a period.
== Account management ==
* [[API getcredit]] — Returns credit and status (credit, credit_limit, creditalarm, email, blocked).
== WireGuard / VPN ==
* [[API getwgconfig]] — Returns the WireGuard config for an SSIP device, authenticated by the device's vpnpassword (no role gate — any valid ukey with the correct password).
* [[API registervpnwgdevice]] — Registers a non-SSIP VPN WireGuard device, authenticated by (host, password) of the VPN pair (voip_vtun).
* [[API getvpnwgconfig]] — Returns the WireGuard config for a non-SSIP VPN device, authenticated by (host, password) of the VPN pair.
== Diagnostics ==
* [[API helloworld]] — Health check / connectivity test.

----
[[API VoIP]] · [[API Console|▶ Try it live]]
[[Category:API profile]]

API profile Client (direct)

2026-11-05T13:47:44Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

''Profile '''Direct 7Kas client''' (root=0): 24 functions, own data only. Sees '''only its own selling price''' (accountcode column). Identity forced by the server.''

== Meta / discovery ==
* [[API help]] — Lists the API functions available to the role of the calling ukey, with each function's description, parameters (meaning, optional/default), an example call and the response format.
== Outgoing call billing ==
* [[API getcallsbilling]] — Outgoing-call billing records for a period.
* [[API getcallsbillingcount]] — Row count for the given filter (smart pagination).
* [[API getcallsbillingtotal]] — Grand billing total for the caller's scope for the month.
* [[API getcallsbillingdetailtotal]] — Total over VOC detail rows matching the filter (with total_rows for pagination).
* [[API getcallsbillingcomis]] — Commission billing for a commissioner: aggregates the calls of the accounts assigned to the caller (accountcode_comis) and returns commission minutes/amount — never exposing costs.
== Pay-per-use services ==
* [[API getservices]] — Detail of pay-per-use services (dtype=SERVICIOS, e.g.
* [[API getservicestotal]] — Aggregate total of pay-per-use services for the period (all services, or one via service=<prefix>).
== Incoming calls ==
* [[API getincomingcalls]] — Incoming-call records for a period.
* [[API getincomingcallscount]] — Row count for the given filter (smart pagination).
* [[API getincomingcallstotal]] — Grand incoming total for the caller's scope for the month.
* [[API getincomingcallsdetailtotal]] — Total over VIC detail rows matching the filter (with total_rows for pagination).
== CDR (call detail) ==
* [[API getcdr]] — Call Detail Records (CDR) for a period.
== Call recordings ==
* [[API getrecordings]] — Lists the caller's call recordings with availability flags (has_transcript, has_summary, has_audio).
* [[API getrecordingtranscript]] — Returns the transcription of one of the caller's recordings, with or without the summary (resumen).
* [[API getrecordingfile]] — Downloads the audio recording (stereo MP3) of one of the caller's calls.
* [[API getrecordingcertification]] — Downloads the integrity/veracity certification of one of the caller's recordings: file, user, date, time, uniqueid, src, dst and the SHA-512 hash (matches voip_callrecord.recordhash).
== CLIs / lines ==
* [[API getclis]] — Lists CLIs (caller-line identities / DDIs) for the account.
== Tucloud PBX ==
* [[API getpbxloclog]] — Tucloud PBX IVR/locution DTMF key-press log for a period.
== Account management ==
* [[API getcredit]] — Returns credit and status (credit, credit_limit, creditalarm, email, blocked).
== WireGuard / VPN ==
* [[API getwgconfig]] — Returns the WireGuard config for an SSIP device, authenticated by the device's vpnpassword (no role gate — any valid ukey with the correct password).
* [[API registervpnwgdevice]] — Registers a non-SSIP VPN WireGuard device, authenticated by (host, password) of the VPN pair (voip_vtun).
* [[API getvpnwgconfig]] — Returns the WireGuard config for a non-SSIP VPN device, authenticated by (host, password) of the VPN pair.
== Diagnostics ==
* [[API helloworld]] — Health check / connectivity test.

----
[[API VoIP]] · [[API Console|▶ Try it live]]
[[Category:API profile]]

API lockaccountcode

2026-11-05T13:47:43Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Blocks (locks) an account (blocked=SI). Requires write permission (operator/SuperRoot, not read-only).

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>accountcodeid</code> || integer || Yes || — || Account id to lock.
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=lockaccountcode&ukey=OPKEY&accountcodeid=123</nowiki>

== Response ==
Object confirming the lock.

----
Back to [[API VoIP]] · '''[[API Console|▶ Try it live]]''' · Profiles: [[API profile Operator]]
[[Category:API Operator]][[Category:API function]]

API help

2026-11-05T13:47:43Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

{{Note|This is the '''self-discovery''' endpoint. It returns the list of functions your <code>ukey</code> can call, each fully documented. This whole wiki is generated from it.}}

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

== Description ==
Lists the API functions available to the role of the calling ukey, with each function's description, parameters (meaning, optional/default), an example call and the response format. Optional name=<func> returns just that function.

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>name</code> || string || No || — || Return only this function's documentation. Omit for the full catalogue.
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=help&ukey=KEY</nowiki>

== Response ==
Object: {api, url, authentication, response_format, role, count, functions:[{name, category, description, parameters:[{name,type,required,default,description,notes}], example, response}]}.

----
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]]

API helloworld

2026-11-05T13:47:43Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Health check / connectivity test. Returns a fixed greeting; useful to verify the API is up and the ukey is valid.

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

== Parameters ==
None beyond <code>ukey</code> and <code>func=helloworld</code>.

== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=helloworld&ukey=KEY</nowiki>

== Response ==
Fixed object: {"Test":"Hola Mundo"}.

----
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]]

API getwgpeers

2026-11-05T13:47:42Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Lists WireGuard peers of a server (SSIP-transparent union of SSIP + VPN pairs). Operators see their own scope; SuperRoot all. Not available to clients.

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>server_id</code> || integer || Yes || — || WireGuard server id.
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getwgpeers&ukey=OPKEY&server_id=1</nowiki>

== Response ==
FillRecords2JSON: peer rows.

----
Back to [[API VoIP]] · '''[[API Console|▶ Try it live]]''' · Profiles: [[API profile Operator]]
[[Category:API Operator]][[Category:API function]]

API getwgconfig

2026-11-05T13:47:42Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Returns the WireGuard config for an SSIP device, authenticated by the device's vpnpassword (no role gate — any valid ukey with the correct password).

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>password</code> || string || Yes || — || The device vpnpassword (max 128).
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getwgconfig&ukey=KEY&password=DEVICEPASS</nowiki>

== Response ==
Object/records with the WireGuard configuration.

----
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]]

API getvpnwgconfig

2026-11-05T13:47:42Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Returns the WireGuard config for a non-SSIP VPN device, authenticated by (host, password) of the VPN pair. No role gate.

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>host</code> || string || Yes || — || VPN host id (max 32).
|-
| <code>password</code> || string || Yes || — || VPN password (max 128).
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getvpnwgconfig&ukey=KEY&host=h1&password=PASS</nowiki>

== Response ==
Object/records with the WireGuard configuration.

----
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]]

API getservicestotal

2026-11-05T13:47:41Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Aggregate total of pay-per-use services for the period (all services, or one via service=<prefix>).

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>year</code> || integer || Yes || — || Year.
|-
| <code>month</code> || integer || Yes || — || Month, 1-12.
|-
| <code>service</code> || string || No || — || Service prefix. Omit for all. (max 20)
|-
| <code>accountcode</code> || string || No || — || Filter by account (non-clients). (max 20)
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getservicestotal&ukey=KEY&year=2026&month=7</nowiki>

== Response ==
FillRecords2JSON: one aggregate row (columns depend on role).

== Column visibility by profile ==
Pricing/cost columns depend on the caller's profile (GOD LAW):
* '''SuperRoot''' — provider cost + selling price + profit (VOC only).
* '''Operator''' — account price + root price + profit (VOC only).
* '''Client (direct, root=0)''' — only its own selling price (accountcode column).
* '''Client (of operator, root>0)''' — only its own selling price (root column).

----
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]]

API getservices

2026-11-05T13:47:41Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Detail of pay-per-use services (dtype=SERVICIOS, e.g. STT osttrc), decoupled from calls. Optional service=<prefix> narrows to one service. Same role columns and SHM+PostgreSQL behaviour as getcallsbilling (voc).

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>year</code> || integer || Yes || — || Year.
|-
| <code>month</code> || integer || Yes || — || Month, 1-12.
|-
| <code>service</code> || string || No || — || Service prefix (e.g. osttrc). Omit for all services. (max 20)
|-
| <code>accountcode</code> || string || No || — || Filter by account (non-clients). Forced to own for clients. (max 20)
|-
| <code>day</code> || integer || No || — || Filter by day (1-31).
|-
| <code>hour</code> || integer || No || — || Filter by hour. (requires day)
|-
| <code>limit</code> || integer || No || <code>100</code> || Max rows (SHM up to 10000, PostgreSQL up to 1000).
|-
| <code>offset</code> || integer || No || <code>0</code> || Pagination offset.
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getservices&ukey=KEY&year=2026&month=7&limit=100</nowiki>

== Response ==
FillRecords2JSON records; every row has dtype=SERVICIOS and prefix=the service.

== Column visibility by profile ==
Pricing/cost columns depend on the caller's profile (GOD LAW):
* '''SuperRoot''' — provider cost + selling price + profit (VOC only).
* '''Operator''' — account price + root price + profit (VOC only).
* '''Client (direct, root=0)''' — only its own selling price (accountcode column).
* '''Client (of operator, root>0)''' — only its own selling price (root column).

----
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]]

API getrecordingtranscript

2026-11-05T13:47:40Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

''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 <code>ukey</code> parameter.

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>id</code> || integer || No || — || Recording id. Provide id OR uniqueid.
|-
| <code>uniqueid</code> || string || No || — || Call uniqueid. Provide id OR uniqueid. (max 80)
|-
| <code>summary</code> || integer || No || — || 1 = include the summary (resumen) when available.
|-
| <code>format</code> || string || No || <code>json</code> || json = object; text = downloadable .txt. (json|text)
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getrecordingtranscript&ukey=KEY&id=5270558&summary=1&format=text</nowiki>

== 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]] · '''[[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]]

API getrecordings

2026-11-05T13:47:40Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

''7Kas VoIP REST API function. Available to: '''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>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). (0-23)
|-
| <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 Operator]], [[API profile Client (of operator)]], [[API profile Client (direct)]]
[[Category:API Operator]][[Category:API Client]][[Category:API function]]

API getrecordingfile

2026-11-05T13:47:39Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Downloads the audio recording (stereo MP3) of one of the caller's calls. Select by id OR uniqueid. Streams with HTTP Range (206) so players can seek. Scoped to the caller's (root, accountcode) by the key; only files still on disk are served (404-as-{} otherwise).

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>id</code> || integer || No || — || Recording id. Provide id OR uniqueid.
|-
| <code>uniqueid</code> || string || No || — || Call uniqueid. Provide id OR uniqueid. (max 80)
|-
| <code>dl</code> || integer || No || — || 1 = force download (Content-Disposition attachment).
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getrecordingfile&ukey=KEY&id=5270558&dl=1</nowiki>

== Response ==
audio/mpeg body (supports Range/206). On missing/foreign/no-file: {}.

----
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]]

API getrecordingcertification

2026-11-05T13:47:39Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Downloads the integrity/veracity certification of one of the caller's recordings: file, user, date, time, uniqueid, src, dst and the SHA-512 hash (matches voip_callrecord.recordhash). New recordings deliver it as JSON (application/json); older ones as a legacy plain-text file, transparently. Select by id OR uniqueid. Scoped by the key.

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>id</code> || integer || No || — || Recording id. Provide id OR uniqueid.
|-
| <code>uniqueid</code> || string || No || — || Call uniqueid. Provide id OR uniqueid. (max 80)
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getrecordingcertification&ukey=KEY&id=5270558</nowiki>

== Response ==
application/json body (Content-Disposition attachment "<uniqueid>.cert.json") for migrated recordings; text/plain "<uniqueid>.cert.txt" for legacy ones. On missing/foreign: {}.

----
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]]

API getpbxloclog

2026-11-05T13:47:38Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Tucloud PBX IVR/locution DTMF key-press log for a period. Role-resolved (clients see only their own account; operators their scope; SuperRoot all). Single SQL function; unset filters default to NULL server-side.

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>year</code> || integer || Yes || — || Year (e.g. 2026).
|-
| <code>month</code> || integer || Yes || — || Month, 1-12.
|-
| <code>day</code> || integer || No || — || Filter by day of month (1-31).
|-
| <code>hour</code> || integer || No || — || Filter by hour (0-23). (only valid together with day)
|-
| <code>accountcodeid</code> || integer || No || — || Filter by account id (non-clients). Forced to own for clients.
|-
| <code>tucloudpbx_id</code> || integer || No || — || Filter by virtual PBX id.
|-
| <code>loc_id</code> || integer || No || — || Filter by locution/IVR id.
|-
| <code>pbxname</code> || string || No || — || Filter by PBX name. (max length 32)
|-
| <code>pressed</code> || string || No || — || Filter by DTMF key(s) pressed. (max length 80)
|-
| <code>src</code> || string || No || — || Filter by source number. (max length 80)
|-
| <code>dst</code> || string || No || — || Filter by destination number. (max length 80)
|-
| <code>limit</code> || integer || No || <code>100</code> || Max rows (PostgreSQL up to 1000).
|-
| <code>offset</code> || integer || No || <code>0</code> || Pagination offset.
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getpbxloclog&ukey=KEY&year=2026&month=7&limit=100</nowiki>

== Response ==
FillRecords2JSON records.

----
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]]

API getincomingcallstotalroot

2026-11-05T13:47:38Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Monthly incoming total for one root/operator (TIC). Not available to clients.

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>year</code> || integer || Yes || — || Year.
|-
| <code>month</code> || integer || Yes || — || Month, 1-12.
|-
| <code>root</code> || integer || No || — || Root/operator id. Required for SuperRoot; operators use their own. (required when SuperRoot)
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getincomingcallstotalroot&ukey=SRKEY&year=2026&month=7&root=5</nowiki>

== Response ==
FillRecords2JSON: one aggregate row.

== Column visibility by profile ==
Pricing/cost columns depend on the caller's profile (GOD LAW):
* '''SuperRoot''' — provider cost + selling price + profit (VOC only).
* '''Operator''' — account price + root price + profit (VOC only).
* '''Client (direct, root=0)''' — only its own selling price (accountcode column).
* '''Client (of operator, root>0)''' — only its own selling price (root column).

----
Back to [[API VoIP]] · '''[[API Console|▶ Try it live]]''' · Profiles: [[API profile Operator]]
[[Category:API Operator]][[Category:API function]]

API getincomingcallstotal

2026-11-05T13:47:38Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Grand incoming total for the caller's scope for the month.

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>year</code> || integer || Yes || — || Year.
|-
| <code>month</code> || integer || Yes || — || Month, 1-12.
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getincomingcallstotal&ukey=KEY&year=2026&month=7</nowiki>

== Response ==
FillRecords2JSON: one aggregate row (columns depend on role).

== Column visibility by profile ==
Pricing/cost columns depend on the caller's profile (GOD LAW):
* '''SuperRoot''' — provider cost + selling price + profit (VOC only).
* '''Operator''' — account price + root price + profit (VOC only).
* '''Client (direct, root=0)''' — only its own selling price (accountcode column).
* '''Client (of operator, root>0)''' — only its own selling price (root column).

----
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]]

API getincomingcallsdetailtotal

2026-11-05T13:47:37Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Total over VIC detail rows matching the filter (with total_rows for pagination). Same filters/search as getincomingcalls (vic).

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>year</code> || integer || Yes || — || Year.
|-
| <code>month</code> || integer || Yes || — || Month, 1-12.
|-
| <code>accountcodeid</code> || integer || No || — || Filter by account id (non-clients).
|-
| <code>day</code> || integer || No || — || Filter by day (1-31).
|-
| <code>hour</code> || integer || No || — || Filter by hour. (requires day)
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getincomingcallsdetailtotal&ukey=KEY&year=2026&month=7</nowiki>

== Response ==
FillRecords2JSON: one aggregate row incl. total_rows.

== Column visibility by profile ==
Pricing/cost columns depend on the caller's profile (GOD LAW):
* '''SuperRoot''' — provider cost + selling price + profit (VOC only).
* '''Operator''' — account price + root price + profit (VOC only).
* '''Client (direct, root=0)''' — only its own selling price (accountcode column).
* '''Client (of operator, root>0)''' — only its own selling price (root column).

----
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]]

API getincomingcallscount

2026-11-05T13:47:37Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Row count for the given filter (smart pagination). model=vic|tic.

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>year</code> || integer || Yes || — || Year.
|-
| <code>month</code> || integer || Yes || — || Month, 1-12.
|-
| <code>model</code> || string || No || <code>vic</code> || vic or tic. (valid: vic|tic)
|-
| <code>accountcodeid</code> || integer || No || — || Filter by account id (non-clients).
|-
| <code>day</code> || integer || No || — || Filter by day. (model=vic only)
|-
| <code>hour</code> || integer || No || — || Filter by hour. (model=vic only, requires day)
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getincomingcallscount&ukey=KEY&year=2026&month=7&model=vic</nowiki>

== Response ==
Object: {"total_rows":N}.

== Column visibility by profile ==
Pricing/cost columns depend on the caller's profile (GOD LAW):
* '''SuperRoot''' — provider cost + selling price + profit (VOC only).
* '''Operator''' — account price + root price + profit (VOC only).
* '''Client (direct, root=0)''' — only its own selling price (accountcode column).
* '''Client (of operator, root>0)''' — only its own selling price (root column).

----
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]]

API getincomingcallsaccounttotal

2026-11-05T13:47:36Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Monthly incoming total for one account. Not available to clients.

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>year</code> || integer || Yes || — || Year.
|-
| <code>month</code> || integer || Yes || — || Month, 1-12.
|-
| <code>accountcodeid</code> || integer || Yes || — || Account id.
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getincomingcallsaccounttotal&ukey=OPKEY&year=2026&month=7&accountcodeid=123</nowiki>

== Response ==
FillRecords2JSON: one aggregate row.

== Column visibility by profile ==
Pricing/cost columns depend on the caller's profile (GOD LAW):
* '''SuperRoot''' — provider cost + selling price + profit (VOC only).
* '''Operator''' — account price + root price + profit (VOC only).
* '''Client (direct, root=0)''' — only its own selling price (accountcode column).
* '''Client (of operator, root>0)''' — only its own selling price (root column).

----
Back to [[API VoIP]] · '''[[API Console|▶ Try it live]]''' · Profiles: [[API profile Operator]]
[[Category:API Operator]][[Category:API function]]

API getincomingcalls

2026-11-05T13:47:36Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Incoming-call records for a period. model=vic (detail, supports day/hour) or tic (totals). Role-based columns: clients see only their own account (accountcodeid forced) and their selling price; operators their scope; SuperRoot everything incl. provider costs. SHM fast-path + PostgreSQL fallback. Server-side search on src/dst.

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>year</code> || integer || Yes || — || Year (e.g. 2026).
|-
| <code>month</code> || integer || Yes || — || Month, 1-12.
|-
| <code>model</code> || string || No || <code>vic</code> || vic = detail records; tic = totals. (valid: vic|tic (case-insensitive))
|-
| <code>accountcodeid</code> || integer || No || — || Filter by account id (non-clients). Forced to own for clients.
|-
| <code>day</code> || integer || No || — || Filter by day (1-31). (model=vic only)
|-
| <code>hour</code> || integer || No || — || Filter by hour (0-23). (model=vic only, requires day)
|-
| <code>limit</code> || integer || No || <code>100</code> || Max rows. SHM up to 10000, PostgreSQL up to 1000.
|-
| <code>offset</code> || integer || No || <code>0</code> || Pagination offset.
|-
| <code>search</code> || string || No || — || Server-side search pattern. (max 40)
|-
| <code>search_fields</code> || string || No || — || Comma-separated fields to search (whitelist: src, dst). (max 200)
|-
| <code>search_mode</code> || string || No || <code>contains</code> || Match mode. (prefix|suffix|contains|exact)
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getincomingcalls&ukey=KEY&year=2026&month=7&model=vic&limit=100</nowiki>

== Response ==
FillRecords2JSON records (columns depend on role).

== Column visibility by profile ==
Pricing/cost columns depend on the caller's profile (GOD LAW):
* '''SuperRoot''' — provider cost + selling price + profit (VOC only).
* '''Operator''' — account price + root price + profit (VOC only).
* '''Client (direct, root=0)''' — only its own selling price (accountcode column).
* '''Client (of operator, root>0)''' — only its own selling price (root column).

----
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]]

API getcredit

2026-11-05T13:47:36Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Returns credit and status (credit, credit_limit, creditalarm, email, blocked). Any role: clients (and operators/SuperRoot without accountcode) get their own; operators/SuperRoot with accountcode query that account within their scope.

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>accountcode</code> || string || No || — || Account to query (operators/SuperRoot only). Omit for your own. (max length 20)
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getcredit&ukey=KEY</nowiki>

== Response ==
FillRecords2JSON: fields [credit, credit_limit, creditalarm, email, blocked].

----
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]]

API getclis

2026-11-05T13:47:35Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Lists CLIs (caller-line identities / DDIs) for the account. Clients see only their own account's CLIs (accountcode is forced); operators and SuperRoot see their scope.

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>accountcode</code> || string || No || — || Filter by account code. Forced to the caller's own for clients. (max length 20)
|-
| <code>active</code> || string || No || — || Filter by active flag. (max length 2)
|-
| <code>route</code> || string || No || — || Filter by route. (max length 32)
|-
| <code>type</code> || string || No || — || Filter by CLI type. (max length 2)
|-
| <code>limit</code> || integer || No || <code>1000</code> || Maximum rows to return (capped at 1000).
|-
| <code>offset</code> || integer || No || <code>0</code> || Pagination offset.
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getclis&ukey=KEY&limit=100</nowiki>

== Response ==
FillRecords2JSON records: {"RecordCount":N,"fields":[...],"1":[...],...}.

----
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]]

API getcdr

2026-11-05T13:47:35Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Call Detail Records (CDR) for a period. One function serves all roles (CDR has no pricing columns). Clients see only their own account (accountcodeid is forced); operators their scope; SuperRoot everything. Served from SHM cache with PostgreSQL fallback.

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>year</code> || integer || Yes || — || Year of the records (e.g. 2026).
|-
| <code>month</code> || integer || Yes || — || Month, 1-12.
|-
| <code>day</code> || integer || No || — || Filter by day of month (1-31).
|-
| <code>hour</code> || integer || No || — || Filter by hour (0-23). (only valid together with day)
|-
| <code>accountcodeid</code> || integer || No || — || Filter by account id. Ignored/forced to the caller's own for clients.
|-
| <code>userfield</code> || string || No || — || Filter by tucloud PBX id (the CDR userfield column). One accountcode can host several PBXs, so accountcodeid alone does not isolate a switchboard. (strict: rows whose userfield is empty never match)
|-
| <code>limit</code> || integer || No || <code>100</code> || Max rows. SHM fast-path up to 10000, PostgreSQL fallback up to 1000.
|-
| <code>offset</code> || integer || No || <code>0</code> || Pagination offset.
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getcdr&ukey=KEY&year=2026&month=7&limit=100</nowiki>

== Response ==
FillRecords2JSON records: {"RecordCount":N,"fields":[...],"1":[...],...}. Columns: calldate, clisrc, clidst, clid, src, dst, billsec, lastapp, disposition, uniqueid, channel, dstchannel, callfrom. callfrom = call-direction code (0 = undetermined, 1 = incoming/entrante, 2 = outgoing/saliente, 3 = incoming re-launched as outgoing). Source of truth: the COMMENT on tucall.voip_cdr.callfrom.

== Column visibility by profile ==
Pricing/cost columns depend on the caller's profile (GOD LAW):
* '''SuperRoot''' — provider cost + selling price + profit (VOC only).
* '''Operator''' — account price + root price + profit (VOC only).
* '''Client (direct, root=0)''' — only its own selling price (accountcode column).
* '''Client (of operator, root>0)''' — only its own selling price (root column).

----
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]]

API getcallsbillingtotalroot

2026-11-05T13:47:34Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Monthly billing total for one root/operator (TOC). Not available to clients.

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>year</code> || integer || Yes || — || Year.
|-
| <code>month</code> || integer || Yes || — || Month, 1-12.
|-
| <code>root</code> || integer || No || — || Root/operator id. Required for SuperRoot; operators use their own. (required when SuperRoot)
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getcallsbillingtotalroot&ukey=SRKEY&year=2026&month=7&root=5</nowiki>

== Response ==
FillRecords2JSON: one aggregate row.

== Column visibility by profile ==
Pricing/cost columns depend on the caller's profile (GOD LAW):
* '''SuperRoot''' — provider cost + selling price + profit (VOC only).
* '''Operator''' — account price + root price + profit (VOC only).
* '''Client (direct, root=0)''' — only its own selling price (accountcode column).
* '''Client (of operator, root>0)''' — only its own selling price (root column).

----
Back to [[API VoIP]] · '''[[API Console|▶ Try it live]]''' · Profiles: [[API profile Operator]]
[[Category:API Operator]][[Category:API function]]

API getcallsbillingtotal

2026-11-05T13:47:34Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Grand billing total for the caller's scope for the month.

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>year</code> || integer || Yes || — || Year.
|-
| <code>month</code> || integer || Yes || — || Month, 1-12.
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getcallsbillingtotal&ukey=KEY&year=2026&month=7</nowiki>

== Response ==
FillRecords2JSON: one aggregate row (columns depend on role).

== Column visibility by profile ==
Pricing/cost columns depend on the caller's profile (GOD LAW):
* '''SuperRoot''' — provider cost + selling price + profit (VOC only).
* '''Operator''' — account price + root price + profit (VOC only).
* '''Client (direct, root=0)''' — only its own selling price (accountcode column).
* '''Client (of operator, root>0)''' — only its own selling price (root column).

----
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]]

API getcallsbillingdetailtotal

2026-11-05T13:47:34Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Total over VOC detail rows matching the filter (with total_rows for pagination). Same filters/search as getcallsbilling (voc).

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>year</code> || integer || Yes || — || Year.
|-
| <code>month</code> || integer || Yes || — || Month, 1-12.
|-
| <code>accountcode</code> || string || No || — || Filter by account code (non-clients). (max 20)
|-
| <code>day</code> || integer || No || — || Filter by day (1-31).
|-
| <code>hour</code> || integer || No || — || Filter by hour. (requires day)
|-
| <code>search</code> || string || No || — || Server-side search pattern. (max 40)
|-
| <code>search_fields</code> || string || No || — || Comma-separated searchable fields. (max 200)
|-
| <code>search_mode</code> || string || No || <code>contains</code> || Match mode. (prefix|suffix|contains|exact)
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getcallsbillingdetailtotal&ukey=KEY&year=2026&month=7</nowiki>

== Response ==
FillRecords2JSON: one aggregate row incl. total_rows.

== Column visibility by profile ==
Pricing/cost columns depend on the caller's profile (GOD LAW):
* '''SuperRoot''' — provider cost + selling price + profit (VOC only).
* '''Operator''' — account price + root price + profit (VOC only).
* '''Client (direct, root=0)''' — only its own selling price (accountcode column).
* '''Client (of operator, root>0)''' — only its own selling price (root column).

----
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]]

API getcallsbillingcount

2026-11-05T13:47:33Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Row count for the given filter (smart pagination). model=voc|toc.

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>year</code> || integer || Yes || — || Year.
|-
| <code>month</code> || integer || Yes || — || Month, 1-12.
|-
| <code>model</code> || string || No || <code>voc</code> || voc or toc. (valid: voc|toc)
|-
| <code>accountcode</code> || string || No || — || Filter by account code (non-clients). (max 20)
|-
| <code>day</code> || integer || No || — || Filter by day. (model=voc only)
|-
| <code>hour</code> || integer || No || — || Filter by hour. (model=voc only, requires day)
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getcallsbillingcount&ukey=KEY&year=2026&month=7&model=voc</nowiki>

== Response ==
Object: {"total_rows":N}.

== Column visibility by profile ==
Pricing/cost columns depend on the caller's profile (GOD LAW):
* '''SuperRoot''' — provider cost + selling price + profit (VOC only).
* '''Operator''' — account price + root price + profit (VOC only).
* '''Client (direct, root=0)''' — only its own selling price (accountcode column).
* '''Client (of operator, root>0)''' — only its own selling price (root column).

----
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]]

API getcallsbillingcomis

2026-11-05T13:47:33Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Commission billing for a commissioner: aggregates the calls of the accounts assigned to the caller (accountcode_comis) and returns commission minutes/amount — never exposing costs. The caller account must be flagged comisionista=SI.

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>year</code> || integer || No || — || Year. Optional (defaults applied server-side).
|-
| <code>month</code> || integer || No || — || Month, 1-12. Optional.
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getcallsbillingcomis&ukey=COMISKEY&year=2026&month=7</nowiki>

== Response ==
FillRecords2JSON per client: accountcode, name, company, comis_minutos, comis_pct, comis_total, blocked.

== Column visibility by profile ==
Pricing/cost columns depend on the caller's profile (GOD LAW):
* '''SuperRoot''' — provider cost + selling price + profit (VOC only).
* '''Operator''' — account price + root price + profit (VOC only).
* '''Client (direct, root=0)''' — only its own selling price (accountcode column).
* '''Client (of operator, root>0)''' — only its own selling price (root column).

----
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]]

API getcallsbillingaccounttotal

2026-11-05T13:47:32Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Monthly billing total for one account. Not available to clients.

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>year</code> || integer || Yes || — || Year.
|-
| <code>month</code> || integer || Yes || — || Month, 1-12.
|-
| <code>accountcode</code> || string || No || — || Account code to total. (max 20)
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getcallsbillingaccounttotal&ukey=OPKEY&year=2026&month=7&accountcode=CLI1</nowiki>

== Response ==
FillRecords2JSON: one aggregate row.

== Column visibility by profile ==
Pricing/cost columns depend on the caller's profile (GOD LAW):
* '''SuperRoot''' — provider cost + selling price + profit (VOC only).
* '''Operator''' — account price + root price + profit (VOC only).
* '''Client (direct, root=0)''' — only its own selling price (accountcode column).
* '''Client (of operator, root>0)''' — only its own selling price (root column).

----
Back to [[API VoIP]] · '''[[API Console|▶ Try it live]]''' · Profiles: [[API profile Operator]]
[[Category:API Operator]][[Category:API function]]

API getcallsbilling

2026-11-05T13:47:32Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Outgoing-call billing records for a period. model=voc (detailed calls, supports day/hour and server-side search) or toc (per-account totals). Role-based columns: clients see only their own account (accountcode forced) and their price; operators their scope + profit; SuperRoot everything incl. provider costs. SHM fast-path + PostgreSQL fallback.

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>year</code> || integer || Yes || — || Year (e.g. 2026).
|-
| <code>month</code> || integer || Yes || — || Month, 1-12.
|-
| <code>model</code> || string || No || <code>voc</code> || voc = detailed calls; toc = totals. (valid: voc|toc (case-insensitive))
|-
| <code>accountcode</code> || string || No || — || Filter by account code (non-clients). Forced to own for clients. (max 20)
|-
| <code>day</code> || integer || No || — || Filter by day (1-31). (model=voc only)
|-
| <code>hour</code> || integer || No || — || Filter by hour (0-23). (model=voc only, requires day)
|-
| <code>limit</code> || integer || No || <code>100</code> || Max rows. SHM up to 10000, PostgreSQL up to 1000.
|-
| <code>offset</code> || integer || No || <code>0</code> || Pagination offset.
|-
| <code>search</code> || string || No || — || Server-side search pattern. (max 40)
|-
| <code>search_fields</code> || string || No || — || Comma-separated fields (whitelist: dst, cid_num, cid_name, cli_billing, dial_cid_num, accountcode, prefix, dtype, context, tariff, fromuri). (max 200)
|-
| <code>search_mode</code> || string || No || <code>contains</code> || Match mode. (prefix|suffix|contains|exact)
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getcallsbilling&ukey=KEY&year=2026&month=7&model=voc&limit=100</nowiki>

== Response ==
FillRecords2JSON records (columns depend on role).

== Column visibility by profile ==
Pricing/cost columns depend on the caller's profile (GOD LAW):
* '''SuperRoot''' — provider cost + selling price + profit (VOC only).
* '''Operator''' — account price + root price + profit (VOC only).
* '''Client (direct, root=0)''' — only its own selling price (accountcode column).
* '''Client (of operator, root>0)''' — only its own selling price (root column).

----
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]]

API getaccountcodeid

2026-11-05T13:47:32Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Lists (id, accountcode) pairs of the accounts under the caller. Operators/SuperRoot only.

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>accountcode</code> || string || No || — || Filter by account code (exact). Omit for all. (max length 20)
|-
| <code>limit</code> || integer || No || <code>100</code> || Max rows (up to 10000).
|-
| <code>offset</code> || integer || No || <code>0</code> || Pagination offset.
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getaccountcodeid&ukey=OPKEY&limit=100</nowiki>

== Response ==
FillRecords2JSON records: fields [id, accountcode].

----
Back to [[API VoIP]] · '''[[API Console|▶ Try it live]]''' · Profiles: [[API profile Operator]]
[[Category:API Operator]][[Category:API function]]

API getaccountcodedata

2026-11-05T13:47:31Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Returns full account profile rows (view_voip_users_api) for the caller's accounts. Operators/SuperRoot only.

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>accountcodeid</code> || integer || No || — || Filter by account id. Omit for all.
|-
| <code>limit</code> || integer || No || <code>1000</code> || Max rows.
|-
| <code>offset</code> || integer || No || <code>0</code> || Pagination offset.
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=getaccountcodedata&ukey=OPKEY&accountcodeid=123</nowiki>

== Response ==
FillRecords2JSON records (account profile columns).

----
Back to [[API VoIP]] · '''[[API Console|▶ Try it live]]''' · Profiles: [[API profile Operator]]
[[Category:API Operator]][[Category:API function]]

API addaccountcode

2026-11-05T13:47:31Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

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

== Description ==
Creates a new account (client) under the caller. Requires write permission (operator/SuperRoot, not read-only). For non-SuperRoot the root is forced to the caller's own.

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

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>accountcode</code> || string || Yes || — || Account code (login). Required. Max 20.
|-
| <code>credit</code> || string || Yes || — || Initial credit. Required. Max 20.
|-
| <code>password</code> || string || Yes || — || Account password. Required. Max 40.
|-
| <code>name</code> || string || Yes || — || Contact/holder name. Required. Max 100.
|-
| <code>company</code> || string || No || — || Company name. (max 100)
|-
| <code>address</code> || string || No || — || Postal address. (max 200)
|-
| <code>phone</code> || string || No || — || Phone. (max 20)
|-
| <code>email</code> || string || No || — || Primary e-mail. (max 100)
|-
| <code>date_added</code> || string || No || — || Creation date. (max 20)
|-
| <code>description</code> || string || No || — || Free description. (max 200)
|-
| <code>language</code> || string || No || — || UI language code. (max 5)
|-
| <code>postal_code</code> || string || No || — || Postal code. (max 10)
|-
| <code>city</code> || string || No || — || City. (max 50)
|-
| <code>province</code> || string || No || — || Province. (max 50)
|-
| <code>nif</code> || string || No || — || Tax id (NIF/CIF). (max 20)
|-
| <code>blocked</code> || string || No || — || Blocked flag (SI/NO). (max 4)
|-
| <code>postpaid</code> || string || No || — || Postpaid flag. (max 4)
|-
| <code>admin</code> || string || No || — || Admin flag. (max 4)
|-
| <code>accountcode_comis</code> || string || No || — || Commissioner account this account belongs to. (max 20)
|-
| <code>comisionista</code> || string || No || — || Is-commissioner flag (SI/NO). (max 4)
|-
| <code>groups</code> || string || No || — || Group memberships. (max 100)
|-
| <code>movil_sms</code> || string || No || — || Mobile for SMS. (max 20)
|-
| <code>email2</code> || string || No || — || Secondary e-mail. (max 100)
|-
| <code>fax</code> || string || No || — || Fax. (max 20)
|-
| <code>nota</code> || string || No || — || Internal note. (max 500)
|-
| <code>web</code> || string || No || — || Website. (max 100)
|-
| <code>flags</code> || string || No || — || Account flags. (max 20)
|-
| <code>tariff</code> || string || No || — || Tariff code. (max 20)
|-
| <code>daycallmail</code> || string || No || — || Daily-call report e-mail(s). (max 100)
|-
| <code>root</code> || integer || No || — || Parent operator root. Forced to the caller's own unless SuperRoot. (numeric, max 10)
|-
| <code>credit_limit</code> || integer || No || — || Credit limit. (numeric)
|-
| <code>comis_minutos</code> || integer || No || — || Commission minutes. (numeric)
|-
| <code>ratio</code> || integer || No || — || Commission ratio. (numeric)
|-
| <code>creditalarm</code> || integer || No || — || Credit alarm threshold. (numeric)
|-
| <code>aindirecto_coste</code> || integer || No || — || Indirect-access cost. (numeric)
|-
| <code>intlimit</code> || integer || No || — || International limit. (numeric)
|-
| <code>daycall</code> || integer || No || — || Daily-call limit. (numeric)
|-
| <code>intlock</code> || integer || No || — || International lock flag. (numeric)
|}
== Example ==
<nowiki>https://api.7kas.com:9080/7Kas?func=addaccountcode&ukey=OPKEY&accountcode=NEW1&credit=0&password=secret&name=John</nowiki>

== Response ==
Object with the new account id / result of api_add_voip_user.

----
Back to [[API VoIP]] · '''[[API Console|▶ Try it live]]''' · Profiles: [[API profile Operator]]
[[Category:API Operator]][[Category:API function]]

API VoIP

2026-11-05T13:47:30Z

Maintenance script: API docs regenerated from func=help (operator catalogue)

{{Note|New here? Jump to '''[[API help|the self-discovery endpoint]]''' or open the live '''[[API Console|▶ API Console]]''' to try any call with your own key.}}

== Overview ==
The 7Kas VoIP REST API exposes query and management functions over CDR, billing, incoming calls, call recordings (audio/transcripts/certification), accounts, pay-per-use services, CLIs, Tucloud PBX and WireGuard. '''HTTPS, GET, JSON.'''

== Self-discovery (start here) ==
The API documents itself, filtered by your role:
…/7Kas?func=help&ukey=YOUR_KEY (full catalogue for your profile)
…/7Kas?func=help&ukey=YOUR_KEY&name=getcdr (one function)
See '''[[API help]]'''. This wiki is generated from that same source, so it never drifts.

== Authentication ==
Every call needs an '''API key''' (parameter <code>ukey</code>, max 40) issued by 7Kas. Clients have their identity parameters (accountcode/accountcodeid) forced server-side to their own values.

== Response format ==
'''Always HTTP 200'''; on any error (bad/missing func or ukey, validation error, unknown function, task-limit exceeded) the body is <code>{}</code>.
Data functions use <code>FillRecords2JSON</code>:
<nowiki>{ "RecordCount": N, "fields": [...], "1": [...], "2": [...] }</nowiki>
Empty result ⇒ <code>{}</code>. SQL NULL ⇒ JSON <code>null</code>.

== Limits ==
Up to '''10,000''' rows/request from the SHM cache; '''1,000''' from PostgreSQL. Paginate with <code>limit</code>/<code>offset</code>.

== Catalogue by profile ==
* '''[[API profile Operator]]''' — 37 functions
* '''[[API profile Client (of operator)]]''' — 24 functions (client of an operator, root>0)
* '''[[API profile Client (direct)]]''' — 24 functions (direct 7Kas client, root=0)

== Try it ==
Open the '''[[API Console]]''': paste your <code>ukey</code>, pick a function, fill parameters and run a real (read-only-safe) call from your browser.

[[Category:API]]

TuCloudAPI updatecalendar

2026-11-05T13:29:25Z

Maintenance script: TuCloudAPI calendar: Repetir cada año (hold) and expires_on

''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.''

{{Note|1=Requires the <code>pbx</code> parameter (the PBX '''name''', e.g. <code>tucall</code>). The server verifies that your <code>ukey</code>'s own account owns that PBX, whatever its role; otherwise, and also for a PBX that does not exist, it returns <code>{"ok":false,"code":"forbidden"}</code>.}}

== Description ==
Edit a calendar row (same fields as addcalendar). hold ABSENT keeps the stored value. With hold 0, expires_on is kept while the end (monthend/dayend) does not change, and computed again from today when it does or when the row goes from 1 to 0; hold 1 clears it. 404 if not in the caller's PBX. Requires a non-readonly ukey.

== Call ==
https://tucloudapi.7kas.com:9087/tucloud?func=updatecalendar&ukey=YOUR_KEY&pbx=PBX_NAME
GET, or POST with the parameters form-urlencoded in the body. Requires the <code>ukey</code> parameter. Always HTTP 200; the response is a JSON envelope.

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>pbx</code> || string || Yes || — || FuturePBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX.
|-
| <code>id</code> || integer || Yes || — || Calendar row id (_id).
|-
| <code>template</code> || integer || Yes || — || Calendar-template group 1-99.
|-
| <code>monthstart</code> || integer || Yes || — || Start month 1-12.
|-
| <code>monthend</code> || integer || Yes || — || End month 1-12.
|-
| <code>dayend</code> || integer || Yes || — || End day 1-31.
|-
| <code>destination</code> || integer || Yes || — || Route _id to divert to (required, in-tenant).
|-
| <code>daystart</code> || integer || No || <code>0</code> || Start day 1-31, or 0/blank = all days (Todos).
|-
| <code>timestart</code> || string || No || <code>00:00</code> || Start time HH:MM.
|-
| <code>timeend</code> || string || No || <code>00:00</code> || End time HH:MM.
|-
| <code>hold</code> || integer || No || — || «Repetir cada año» 1/0; absent = keep the stored value.
|-
| <code>nota</code> || string || No || — || Free note (max 256).
|}
== Example ==
<nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=updatecalendar&ukey=KEY&pbx=tucall&id=81522&template=1&monthstart=1&daystart=1&monthend=1&dayend=1&destination=197</nowiki>

== Response ==
{ok, calendar:{...}}.

== Errors ==
Always HTTP 200. On failure the body is <code>{"ok":false,"code":"...","message":"..."}</code>. Common codes: <code>missing_pbx</code>, <code>forbidden</code>, <code>invalid_param</code>, <code>not_found</code>, <code>conflict</code>, <code>in_use</code>, <code>db_error</code>, <code>server_busy</code>; the Response section above lists any specific to this function.

----
Back to [[TuCloudAPI]]
[[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI Client]][[Category:TuCloudAPI]]

TuCloudAPI getcalendars

2026-11-05T13:29:25Z

Maintenance script: TuCloudAPI calendar: Repetir cada año (hold) and expires_on

TuCloudAPI getcalendar

2026-11-05T13:29:25Z

Maintenance script: TuCloudAPI calendar: Repetir cada año (hold) and expires_on

TuCloudAPI addcalendar

2026-11-05T13:29:24Z

Maintenance script: TuCloudAPI calendar: Repetir cada año (hold) and expires_on

''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.''

{{Note|1=Requires the <code>pbx</code> parameter (the PBX '''name''', e.g. <code>tucall</code>). The server verifies that your <code>ukey</code>'s own account owns that PBX, whatever its role; otherwise, and also for a PBX that does not exist, it returns <code>{"ok":false,"code":"forbidden"}</code>.}}

== Description ==
Create a calendar date-override. Fields: template 1-99 (the calendar group a CLI's template_c selects), monthstart/monthend 1-12, daystart/dayend 1-31, timestart/timeend HH:MM (blank = 00:00), destination = an in-tenant route _id (required), hold «Repetir cada año» 1/0, nota (max 256). «Repetir cada año» (operator 2026-11-05): 1 = the row repeats every year on those dates; 0 = only its next occurrence: expires_on is the last day of it (Europe/Madrid) and the day after, the row is deleted by itself. The next occurrence is this year's when its end day is today or later, else next year's. The trigger derives the MMDD/HHMM columns + root; the API writes only the editable fields. No dedup (duplicates allowed, per legacy). Requires a non-readonly ukey.

== Call ==
https://tucloudapi.7kas.com:9087/tucloud?func=addcalendar&ukey=YOUR_KEY&pbx=PBX_NAME
GET, or POST with the parameters form-urlencoded in the body. Requires the <code>ukey</code> parameter. Always HTTP 200; the response is a JSON envelope.

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>pbx</code> || string || Yes || — || FuturePBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX.
|-
| <code>template</code> || integer || Yes || — || Calendar-template group 1-99.
|-
| <code>monthstart</code> || integer || Yes || — || Start month 1-12.
|-
| <code>monthend</code> || integer || Yes || — || End month 1-12.
|-
| <code>dayend</code> || integer || Yes || — || End day 1-31.
|-
| <code>destination</code> || integer || Yes || — || Route _id to divert to (required, in-tenant).
|-
| <code>daystart</code> || integer || No || <code>0</code> || Start day 1-31, or 0/blank = all days (Todos).
|-
| <code>timestart</code> || string || No || <code>00:00</code> || Start time HH:MM.
|-
| <code>timeend</code> || string || No || <code>00:00</code> || End time HH:MM.
|-
| <code>hold</code> || integer || No || <code>1</code> || «Repetir cada año»: 1 = every year (the default), 0 = only the next occurrence, then deleted by itself.
|-
| <code>nota</code> || string || No || — || Free note (max 256).
|}
== Example ==
<nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=addcalendar&ukey=KEY&pbx=tucall&template=1&monthstart=12&daystart=25&monthend=12&dayend=25&destination=197</nowiki>

== Response ==
{ok, calendar:{...}}.

== Errors ==
Always HTTP 200. On failure the body is <code>{"ok":false,"code":"...","message":"..."}</code>. Common codes: <code>missing_pbx</code>, <code>forbidden</code>, <code>invalid_param</code>, <code>not_found</code>, <code>conflict</code>, <code>in_use</code>, <code>db_error</code>, <code>server_busy</code>; the Response section above lists any specific to this function.

----
Back to [[TuCloudAPI]]
[[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI Client]][[Category:TuCloudAPI]]

TuCloudAPI

2026-11-03T23:50:30Z

Maintenance script: TuCloudAPI reference: portal users email + magic link (generated from func=help)

{{Note|1=New here? Start with '''[[TuCloudAPI help|the self-discovery endpoint]]'''. This reference is generated from <code>func=help</code>, so it never drifts.}}

== Overview ==
'''TuCloudAPI''' is the REST API to manage '''FuturePBX''' (the multi-tenant cloud PBX). '''HTTPS + JSON''', GET or POST (parameters form-urlencoded; audio uploads POST the file as the body). Base URL:
https://tucloudapi.7kas.com:9087/tucloud?func=NAME&ukey=YOUR_KEY&pbx=PBX_NAME

== Authentication & tenant ==
Every call needs an '''API key''' (<code>ukey</code>). Every PBX-scoped function also needs <code>pbx</code> — the PBX '''name''' (e.g. <code>tucall</code>). The <code>(ukey, pbx)</code> pair is the tenant boundary: the server resolves the PBX name to its id and verifies that the key's OWN account owns it — for every role, SuperRoot included. A PBX that does not exist and one the key does not own both answer <code>forbidden</code>. It never trusts a numeric tenant from the caller.

== Response format ==
'''Always HTTP 200.''' Every PBX-scoped function always returns a JSON envelope: success <code>{"ok":true, ...}</code>, empty <code>{"ok":true,"rows":[]}</code>, error <code>{"ok":false,"code":...,"message":...}</code> (common codes: <code>missing_pbx, forbidden, invalid_param, not_found, conflict, in_use, db_error, server_busy</code>). IDs are exposed as <code>_id</code>. A missing or invalid <code>ukey</code> answers a bare <code>{}</code> and nothing else. The legacy account functions return their data object directly, <code>{}</code> when there is nothing.

== Functions ==
=== Dashboard (landing counts) ===
* [[TuCloudAPI getdashboard]] — Landing-page dashboard: per-tenant object counts + a cheap health metric, in one call.
=== Extensions (Extensiones) ===
* [[TuCloudAPI getextensions]] — List the PBX extensions (safe display fields; NEVER the SIP password).
* [[TuCloudAPI getextension]] — Get one extension with all editable fields (NO password).
* [[TuCloudAPI getextlookups]] — Tenant-scoped option lists for the extension form selects: caller IDs (clis), music-on-hold (music), outgoing services (outs), the extension list (exts, for Enviar a / backup monitor), registration servers (servers) and next_free: the create-form number prefill for a REGISTERED extension (3-4 digits, the same check as checkextnum), a string, or null when no number is free.
* [[TuCloudAPI checkextnum]] — Is this number free for a NEW extension of this PBX? The same check addextension runs under its lock, so the two never disagree.
* [[TuCloudAPI addextension]] — Create an extension.
* [[TuCloudAPI updateextension]] — Edit an extension.
* [[TuCloudAPI deleteextension]] — Delete an extension after a tenant + dependency check.
* [[TuCloudAPI setextpassword]] — Rotate ONE extension's SIP password.
* [[TuCloudAPI getextpassword]] — Plaintext SIP password for ONE extension (the portal's «Clave SIP» eye toggle).
* [[TuCloudAPI getextqr]] — SIP provisioning QR for one extension, rendered server-side to a PNG (base64).
=== CLIs / DIDs (Numeracion) ===
* [[TuCloudAPI getclis]] — List the PBX CLIs / DIDs (inbound numbers) with the grid fields.
* [[TuCloudAPI getcli]] — Get one CLI with all editable fields, including the full 192-key timer matrix under "timers".
* [[TuCloudAPI getclilookups]] — Tenant-scoped option lists for the CLI form: routes (all route selects), schedule profiles (template_h), and defined calendar templates (template_c helper).
* [[TuCloudAPI addcli]] — Create a CLI / DID.
* [[TuCloudAPI updatecli]] — Edit a CLI.
* [[TuCloudAPI deletecli]] — Delete a CLI after a tenant + dependency check.
=== Routes (Rutas) ===
* [[TuCloudAPI getroutes]] — List inbound routes for the PBX with step counts.
* [[TuCloudAPI getroute]] — Get one route header plus its ordered steps (destinations).
* [[TuCloudAPI getroutelookups]] — Tenant-scoped destination pickers for the step editor: the app enum plus extensions, groups, locutions, schedules, calendars, routes and queues (app=10 "Cola": _id = the stable voip_queue.id stored in the step appdata, label = the queue title).
* [[TuCloudAPI addroute]] — Create an inbound route (header only; add steps with addroutestep).
* [[TuCloudAPI updateroute]] — Rename/annotate a route header.
* [[TuCloudAPI deleteroute]] — Delete a route.
* [[TuCloudAPI addroutestep]] — Append a step to a route (priority = max+1).
* [[TuCloudAPI updateroutestep]] — Change a step's app/appdata/timer (and optionally priority).
* [[TuCloudAPI deleteroutestep]] — Remove a step; the remaining steps' priorities are auto-compacted to 1..N by the DB trigger.
=== Blacklist (inbound intercept) ===
* [[TuCloudAPI getblacklist]] — List the inbound-intercept rules for the PBX.
* [[TuCloudAPI getblacklistlookups]] — Tenant-scoped pickers for the rule form: routes (the divert target) and CLIs/DIDs (cli_id; 0 = all DIDs / generic rule).
* [[TuCloudAPI addblacklist]] — Create an inbound-intercept rule.
* [[TuCloudAPI updateblacklist]] — Edit an inbound-intercept rule.
* [[TuCloudAPI deleteblacklist]] — Delete an inbound-intercept rule.
=== Contacts (Agenda) ===
* [[TuCloudAPI getcontacts]] — List the PBX contacts (address book).
* [[TuCloudAPI addcontact]] — Create a contact.
* [[TuCloudAPI updatecontact]] — Edit a contact.
* [[TuCloudAPI deletecontact]] — Delete a contact.
=== Calendar (date overrides) ===
* [[TuCloudAPI getcalendars]] — List the PBX calendar date-overrides (one row = one recurring month/day + time window that reroutes inbound to a route for CLIs on that template).
* [[TuCloudAPI getcalendar]] — Get one calendar row.
* [[TuCloudAPI getcalendarlookups]] — Tenant-scoped pickers: routes (the destination) and the set of template values already in use (suggestions for the template spinner).
* [[TuCloudAPI addcalendar]] — Create a calendar date-override.
* [[TuCloudAPI updatecalendar]] — Edit a calendar row (same fields as addcalendar).
* [[TuCloudAPI deletecalendar]] — Delete a calendar row.
=== Ring groups (Grupos) ===
* [[TuCloudAPI getgroups]] — List the PBX ring/hunt groups with a member count.
* [[TuCloudAPI getgroup]] — Get one group.
* [[TuCloudAPI getgrouplookups]] — Tenant-scoped pickers: extensions (members), music (MOH), and CLIs (for the admin forward caller-id).
* [[TuCloudAPI addgroup]] — Create a ring group.
* [[TuCloudAPI updategroup]] — Edit a ring group (same fields as addgroup; gr editable, conflict on collision).
* [[TuCloudAPI deletegroup]] — Delete a ring group.
=== Locutions / IVR (Locuciones) ===
* [[TuCloudAPI getlocutions]] — List the PBX locutions / IVR prompts.
* [[TuCloudAPI getlocution]] — Get one locution with its DTMF digit->route map (+ resolved route names), has_audio and audio_url.
* [[TuCloudAPI getlocutionlookups]] — Tenant-scoped route picker for the 11 DTMF digit destinations.
* [[TuCloudAPI addlocution]] — Create a locution / IVR.
* [[TuCloudAPI updatelocution]] — Edit a locution (name, waitext, digit routes).
* [[TuCloudAPI deletelocution]] — Delete a locution.
* [[TuCloudAPI getlocutionvoices]] — Catalogo para el selector de texto a voz: voces disponibles e idiomas admitidos.
* [[TuCloudAPI synthlocution]] — Genera el audio de una locucion a partir de un texto y lo deja PENDIENTE DE ACEPTAR: NO sustituye la locucion.
* [[TuCloudAPI uploadlocution]] — Sube un fichero de audio y lo deja COMO el audio de una locucion.
* [[TuCloudAPI commitlocution]] — Acepta el audio pendiente (el generado por synthlocution o subido por uploadlocution) y lo convierte en la locucion.
* [[TuCloudAPI discardlocution]] — Tira el audio pendiente sin tocar la locucion.
=== Music on hold (MOH) ===
* [[TuCloudAPI getmusics]] — List the PBX music-on-hold classes with has_audio (whether the track exists) and audio_url (the getaudio player URL).
* [[TuCloudAPI getmusic]] — Get one MOH class (+ has_audio, audio_url).
* [[TuCloudAPI addmusic]] — Create a MOH class.
* [[TuCloudAPI uploadmusic]] — Sube un fichero de audio para una clase de musica y lo deja PENDIENTE DE ACEPTAR: NO sustituye la que suena.
* [[TuCloudAPI commitmusic]] — Acepta el audio pendiente y lo convierte en la musica que suena.
* [[TuCloudAPI discardmusic]] — Tira el audio pendiente sin tocar la musica.
* [[TuCloudAPI deletemusic]] — Delete a MOH class.
=== Schedules (Horarios) ===
* [[TuCloudAPI getschedules]] — List the PBX weekly schedules (the WHEN grid a CLI's schedule profile points at).
* [[TuCloudAPI getschedule]] — Get one schedule with the full 84-cell weekly grid under "slots".
* [[TuCloudAPI addschedule]] — Create a weekly schedule.
* [[TuCloudAPI updateschedule]] — Edit a schedule (template/name/grid).
* [[TuCloudAPI deleteschedule]] — Delete a schedule.
=== Outbound routing (Rutas de salida) ===
* [[TuCloudAPI getoutgoings]] — List the outbound-routing profiles (Servicios de salida) with rule counts.
* [[TuCloudAPI getoutgoing]] — Get one outbound profile plus its ordered allow/deny rules (longest-prefix first).
* [[TuCloudAPI getoutgoinglookups]] — Tenant-scoped route picker for a rule's divert destination (route_id; 0 = block).
* [[TuCloudAPI addoutgoing]] — Create an outbound-routing profile (header; add rules with addoutrule).
* [[TuCloudAPI updateoutgoing]] — Rename/annotate an outbound profile.
* [[TuCloudAPI deleteoutgoing]] — Delete an outbound profile.
* [[TuCloudAPI addoutrule]] — Append an allow/deny rule to a profile.
* [[TuCloudAPI updateoutrule]] — Edit an outbound rule (dst/denyallow/route_id/nota).
* [[TuCloudAPI deleteoutrule]] — Remove an outbound rule.
=== Phonebooks (Agendas) ===
* [[TuCloudAPI getphonebooks]] — List the PBX phonebooks (address books) with contact counts.
* [[TuCloudAPI getphonebook]] — Get one phonebook plus its contacts.
* [[TuCloudAPI addphonebook]] — Create a phonebook.
* [[TuCloudAPI updatephonebook]] — Edit a phonebook.
* [[TuCloudAPI deletephonebook]] — Delete a phonebook and all its contacts (DB cascade).
* [[TuCloudAPI addphonebookcontact]] — Add a contact to a phonebook.
* [[TuCloudAPI updatephonebookcontact]] — Edit a phonebook contact (tenant-checked via the row).
* [[TuCloudAPI deletephonebookcontact]] — Remove a phonebook contact (tenant-checked).
=== Call queues / ACD (Colas) ===
* [[TuCloudAPI getqueues]] — List the PBX call queues (ACD) with member counts.
* [[TuCloudAPI getqueue]] — Get one queue's config.
* [[TuCloudAPI getqueuelookups]] — Tenant-scoped pickers for the queue form: music (MOH classes), the strategy enum, and next_free (the create-form exten prefill = first free 3-digit queue number, null if 900-999 full).
* [[TuCloudAPI addqueue]] — Create a call queue.
* [[TuCloudAPI updatequeue]] — Edit a queue's config.
* [[TuCloudAPI deletequeue]] — Delete a queue.
=== Agents / queue members (Agentes) ===
* [[TuCloudAPI getagents]] — List the PBX agents (queue members) with the queue title and the agent's extension name resolved.
* [[TuCloudAPI getagentlookups]] — Dropdown data for the agent screens: this PBX's queues (assign an agent to a queue) and its extensions {_id,num,name}.
* [[TuCloudAPI addagent]] — Add an extension to a queue as a static member.
* [[TuCloudAPI updateagent]] — Update a queue member's penalty / paused / reason_paused (partial — only the fields sent are changed).
* [[TuCloudAPI deleteagent]] — Remove a queue member (agent) by _id.
=== Portal admin users (Usuarios) ===
* [[TuCloudAPI getadminusers]] — List this PBX's portal users (tucloud_sec_users).
* [[TuCloudAPI getadminuser]] — Get one portal user by login (_id) within this PBX.
* [[TuCloudAPI getadminuserlookups]] — Picker for the user form: the distinct roles used in this PBX (free-text datalist suggestions), and invite:true: users are created by email invitation, with no username and no password (always true on this build).
* [[TuCloudAPI addadminuser]] — Invite a new portal user to THIS PBX.
* [[TuCloudAPI updateadminuser]] — Edit a portal user in THIS PBX: name, active, priv_admin, role and phone are replaced as sent; disable_2fa=1 turns 2FA off and clears the secret (never enables).
* [[TuCloudAPI requestadminuseremail]] — Ask to change a portal user's EMAIL (their magic-link login), the twin of requestpbxemail.
* [[TuCloudAPI resendadminuseremail]] — Mail again the link of the user's open email change (the invitation of an invited user, or a change), pending or expired, with a fresh 24 hours; the previous link is then ignored.
* [[TuCloudAPI canceladminuseremail]] — Drop the user's open email change (pending, or expired): its link is then ignored.
* [[TuCloudAPI getadminuseremailchange]] — Status of the user's latest email change, from tucloudapi's own state (never magiclogin): none | pending (email, expires_in) | expired (until resent or cancelled) | done (notice: sent|failed|skipped, the informational mail to the old address) | failed (reason taken|error) | cancelled, with invite (true when it is the invitation) and its Spanish message.
* [[TuCloudAPI deleteadminuser]] — Delete a portal user by login within this PBX; their open email change is cancelled with them.
=== PBX settings (Configuracion) ===
* [[TuCloudAPI getpbxconfig]] — Get this PBX's settings (single record, no id needed, tenant from the binding).
* [[TuCloudAPI getpbxconfiglookups]] — Picker for the admin_ext_id field: this PBX's extensions.
* [[TuCloudAPI updatepbxconfig]] — Update this PBX's settings (strict set).
* [[TuCloudAPI requestpbxemail]] — Ask to change this PBX's MASTER EMAIL (tucloud_pbx.email: the administrator's magic-link and password login).
* [[TuCloudAPI getpbxemailchange]] — Status of this PBX's latest master-email change, from tucloudapi's own state (never magiclogin): none | pending (email, expires_in) | done (email, notice: sent|failed|skipped, the informational mail to the old address) | expired | failed (reason taken|error) | cancelled, each with its Spanish message.
* [[TuCloudAPI cancelpbxemail]] — Cancel this PBX's pending master-email change (its link is then ignored).
=== Security profiles / ACL (Perfiles) ===
* [[TuCloudAPI getprofiles]] — List this PBX's security profiles (Perfiles) with member counts.
* [[TuCloudAPI getprofile]] — Get one profile + its full app-permission matrix (all catalog apps, with app_type).
* [[TuCloudAPI getprofileapps]] — Get a profile's app-permission matrix only (the Aplicaciones/Perfiles editor).
* [[TuCloudAPI getseclookups]] — Pickers for the security section: the global app catalog (matrix columns) + this PBX's profiles (membership picker).
* [[TuCloudAPI getprofileusers]] — List the admin users assigned to a profile (read-only "Miembros" list; edits stay per-user via setuserprofiles).
* [[TuCloudAPI getuserprofiles]] — Get an admin user's profile membership + the profile picker (this PBX only).
* [[TuCloudAPI addprofile]] — Create a security profile in this PBX.
* [[TuCloudAPI updateprofile]] — Rename a profile (description).
* [[TuCloudAPI deleteprofile]] — Delete a profile.
* [[TuCloudAPI getsections]] — The catalog of portal sections (login v2, 2026-10-31): one row per section of the new web, in sidebar order, from the NEW table tucloud_sec_sections (24 rows; pbx_config is the PBX administrator's and has no row).
* [[TuCloudAPI getprofilesections]] — One profile's section access (login v2): every catalog section with access Y/N, from the NEW table tucloud_sec_groups_sections; a section without a row answers N.
* [[TuCloudAPI setprofilesections]] — FULL replace of one profile's section access (login v2; the «mantenimiento de accesos de los grupos» the operator asked for on 2026-10-31).
* [[TuCloudAPI setprofileapps]] — RETIRED 2026-10-31 (operator: the legacy matrix is never altered again).
* [[TuCloudAPI setprofileapp]] — RETIRED 2026-10-31 (operator: the legacy matrix is never altered again).
* [[TuCloudAPI setuserprofiles]] — Full-replace an admin user's profile membership (this PBX only).
=== Call detail records (CDR) ===
* [[TuCloudAPI getcdr]] — List a period of this PBX's call detail records (Registro de llamadas), newest first.
* [[TuCloudAPI getcdrlookups]] — CDR form pickers: the selectable years + the result (disposition) label set.
=== Reports / statistics (Informes) ===
* [[TuCloudAPI getreports]] — Call-volume statistics (Informes / Estadisticas de Llamadas) for a month — VOLUME ONLY, no prices.
=== AI assistant (Asistente IA) ===
* [[TuCloudAPI aichat]] — AI assistant for this PBX (Spanish).
=== Scheduled tasks (Tareas programadas) ===
* [[TuCloudAPI gettasks]] — List scheduled tasks (tareas programadas) for the PBX, with schedule + status labels and step counts.
* [[TuCloudAPI gettask]] — Get one scheduled task and its ordered steps.
* [[TuCloudAPI gettasksteps]] — Get the ordered steps of a task (tenant-checked).
* [[TuCloudAPI gettasklog]] — Get the last 100 execution-log rows for a task (read-only history), newest first.
* [[TuCloudAPI getapps]] — List the 8 target entity types ("apps") a task step can act on.
* [[TuCloudAPI getappactions]] — List the configurable fields ("actions") for an app — the dynamic-form catalog (field, type 0-5, data, metadata).
* [[TuCloudAPI getappsrecords]] — List this PBX's selectable records for an app (the record picker), via the tenant-scoped lookup function.
* [[TuCloudAPI getactiondata]] — List the selectable value options for an action (the value picker), for select/checkbox action types, via the tenant-scoped lookup function.
* [[TuCloudAPI getpbxs]] — List the PBXs assigned to the calling ukey's account (post-login selector; show only if >1).
* [[TuCloudAPI addtask]] — Create a scheduled task (status forced 0).
* [[TuCloudAPI updatetask]] — Edit a task (does not change status).
* [[TuCloudAPI deletetask]] — Delete a task (DB cascade of steps/log + crontab removal via the operator trigger).
* [[TuCloudAPI addtaskstep]] — Append a step to a task.
* [[TuCloudAPI updatetaskstep]] — Change a step's value (blank -> NULL).
* [[TuCloudAPI deletetaskstep]] — Remove a step.
=== Call simulator ===
* [[TuCloudAPI simulatecall]] — Simulate how a call routes (inbound DID / outbound / internal) WITHOUT placing a real call, returning the ordered decision trace (flujo).
=== Audio files ===
* [[TuCloudAPI getaudio]] — General-purpose audio file server (not only for the simulator): serve a locution or music-on-hold audio file base64-encoded (audio/wav) — for hover-preview, players, downloads, etc.
=== FuturePBX ===
* [[TuCloudAPI getpbxloclog]] — FuturePBX IVR/locution DTMF key-press log for a period.
=== Meta / discovery ===
* [[TuCloudAPI help]] — Lists the API functions available to the role of the calling ukey, with each function's description, parameters (meaning, optional/default), an example call and the response format.
=== Diagnostics ===
* [[TuCloudAPI helloworld]] — Health check / connectivity test.
=== Administration ===
* [[TuCloudAPI SetDebugLevel]] — Sets the runtime debug/log verbosity level.
* [[TuCloudAPI ReloadUsersKeys]] — Hot-reloads the API keys from the database without restarting the service.
* [[TuCloudAPI resetinternalkey]] — Regenerates the non-showable internal API key for an account.
=== Account management (inherited) ===
* [[TuCloudAPI getaccountcodeid]] — Lists (id, accountcode) pairs of the accounts under the caller.
* [[TuCloudAPI getaccountcodedata]] — Returns full account profile rows (view_voip_users_api) for the caller's accounts.
* [[TuCloudAPI lockaccountcode]] — Blocks (locks) an account (blocked=SI).
* [[TuCloudAPI unlockaccountcode]] — Unblocks (unlocks) an account (blocked=NO).
* [[TuCloudAPI addaccountcode]] — Creates a new account (client) under the caller.
* [[TuCloudAPI getcredit]] — Returns credit and status (credit, credit_limit, creditalarm, email, blocked).
=== auth ===
* [[TuCloudAPI authrequest]] — Ask for a magic-link e-mail.
* [[TuCloudAPI authpoll]] — Has the user authorized the magic link? PUBLIC, like authrequest.
* [[TuCloudAPI authchallenge]] — A proof-of-work captcha challenge (ALTCHA protocol, SHA-256).
* [[TuCloudAPI authlogin]] — The password door.
* [[TuCloudAPI authwhoami]] — The current session context, and it refreshes the idle timer.
* [[TuCloudAPI authlogout]] — Destroy the session and clear the cookie.
=== queue_live ===
* [[TuCloudAPI getqueueevents]] — Today's events of ONE queue (local day), newest first, at most 200, with the same deduplication as getqueuestats (core events; module EXITQUEUE FULL/JOINEMPTY kept as refused).
* [[TuCloudAPI getlivestatus]] — LIVE state of the PBX as ONE snapshot of the presence feed: each extension's state (unregistered/idle/ringing/busy, "unknown" when it is not published) and its calls in progress (ringing/talking/hold/dialing, the other party, seconds since start and since answer), and each queue's live picture (agents logged in / available / paused, the waiting calls in queue order with their wait, every member with its status).
=== queue_stats ===
* [[TuCloudAPI getqueuestats]] — Call-center history from voip_queue_log (gabpbx contract v1, 2026-10-31): totals, per interval, per queue and per agent between two local days (Europe/Madrid, inclusive).

== Related ==
Full technical reference (architecture, auth model, side effects): see the project repo <code>doc/TUCLOUDAPI_REFERENCE.md</code>. Scheduled-tasks engine: the 6 <code>tucloud_pbx_tasks*</code> tables + the <code>.231</code> crontab trigger.

[[Category:TuCloudAPI]]