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

2026-08-03T14:31:32Z

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>id</code> \|\| integer \|\| Yes \|\| — \|\| Extension id (_id).		\| <code>id</code> \|\| integer \|\| Yes \|\| — \|\| Extension id (_id).

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

2026-08-03T14:14:33Z

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 (generated from func=help) — add #48 adminusers + #52 pbxconfig

2026-08-02T04:38:28Z

API docs (generated from func=help) — add #48 adminusers + #52 pbxconfig

New page

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

== Description ==
Edit an extension. num and SIP user are read-only (frozen by the DB trigger). All lookup ids are re-validated to this PBX. Same field set as addextension (minus password/num). 404 if not in the caller's PBX. Requires a non-readonly ukey.

== Call ==
GET https://tucloudapi.7kas.com:9087/tucloud?func=updateextension&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>id</code> || integer || Yes || — || Extension id (_id).
|-
| <code>name</code> || string || Yes || — || Display name (required, max 64).
|-
| <code>cli_id</code> || integer || Yes || — || Outgoing caller ID id (required).
|-
| <code>ringtime</code> || integer || No || <code>0</code> || Ring seconds: 0 or 5-50.
|-
| <code>internalcli_id</code> || integer || No || <code>0</code> || Internal/mobile CLI id (0 = none).
|-
| <code>teamsopt</code> || string || No || <code>S</code> || T=Teams, S=VoIP, TS=both.
|-
| <code>teamsnum</code> || string || No || — || Teams number (digits only, unique).
|-
| <code>pickupgroup</code> || integer || No || <code>0</code> || Pickup group 0-999.
|-
| <code>toext_id</code> || integer || No || <code>0</code> || Send-to extension id (0 = registered).
|-
| <code>backupnum</code> || string || No || — || Backup number (digits and +).
|-
| <code>backupmonpeer</code> || string || No || — || Extension num to monitor.
|-
| <code>music</code> || integer || No || <code>0</code> || Music-on-hold id (0 = default).
|-
| <code>tom</code> || integer || No || <code>0</code> || 0=tone, 1=music.
|-
| <code>voicemail</code> || integer || No || <code>0</code> || 1=enable voicemail.
|-
| <code>email</code> || string || No || — || Voicemail/notification email.
|-
| <code>incom_only_contacts</code> || integer || No || <code>0</code> || 1=only contacts/extensions.
|-
| <code>fwdshowcaller</code> || integer || No || <code>0</code> || 1=show caller on forward.
|-
| <code>fwd_cli</code> || integer || No || <code>0</code> || External-forward caller-ID (0=Si,1=No).
|-
| <code>fwd</code> || integer || No || <code>0</code> || External forward 0-4.
|-
| <code>fwdnum</code> || string || No || — || External forward destination.
|-
| <code>fwd_internal</code> || integer || No || <code>0</code> || Internal forward 0-4.
|-
| <code>fwdnum_internal</code> || string || No || — || Internal forward destination.
|-
| <code>recoutgoing</code> || integer || No || <code>0</code> || 1=record outgoing.
|-
| <code>only_contacts</code> || integer || No || <code>0</code> || 1=restrict outbound to contacts.
|-
| <code>outs_id</code> || integer || No || <code>0</code> || Outgoing service id (0 = none).
|-
| <code>nota</code> || string || No || — || Free note (max 256).
|}
== Example ==
<nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=updateextension&ukey=KEY&pbx=tucall&id=87365&name=Recepcion&cli_id=81324</nowiki>

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

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

TuCloudAPI updateextension - Revision history

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

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

Maintenance script: API docs (generated from func=help) — add #48 adminusers + #52 pbxconfig