Jump to content

TuCloudAPI getprofileusers: Difference between revisions

From Wiki 7Kas
API docs (generated from func=help) — add getprofileusers + #50 review fixes
 
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 and scopes every profile to it.
| <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 and scopes every profile to it.
|-
|-
| <code>group</code> || integer || Yes || — || Profile id (_id).
| <code>group</code> || integer || Yes || — || Profile 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

List the admin users assigned to a profile (read-only "Miembros" list; edits stay per-user via setuserprofiles). Members are admin users in this PBX. not_found if the profile is not in this PBX.

Call

GET  https://tucloudapi.7kas.com:9087/tucloud?func=getprofileusers&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 and scopes every profile to it.
group integer Yes Profile id (_id).

Example

https://tucloudapi.7kas.com:9087/tucloud?func=getprofileusers&ukey=KEY&pbx=tucall&group=1

Response

{ok, logins:[{login,name}]}.


Back to TuCloudAPI