TuCloudAPI - Revision history

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

Maintenance script: TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged)

2026-08-03T14:31:37Z

TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged)

← Older revision		Revision as of 14:31, 3 August 2026
Line 166:		Line 166:
	* [[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.		* [[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 ===		=== FuturePBX ===
	* [[TuCloudAPI getpbxloclog]] — ~~Tucloud PBX~~ IVR/locution DTMF key-press log for a period.		* [[TuCloudAPI getpbxloclog]] — FuturePBX IVR/locution DTMF key-press log for a period.
	=== Meta / discovery ===		=== 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.		* [[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.

Maintenance script: TuCloudAPI reference: product name -> FuturePBX (API surface unchanged); regenerated from func=help

2026-08-03T14:14:38Z

TuCloudAPI reference: product name -> FuturePBX (API surface unchanged); regenerated from func=help

← Older revision		Revision as of 14:14, 3 August 2026
Line 2:		Line 2:

	== Overview ==		== Overview ==
	'''TuCloudAPI''' is the REST API to manage '''~~tucloud~~''' (the multi-tenant PBX~~, a.k.a. futurepbx~~). '''HTTPS, GET, JSON.''' Base URL:		'''TuCloudAPI''' is the REST API to manage '''FuturePBX''' (the multi-tenant cloud PBX). '''HTTPS, GET, JSON.''' 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

Line 32:		Line 32:
	* [[TuCloudAPI getroutes]] — List inbound routes for the PBX with step counts.		* [[TuCloudAPI getroutes]] — List inbound routes for the PBX with step counts.
	* [[TuCloudAPI getroute]] — Get one route header plus its ordered steps (destinations).		* [[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 and ~~routes~~.		* [[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 addroute]] — Create an inbound route (header only; add steps with addroutestep).
	* [[TuCloudAPI updateroute]] — Rename/annotate a route header.		* [[TuCloudAPI updateroute]] — Rename/annotate a route header.
Line 104:		Line 104:
	* [[TuCloudAPI getqueues]] — List the PBX call queues (ACD) with member counts.		* [[TuCloudAPI getqueues]] — List the PBX call queues (ACD) with member counts.
	* [[TuCloudAPI getqueue]] — Get one queue's config.		* [[TuCloudAPI getqueue]] — Get one queue's config.
	* [[TuCloudAPI getqueuelookups]] — Tenant-scoped pickers for the queue form: music (MOH classes) ~~and~~ the strategy enum.		* [[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 addqueue]] — Create a call queue.
	* [[TuCloudAPI updatequeue]] — Edit a queue's config.		* [[TuCloudAPI updatequeue]] — Edit a queue's config.
	* [[TuCloudAPI deletequeue]] — Delete a queue.		* [[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) ===		=== Portal admin users (Usuarios) ===
	* [[TuCloudAPI getadminusers]] — List this PBX's portal admin users (tucloud_sec_users).		* [[TuCloudAPI getadminusers]] — List this PBX's portal admin users (tucloud_sec_users).
Line 159:		Line 165:
	=== Audio files ===		=== 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.		* [[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.
	=== ~~Tucloud PBX~~ ===		=== FuturePBX ===
	* [[TuCloudAPI getpbxloclog]] — Tucloud PBX IVR/locution DTMF key-press log for a period.		* [[TuCloudAPI getpbxloclog]] — Tucloud PBX IVR/locution DTMF key-press log for a period.
	=== Meta / discovery ===		=== Meta / discovery ===

Maintenance script: TuCloudAPI reference — add func=aichat (AI assistant) + reports category

2026-08-02T17:32:02Z

TuCloudAPI reference — add func=aichat (AI assistant) + reports category

← Older revision		Revision as of 17:32, 2 August 2026
Line 137:		Line 137:
	=== Reports / statistics (Informes) ===		=== Reports / statistics (Informes) ===
	* [[TuCloudAPI getreports]] — Call-volume statistics (Informes / Estadisticas de Llamadas) for a month — VOLUME ONLY, no prices.		* [[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) ===		=== Scheduled tasks (Tareas programadas) ===
	* [[TuCloudAPI gettasks]] — List scheduled tasks (tareas programadas) for the PBX, with schedule + status labels and step counts.		* [[TuCloudAPI gettasks]] — List scheduled tasks (tareas programadas) for the PBX, with schedule + status labels and step counts.

Maintenance script: API docs — add #41/#42 getreports (statistics)

2026-08-02T10:49:22Z

API docs — add #41/#42 getreports (statistics)

← Older revision		Revision as of 10:49, 2 August 2026
Line 135:		Line 135:
	* [[TuCloudAPI getcdr]] — List a period of this PBX's call detail records (Registro de llamadas), newest first.		* [[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.		* [[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.
	=== Scheduled tasks (Tareas programadas) ===		=== Scheduled tasks (Tareas programadas) ===
	* [[TuCloudAPI gettasks]] — List scheduled tasks (tareas programadas) for the PBX, with schedule + status labels and step counts.		* [[TuCloudAPI gettasks]] — List scheduled tasks (tareas programadas) for the PBX, with schedule + status labels and step counts.

Maintenance script: API docs — add #39/#40 getcdr (via restapi)

2026-08-02T07:00:16Z

API docs — add #39/#40 getcdr (via restapi)

← Older revision		Revision as of 07:00, 2 August 2026
Line 132:		Line 132:
	* [[TuCloudAPI setprofileapp]] — Set ONE app's permissions for a profile.		* [[TuCloudAPI setprofileapp]] — Set ONE app's permissions for a profile.
	* [[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) ===
			* [[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.
	=== Scheduled tasks (Tareas programadas) ===		=== Scheduled tasks (Tareas programadas) ===
	* [[TuCloudAPI gettasks]] — List scheduled tasks (tareas programadas) for the PBX, with schedule + status labels and step counts.		* [[TuCloudAPI gettasks]] — List scheduled tasks (tareas programadas) for the PBX, with schedule + status labels and step counts.

Maintenance script: API docs — add #57/#58 getdashboard

2026-08-02T06:20:07Z

API docs — add #57/#58 getdashboard

← Older revision		Revision as of 06:20, 2 August 2026
Line 12:		Line 12:

	== Functions ==		== Functions ==
			=== Dashboard (landing counts) ===
			* [[TuCloudAPI getdashboard]] — Landing-page dashboard: per-tenant object counts + a cheap health metric, in one call.
	=== Extensions (Extensiones) ===		=== Extensions (Extensiones) ===
	* [[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).

Maintenance script: API docs (generated from func=help) — setprofileapps wording fix

2026-08-02T05:44:54Z

API docs (generated from func=help) — setprofileapps wording fix

← Older revision		Revision as of 05:44, 2 August 2026
Line 127:		Line 127:
	* [[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 permission matrix in one call (the primary matrix write).		* [[TuCloudAPI setprofileapps]] — Bulk-save a profile's FULL permission matrix in one call (the primary matrix write).
	* [[TuCloudAPI setprofileapp]] — Set ONE app's permissions for a profile.		* [[TuCloudAPI setprofileapp]] — Set ONE app's permissions for a profile.
	* [[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).

Maintenance script: API docs (generated from func=help) — add getprofileusers + #50 review fixes

2026-08-02T05:42:38Z

API docs (generated from func=help) — add getprofileusers + #50 review fixes

← Older revision		Revision as of 05:42, 2 August 2026
Line 122:		Line 122:
	* [[TuCloudAPI getprofileapps]] — Get a profile's app-permission matrix only (the Aplicaciones/Perfiles editor).		* [[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 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 getuserprofiles]] — Get an admin user's profile membership + the profile picker (this PBX only).
	* [[TuCloudAPI addprofile]] — Create a security profile in this PBX.		* [[TuCloudAPI addprofile]] — Create a security profile in this PBX.

Maintenance script: API docs (generated from func=help) — add #50 security profiles/ACL

2026-08-02T05:36:55Z

API docs (generated from func=help) — add #50 security profiles/ACL

@@ Line 117: / Line 117: @@
 * [[TuCloudAPI getpbxconfiglookups]] — Picker for the admin_ext_id field: this PBX's extensions.
 * [[TuCloudAPI updatepbxconfig]] — Update this PBX's settings (strict set).
 === Scheduled tasks (Tareas programadas) ===
 * [[TuCloudAPI gettasks]] — List scheduled tasks (tareas programadas) for the PBX, with schedule + status labels and step counts.