Jump to content

TuCloudAPI updateextension: Difference between revisions

From Wiki 7Kas
API docs (generated from func=help) — add #48 adminusers + #52 pbxconfig
 
TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged)
 
(One intermediate revision by the same user not shown)
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 ==
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).

Latest revision as of 14:31, 3 August 2026

TuCloudAPI function to manage FuturePBX (the cloud PBX). 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 ukey parameter.

Parameters

Parameter Type Required Default Meaning
pbx string Yes FuturePBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX.
id integer Yes Extension id (_id).
name string Yes Display name (required, max 64).
cli_id integer Yes Outgoing caller ID id (required).
ringtime integer No 0 Ring seconds: 0 or 5-50.
internalcli_id integer No 0 Internal/mobile CLI id (0 = none).
teamsopt string No S T=Teams, S=VoIP, TS=both.
teamsnum string No Teams number (digits only, unique).
pickupgroup integer No 0 Pickup group 0-999.
toext_id integer No 0 Send-to extension id (0 = registered).
backupnum string No Backup number (digits and +).
backupmonpeer string No Extension num to monitor.
music integer No 0 Music-on-hold id (0 = default).
tom integer No 0 0=tone, 1=music.
voicemail integer No 0 1=enable voicemail.
email string No Voicemail/notification email.
incom_only_contacts integer No 0 1=only contacts/extensions.
fwdshowcaller integer No 0 1=show caller on forward.
fwd_cli integer No 0 External-forward caller-ID (0=Si,1=No).
fwd integer No 0 External forward 0-4.
fwdnum string No External forward destination.
fwd_internal integer No 0 Internal forward 0-4.
fwdnum_internal string No Internal forward destination.
recoutgoing integer No 0 1=record outgoing.
only_contacts integer No 0 1=restrict outbound to contacts.
outs_id integer No 0 Outgoing service id (0 = none).
nota string No Free note (max 256).

Example

https://tucloudapi.7kas.com:9087/tucloud?func=updateextension&ukey=KEY&pbx=tucall&id=87365&name=Recepcion&cli_id=81324

Response

{ok, ext:{...}}.


Back to TuCloudAPI