TuCloudAPI simulatecall - Revision history

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

2026-08-03T14:31:29Z

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

← Older revision		Revision as of 14:31, 3 August 2026
Line 12:		Line 12:
	! Parameter !! Type !! Required !! Default !! Meaning		! Parameter !! Type !! Required !! Default !! Meaning
	\|-		\|-
	\| <code>pbx</code> \|\| string \|\| Yes \|\| — \|\| ~~TuCloud PBX~~ NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX.		\| <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>origen</code> \|\| string \|\| Yes \|\| — \|\| Caller number. If it matches a PBX extension the call is outbound/internal; otherwise it is treated as an inbound external caller.		\| <code>origen</code> \|\| string \|\| Yes \|\| — \|\| Caller number. If it matches a PBX extension the call is outbound/internal; otherwise it is treated as an inbound external caller.

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

2026-08-03T14:14:30Z

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

← Older revision		Revision as of 14:14, 3 August 2026
Line 1:		Line 1:
	''TuCloudAPI function to manage ~~tucloud~~ (PBX) ~~services~~. Available to: '''SuperRoot, Operator, Client'''.''		''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.''

	== Description ==		== Description ==

Maintenance script: API docs — simulatecall step.ring_s + levels[]

2026-08-02T06:03:37Z

API docs — simulatecall step.ring_s + levels[]

← Older revision		Revision as of 06:03, 2 August 2026
Line 24:		Line 24:

	== Response ==		== Response ==
	{ok:true, direction:"inbound\|outbound\|internal", origen, destino, flujo:[STEP...]}. STEP={tipo, descripcion, edit_kind:"extension\|group\|locution\|route\|queue"\|null, edit_id:<_id>\|null, opciones:[{tecla,ruta,flujo:[STEP...]}] (IVR only), audio:{kind:"locution\|music", id:<_id>, root, directory, file, url:<getaudio URL minus ukey>} (when applicable — use audio.kind+audio.id to call getaudio, or fetch audio.url directly)}. Errors: {ok:false,code,message} with code in missing_pbx\|unknown_pbx\|forbidden\|invalid_param\|db_error.		{ok:true, direction:"inbound\|outbound\|internal", origen, destino, flujo:[STEP...]}. STEP={tipo, descripcion, edit_kind:"extension\|group\|locution\|route\|queue"\|null, edit_id:<_id>\|null, opciones:[{tecla,ruta,flujo:[STEP...]}] (IVR only), ring_s:<seconds> (ring time on timbre/app_grupo steps — also in descripcion text), levels:[{nivel,exts,ring_s}] (app_grupo per-level ring detail), audio:{kind:"locution\|music", id:<_id>, root, directory, file, url:<getaudio URL minus ukey>} (when applicable — use audio.kind+audio.id to call getaudio, or fetch audio.url directly)}. Errors: {ok:false,code,message} with code in missing_pbx\|unknown_pbx\|forbidden\|invalid_param\|db_error.

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

Maintenance script: audio node id/url + getaudio general

2026-08-01T19:28:50Z

audio node id/url + getaudio general

← Older revision		Revision as of 19:28, 1 August 2026
Line 24:		Line 24:

	== Response ==		== Response ==
	{ok:true, direction:"inbound\|outbound\|internal", origen, destino, flujo:[STEP...]}. STEP={tipo, descripcion, edit_kind:"extension\|group\|locution\|route\|queue"\|null, edit_id:<_id>\|null, opciones:[{tecla,ruta,flujo:[STEP...]}] (IVR only), audio:{kind:"locution\|music",root,directory,file} (when applicable)}. Errors: {ok:false,code,message} with code in missing_pbx\|unknown_pbx\|forbidden\|invalid_param\|db_error.		{ok:true, direction:"inbound\|outbound\|internal", origen, destino, flujo:[STEP...]}. STEP={tipo, descripcion, edit_kind:"extension\|group\|locution\|route\|queue"\|null, edit_id:<_id>\|null, opciones:[{tecla,ruta,flujo:[STEP...]}] (IVR only), audio:{kind:"locution\|music", id:<_id>, root, directory, file, url:<getaudio URL minus ukey>} (when applicable — use audio.kind+audio.id to call getaudio, or fetch audio.url directly)}. Errors: {ok:false,code,message} with code in missing_pbx\|unknown_pbx\|forbidden\|invalid_param\|db_error.

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

Maintenance script: TuCloudAPI reference (regenerated: + simulatecall)

2026-08-01T17:42:57Z

TuCloudAPI reference (regenerated: + simulatecall)

New page

''TuCloudAPI function to manage tucloud (PBX) services. Available to: '''SuperRoot, Operator, Client'''.''

== Description ==
Simulate how a call routes (inbound DID / outbound / internal) WITHOUT placing a real call, returning the ordered decision trace (flujo). Read-only: no DB writes, no side effects. Origin that is one of the PBX extensions => outbound/internal; otherwise => inbound to the destination CLI/DID. Reproduces the mod_futurepbx routing engine (calendar, 12-timer schedule with _ee blacklist gating, routes/IVR, groups, forwarding, star codes, outbound rules).

== Call ==
GET https://tucloudapi.7kas.com:9087/tucloud?func=simulatecall&ukey=YOUR_KEY
Requires the <code>ukey</code> parameter.

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>pbx</code> || string || Yes || — || TuCloud PBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX.
|-
| <code>origen</code> || string || Yes || — || Caller number. If it matches a PBX extension the call is outbound/internal; otherwise it is treated as an inbound external caller.
|-
| <code>destino</code> || string || Yes || — || Called number: an extension, a star/feature code, a CLI/DID, or an external number.
|-
| <code>datetime</code> || string || No || <code>server local now</code> || Evaluation moment in ISO "YYYY-MM-DD HH:MM" (used for calendar/schedule windows). Server derives monthday=MMDD, weekday=0..6 (0=Sunday), hourmin=HHMM. <small>(Format YYYY-MM-DD HH:MM; defaults to the server local clock.)</small>
|}
== Example ==
<nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=simulatecall&ukey=KEY&pbx=tucall&origen=600123456&destino=960800120</nowiki>

== Response ==
{ok:true, direction:"inbound|outbound|internal", origen, destino, flujo:[STEP...]}. STEP={tipo, descripcion, edit_kind:"extension|group|locution|route|queue"|null, edit_id:<_id>|null, opciones:[{tecla,ruta,flujo:[STEP...]}] (IVR only), audio:{kind:"locution|music",root,directory,file} (when applicable)}. Errors: {ok:false,code,message} with code in missing_pbx|unknown_pbx|forbidden|invalid_param|db_error.

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