Jump to content

TuCloudAPI addroute

From Wiki 7Kas
Revision as of 04:37, 2 August 2026 by Maintenance script (talk | contribs) (API docs (generated from func=help) — add #48 adminusers + #52 pbxconfig)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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

Description

Create an inbound route (header only; add steps with addroutestep). Server derives tucloudpbx_id + root. Requires a non-readonly ukey.

Call

GET  https://tucloudapi.7kas.com:9087/tucloud?func=addroute&ukey=YOUR_KEY

Requires the ukey parameter.

Parameters

Parameter Type Required Default Meaning
pbx string Yes TuCloud PBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX.
name string Yes Route name (required, max 32).
nota string No Optional note (max 256).
ref_id integer No 0 Optional grouping reference (0 = none).

Example

https://tucloudapi.7kas.com:9087/tucloud?func=addroute&ukey=KEY&pbx=tucall&name=Horario

Response

{ok, route:{_id,name,nota,ref_id}}.


Back to TuCloudAPI