OperatorAPI tucloudpbx:list

newadmapi (Operator API) function. Available to: Operator, SuperRoot.

Description

Lists the TuCloud cloud PBXs. BOTH audiences: the SUPER reads GLOBAL (its adm tree globallock is 1=1, with root shown as a column) and the OPERATOR is tenant-scoped - the same audience split as cli. WRITES: create is the tucloud_mkpbx provisioning alta (func=insert, ProvisionInsert - not a plain row insert), edit is denied in both trees, and DELETE is open to both as the legacy grants it (groups_delete [root,admin]); its cascade - 573 SIP registrations, 573 voicemail boxes and 23 ON DELETE CASCADE relations - is disclosed in side_effects and func=options, not hidden. password is NOT published although both legacy grids show it in plain text - a real narrowing, recorded as one. Paginated. Sorting and searching are restricted to the declared fields; anything else is rejected and named. Read audience is provisional pending operator confirmation.

Call

GET|POST https://YOUR_HOST:9089/newadm?func=tucloudpbx:list

Send your API key with every request (header X-API-Key: YOUR_KEY, or Authorization: Bearer YOUR_KEY, or the ukey query parameter).

Parameters

None beyond the API key and func=tucloudpbx:list.

Example

https://host:port/newadm?func=tucloudpbx:list

Response

Success is {"ok":true,"data":{...}}; on refusal {"ok":false,"code":"...","message":"..."}. This function's data shape (n = number, s = string, ? = present only when set):

{
  "ok":true,
  "data":{
    "rows":[
      {
        "id":n,
        "accountcode":s,
        "name":s,
        "pbxname":s,
        "maxext":n,
        "domain":s,
        "inlimit":n,
        "create_date":s(ISO-8601, naive),
        "root":n
      }
    ],
    "page":n,
    "pagesize":n,
    "fields":[
      s
    ],
    "available":[
      s
    ],
    "order":s,
    "dir":s,
    "filterby":s?,
    "filter":s?
  }
}

Errors

Refusals carry a machine-readable code (branch on the code, never the message). See OperatorAPI#Error codes.

Back to OperatorAPI