TuCloudAPI - Revision history

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

2026-11-05T14:20:33Z

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

← Older revision		Revision as of 14:20, 5 November 2026
Line 58:		Line 58:
	* [[TuCloudAPI getcalendarlookups]] — Tenant-scoped pickers: routes (the destination) and the set of template values already in use (suggestions for the template spinner).		* [[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 addcalendar]] — Create a calendar date-override.
	* [[TuCloudAPI updatecalendar]] — Edit a calendar row (same fields as addcalendar).		* [[TuCloudAPI updatecalendar]] — Edit a calendar row (same fields and period rule as addcalendar).
	* [[TuCloudAPI deletecalendar]] — Delete a calendar row.		* [[TuCloudAPI deletecalendar]] — Delete a calendar row.
	=== Ring groups (Grupos) ===		=== Ring groups (Grupos) ===

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

2026-11-03T23:50:30Z

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

← Older revision		Revision as of 23:50, 3 November 2026
Line 126:		Line 126:
	* [[TuCloudAPI deleteagent]] — Remove a queue member (agent) by _id.		* [[TuCloudAPI deleteagent]] — Remove a queue member (agent) by _id.
	=== Portal admin users (Usuarios) ===		=== Portal admin users (Usuarios) ===
	* [[TuCloudAPI getadminusers]] — List this PBX's portal ~~admin~~ users (tucloud_sec_users).		* [[TuCloudAPI getadminusers]] — List this PBX's portal users (tucloud_sec_users).
	* [[TuCloudAPI getadminuser]] — Get one portal ~~admin~~ user by login (_id) within this PBX.		* [[TuCloudAPI getadminuser]] — Get one portal user by login (_id) within this PBX.
	* [[TuCloudAPI getadminuserlookups]] — Picker for the ~~admin-~~user form: the distinct roles used in this PBX (free-text datalist suggestions).		* [[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]] — ~~Create~~ a portal ~~admin~~ user in THIS PBX.		* [[TuCloudAPI addadminuser]] — Invite a new portal user to THIS PBX.
	* [[TuCloudAPI updateadminuser]] — Edit a portal ~~admin~~ user in 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 deleteadminuser]] — Delete a portal ~~admin~~ user by login within this PBX.		* [[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) ===		=== PBX settings (Configuracion) ===
	* [[TuCloudAPI getpbxconfig]] — Get this PBX's settings (single record, no id needed, tenant from the binding).		* [[TuCloudAPI getpbxconfig]] — Get this PBX's settings (single record, no id needed, tenant from the binding).

Maintenance script: TuCloudAPI reference (generated from func=help): PBX master email

2026-11-03T11:06:50Z

TuCloudAPI reference (generated from func=help): PBX master email

← Older revision		Revision as of 11:06, 3 November 2026
Line 133:		Line 133:
	* [[TuCloudAPI deleteadminuser]] — Delete a portal admin user by login within this PBX.		* [[TuCloudAPI deleteadminuser]] — Delete a portal admin user by login within this PBX.
	=== PBX settings (Configuracion) ===		=== PBX settings (Configuracion) ===
	* [[TuCloudAPI getpbxconfig]] — Get this PBX's settings (single record ? no id needed, tenant from the binding).		* [[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 getpbxconfiglookups]] — Picker for the admin_ext_id field: this PBX's extensions.
	* [[TuCloudAPI updatepbxconfig]] — Update this PBX's settings (strict set).		* [[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) ===		=== Security profiles / ACL (Perfiles) ===
	* [[TuCloudAPI getprofiles]] — List this PBX's security profiles (Perfiles) with member counts.		* [[TuCloudAPI getprofiles]] — List this PBX's security profiles (Perfiles) with member counts.

Maintenance script: TuCloudAPI reference (generated from func=help): checkextnum, extension numbers

2026-11-02T09:45:50Z

TuCloudAPI reference (generated from func=help): checkextnum, extension numbers

← Older revision		Revision as of 09:45, 2 November 2026
Line 17:		Line 17:
	* [[TuCloudAPI getextensions]] — List the PBX extensions (safe display fields; NEVER the SIP password).		* [[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 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), ~~and~~ the extension list (exts, for Enviar a / backup monitor).		* [[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 addextension]] — Create an extension.
	* [[TuCloudAPI updateextension]] — Edit an extension.		* [[TuCloudAPI updateextension]] — Edit an extension.

Maintenance script: TuCloudAPI reference (generated from func=help)

2026-10-31T15:09:49Z

TuCloudAPI reference (generated from func=help)

← Older revision		Revision as of 15:09, 31 October 2026
Line 204:		Line 204:
	=== queue_live ===		=== 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 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 ===		=== 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).		* [[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).

Maintenance script: TuCloudAPI reference (generated from func=help; call-center 2026-10-31)

2026-10-31T12:24:43Z

TuCloudAPI reference (generated from func=help; call-center 2026-10-31)

← Older revision		Revision as of 12:24, 31 October 2026
Line 202:		Line 202:
	* [[TuCloudAPI authwhoami]] — The current session context, and it refreshes the idle timer.		* [[TuCloudAPI authwhoami]] — The current session context, and it refreshes the idle timer.
	* [[TuCloudAPI authlogout]] — Destroy the session and clear the cookie.		* [[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).
			=== 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 ==		== Related ==

Maintenance script: TuCloudAPI reference (generated from func=help; ringinuse 2026-10-31)

2026-10-31T11:48:37Z

TuCloudAPI reference (generated from func=help; ringinuse 2026-10-31)

← Older revision		Revision as of 11:48, 31 October 2026
Line 145:		Line 145:
	* [[TuCloudAPI updateprofile]] — Rename a profile (description).		* [[TuCloudAPI updateprofile]] — Rename a profile (description).
	* [[TuCloudAPI deleteprofile]] — Delete a profile.		* [[TuCloudAPI deleteprofile]] — Delete a profile.
	* [[TuCloudAPI ~~setprofileapps~~]] — ~~Bulk~~-~~save a~~ profile's FULL ~~permission matrix in~~ one ~~call~~ (the ~~primary~~ matrix ~~write~~).		* [[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 setprofileapp]] — ~~Set ONE app's permissions for a profile~~.		* [[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).		* [[TuCloudAPI setuserprofiles]] — Full-replace an admin user's profile membership (this PBX only).
	=== Call detail records (CDR) ===		=== Call detail records (CDR) ===
Line 195:		Line 198:
	* [[TuCloudAPI authrequest]] — Ask for a magic-link e-mail.		* [[TuCloudAPI authrequest]] — Ask for a magic-link e-mail.
	* [[TuCloudAPI authpoll]] — Has the user authorized the magic link? PUBLIC, like authrequest.		* [[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 authwhoami]] — The current session context, and it refreshes the idle timer.
	* [[TuCloudAPI authlogout]] — Destroy the session and clear the cookie.		* [[TuCloudAPI authlogout]] — Destroy the session and clear the cookie.

Maintenance script: TuCloudAPI reference (generated from func=help): authrequest relays login_code, authpoll names denied

2026-10-26T18:59:55Z

TuCloudAPI reference (generated from func=help): authrequest relays login_code, authpoll names denied

← Older revision		Revision as of 18:59, 26 October 2026
Line 194:		Line 194:
	=== auth ===		=== auth ===
	* [[TuCloudAPI authrequest]] — Ask for a magic-link e-mail.		* [[TuCloudAPI authrequest]] — Ask for a magic-link e-mail.
	* [[TuCloudAPI authpoll]] — Has the magic link ~~been clicked~~? PUBLIC, like authrequest.		* [[TuCloudAPI authpoll]] — Has the user authorized the magic link? PUBLIC, like authrequest.
	* [[TuCloudAPI authwhoami]] — The current session context, and it refreshes the idle timer.		* [[TuCloudAPI authwhoami]] — The current session context, and it refreshes the idle timer.
	* [[TuCloudAPI authlogout]] — Destroy the session and clear the cookie.		* [[TuCloudAPI authlogout]] — Destroy the session and clear the cookie.

Maintenance script: TuCloudAPI reference regenerated from func=help: tenancy rule, pbx notes on every PBX-scoped function, error codes

2026-10-08T21:17:11Z

TuCloudAPI reference regenerated from func=help: tenancy rule, pbx notes on every PBX-scoped function, error codes

← Older revision		Revision as of 21:17, 8 October 2026
Line 2:		Line 2:

	== Overview ==		== Overview ==
	'''TuCloudAPI''' is the REST API to manage '''FuturePBX''' (the multi-tenant cloud PBX). '''HTTPS~~, GET,~~ JSON.''' Base URL:		'''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		https://tucloudapi.7kas.com:9087/tucloud?func=NAME&ukey=YOUR_KEY&pbx=PBX_NAME

	== Authentication & tenant ==		== Authentication & tenant ==
	Every call needs an '''API key''' (<code>ukey</code>). ~~The '''tasks''' functions~~ also ~~need~~ <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 the key owns it ~~('''~~SuperRoot~~''' any~~ PBX~~; '''Operator''' its~~ own ~~root; '''Client''' its own account)~~. It never trusts a numeric tenant from the caller.		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 ==		== Response format ==
	'''Always HTTP 200.''' ~~The '''tasks''' functions~~ always ~~return~~ a JSON envelope: success <code>{"ok":true, ...}</code>, empty <code>{"ok":true,"rows":[]}</code>, error <code>{"ok":false,"code":...,"message":...}</code> (codes: <code>missing_pbx~~, unknown_pbx~~, forbidden, invalid_param, not_found, db_error, server_busy</code>). IDs are exposed as <code>_id</code>. ~~Base~~/legacy functions return their data object directly, or <code>{}</code> ~~on error/empty~~.		'''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 ==		== Functions ==
Line 21:		Line 21:
	* [[TuCloudAPI updateextension]] — Edit an extension.		* [[TuCloudAPI updateextension]] — Edit an extension.
	* [[TuCloudAPI deleteextension]] — Delete an extension after a tenant + dependency check.		* [[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).		* [[TuCloudAPI getextqr]] — SIP provisioning QR for one extension, rendered server-side to a PNG (base64).
	=== CLIs / DIDs (Numeracion) ===		=== CLIs / DIDs (Numeracion) ===
Line 71:		Line 73:
	* [[TuCloudAPI updatelocution]] — Edit a locution (name, waitext, digit routes).		* [[TuCloudAPI updatelocution]] — Edit a locution (name, waitext, digit routes).
	* [[TuCloudAPI deletelocution]] — Delete a locution.		* [[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) ===		=== 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 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 getmusic]] — Get one MOH class (+ has_audio, audio_url).
	* [[TuCloudAPI addmusic]] — Create a MOH class.		* [[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.		* [[TuCloudAPI deletemusic]] — Delete a MOH class.
	=== Schedules (Horarios) ===		=== Schedules (Horarios) ===
Line 182:		Line 192:
	* [[TuCloudAPI addaccountcode]] — Creates a new account (client) under the caller.		* [[TuCloudAPI addaccountcode]] — Creates a new account (client) under the caller.
	* [[TuCloudAPI getcredit]] — Returns credit and status (credit, credit_limit, creditalarm, email, blocked).		* [[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 magic link been clicked? PUBLIC, like authrequest.
			* [[TuCloudAPI authwhoami]] — The current session context, and it refreshes the idle timer.
			* [[TuCloudAPI authlogout]] — Destroy the session and clear the cookie.

	== Related ==		== Related ==

Maintenance script: Fix {{Note}} 1= (func=help)

2026-08-03T14:51:26Z

Fix {{Note}} 1= (func=help)

← Older revision		Revision as of 14:51, 3 August 2026
Line 1:		Line 1:
	{{Note\|New here? Start with '''[[TuCloudAPI help\|the self-discovery endpoint]]'''. This reference is generated from <code>func=help</code>, so it never drifts.}}		{{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 ==		== Overview ==