Wiki 7Kas - User contributions [en]

OperatorAPI vtun:list

2026-08-19T08:28:31Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Lists customer VPN tunnels. Tenant-scoped. The VPN password is credential-class and is published nowhere; `status` is the live tunnel state (1 up, 0 down), set by the monitor and never writable - changing it emails the customer. 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=vtun:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=vtun:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=vtun:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"accountcode":s,
"host":s,
"dev":s,
"ip_svr":s,
"ip_cl":s,
"status":n
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI voicemail:list

2026-08-19T08:28:31Z

Maintenance script: Operator API reference: multi-line response shape

''newadmapi (Operator API) function. Available to: '''Operator'''.''

== Description ==
Customer voicemail boxes. OPERATOR AUDIENCE ONLY (super withheld pending console's ruling). The mailbox PIN is credential-class and published nowhere; INSERT is OFF because the column DEFAULTS to 0000, so a creation that omitted it would silently make a mailbox with a known PIN. 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=voicemail:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=voicemail:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=voicemail:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"context":s,
"mailbox":s,
"email":s
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI usertaresp:list

2026-08-19T08:28:31Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Lists the special-price IMPORT STAGING rows. GLOBAL: root is DATA here - which tenant a price applies to - not the row's owner. 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=usertaresp:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=usertaresp:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=usertaresp:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"root":n,
"tariff":s,
"prefix":s,
"rate":n,
"pickup":n
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI usertardraft:list

2026-08-19T08:28:30Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Lists STAGED customer sale rates - the drafts sys_update_all_rates makes live once entrance <= now. Tenant-scoped. The grid is the view, which resolves tariff, destination and prefix to names; writes go to the base table. 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=usertardraft:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=usertardraft:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=usertardraft:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"tariff":s,
"destination":s,
"prefix":s,
"pickup":n,
"pickup_percent":n,
"pickup_inc":n,
"pickup_lock":n,
"rate":n,
"rate_percent":n,
"rate_inc":n,
"rate_lock":n,
"minseg":n,
"adjust_sec_billing":n,
"entrance":s(ISO-8601, naive)
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI usertarde:list

2026-08-19T08:28:30Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Lists LIVE customer sale rates (the draft's twin, over view_voip_rates). Tenant-scoped. minseg, adjust_sec_billing and entrance are SUPER-ONLY: the super-root adm declares them and all 26 brand adms drop them. entrance is insert-only in both audiences - the view's UPDATE rule does not carry it. 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=usertarde:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=usertarde:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=usertarde:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"tariff":s,
"destination":s,
"prefix":s,
"pickup":n,
"pickup_percent":n,
"pickup_inc":n,
"pickup_lock":n,
"rate":n,
"rate_percent":n,
"rate_inc":n,
"rate_lock":n,
"minseg":n,
"adjust_sec_billing":n,
"entrance":s(ISO-8601, naive)
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI usertar:list

2026-08-19T08:28:30Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Lists the customer tariffs of the caller's tenant. Paginated, sorted and filtered on the declared fields only. `groups` and `root` are columns of the relation and are never published: one is an authority list, the other is scope.

== Call ==
GET|POST https://YOUR_HOST:9089/newadm?func=usertar:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>order</code> || string || No || <code>tariff</code> || Sort field. (id, tariff, description, mastertariff_id)
|-
| <code>dir</code> || string || No || <code>asc</code> || asc or desc.
|-
| <code>page</code> || integer || No || <code>0</code> || Zero-based page.
|-
| <code>pagesize</code> || integer || No || <code>50</code> || Rows per page.
|-
| <code>filterby</code> || string || No || — || Field to search. (tariff, description - a substring search over a key is not offered)
|-
| <code>filter</code> || string || No || — || Literal substring, case-insensitive.
|}
== Example ==
<nowiki>https://host:port/newadm?func=list&section=usertar&order=tariff</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"tariff":s,
"description":s,
"mastertariff_id":n
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI user:list

2026-08-19T08:28:29Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Lists the customers of the caller's tenant. The source view carries a plaintext password and bank-account columns; neither is declared and neither is selected. 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=user:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=user:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=user:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"accountcode":s,
"name":s,
"company":s,
"email":s,
"tariff":s,
"blocked":s,
"credit":n,
"credit_limit":n,
"postpaid":s,
"date_added":s(ISO-8601, naive),
"nota":s,
"nif":s
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI update

2026-08-19T08:28:29Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Changes declared fields of one row, addressed by id. Immutable fields are refused server-side. A row belonging to another tenant is not matched, so it cannot be distinguished from one that does not exist.

{{Note|1=A '''generic verb''': it works over any section via the <code>section</code> parameter. Discover sections with [[OperatorAPI sections]] and a section's fields/capabilities with [[OperatorAPI options]].}}

== Call ==
GET|POST https://YOUR_HOST:9089/newadm?func=update
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>section</code> || string || Yes || — || The section key.
|-
| <code>id</code> || integer || Yes || — || The row to change.
|}
== Example ==
<nowiki>POST https://host:port/newadm?func=update&section=bonos&id=123 body {"price":2.0}</nowiki>

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

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI tucloudpbxen:list

2026-08-19T08:28:29Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Lists the cloud PBXs. The relation carries a password column that no route declares. 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=tucloudpbxen:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=tucloudpbxen:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=tucloudpbxen:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"pbxname":s,
"inlimit":n
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI tucloudpbxcli:list

2026-08-19T08:28:28Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Lists the numbers attached to each cloud PBX. 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=tucloudpbxcli:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=tucloudpbxcli:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=tucloudpbxcli:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"pbxname":s,
"cli":s,
"nota":s
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI tucloudpbx:list

2026-08-19T08:28:28Z

Maintenance script: Operator API reference: multi-line response shape

''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 <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=tucloudpbx:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=tucloudpbx:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"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?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI tucfiles:list

2026-08-19T08:28:28Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Lists device configuration files. The content columns are NOT published - a quarter-megabyte column has no place in a list. 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=tucfiles:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=tucfiles:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=tucfiles:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"username":s,
"title":s,
"path":s,
"filename":s,
"create_date":s(ISO-8601, naive),
"nota":s
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI tucdevices:list

2026-08-19T08:28:27Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Lists the TuCloud devices of the caller's tenant. The source view carries a password column; it is not declared and not selected. 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=tucdevices:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=tucdevices:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=tucdevices:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"username":s,
"accountcode":s,
"release":n,
"status":n,
"create_date":s(ISO-8601, naive),
"firstuse_date":s(ISO-8601, naive),
"nota":s
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI ssipdevices:list

2026-08-19T08:28:27Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Lists the SecureSIP devices. BOTH AUDIENCES, SPLIT BY SCOPE as the two adm applications are: the super tree's globallock is 1=1 so root 0 sees ALL devices across every root - console's own sentence - while the operator sees only their own. The super additionally reassigns a device's root and VTUN server; the operator's form has neither field. INSERT and DELETE are OFF for everyone because view_ssip_devices ACCEPTS NEITHER - one INSTEAD UPDATE rule, no insert or delete rule, proven by attempt and rollback - so the super tree's add/delete buttons are broken controls, not withheld capability. lastuse_date is READ-ONLY: the legacy offers it, the view rule DISCARDS it, and the write reports success while changing nothing - proven by execution. 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=ssipdevices:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=ssipdevices:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=ssipdevices:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"root":n,
"accountcode_name":s,
"mac":s,
"maked":s(ISO-8601, naive),
"firstuse":s(ISO-8601, naive),
"last_boot":s(ISO-8601, naive),
"last_contact":s(ISO-8601, naive),
"lastuse_date":s(ISO-8601, naive),
"release":n,
"revision":n,
"vtunservername":s,
"vtunaddr":s,
"remoteipv4":s,
"online":s,
"uptime":s,
"disable":s,
"checkfs":s,
"tobill":s,
"nota":s
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI sip:list

2026-08-19T08:28:27Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Lists the SIP configurations of the caller's tenant. The relation has 75 columns; twelve are published, and the 61 that are not include secret and md5secret - the SIP passwords, which no route can surface.

== Call ==
GET|POST https://YOUR_HOST:9089/newadm?func=sip:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>order</code> || string || No || <code>context</code> || Sort field. (id and the twelve shown)
|-
| <code>dir</code> || string || No || <code>asc</code> || asc or desc.
|-
| <code>page</code> || integer || No || <code>0</code> || Zero-based page.
|-
| <code>pagesize</code> || integer || No || <code>50</code> || Rows per page.
|-
| <code>filterby</code> || string || No || — || Field to search. (context, name, regexten, callerid - the legacy search box)
|-
| <code>filter</code> || string || No || — || Literal substring, case-insensitive.
|}
== Example ==
<nowiki>https://host:port/newadm?func=list&section=sip&order=context</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"accountcode":s,
"context":s,
"subscribecontext":s,
"regexten":s,
"callerid":s,
"name":s,
"host":s,
"ipaddr":s,
"port":s,
"useragent":s,
"regserver":s,
"nota":s,
"own_softphone_filter":n,
"lockuseragent":n
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI session:menu

2026-08-19T08:28:26Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
The menu this operator may see, NESTED as the legacy renders it: the rows of web_menus for their root, filtered by their groups, built into containers and leaves. A leaf carries served=true and the func to call when this API serves that section, and served=false with func=null when it does not - drawn but not navigable, so the panel shows the whole old menu without offering a route that would refuse. Presentation only: every route authorizes independently, so a section absent here is refused by the route as well, not merely unlisted.

== Call ==
GET|POST https://YOUR_HOST:9089/newadm?func=session:menu
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=session:menu</code>.

== Example ==
<nowiki>https://host:port/newadm?func=session:menu</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"operator":{
"accountcode":s,
"name":s,
"groups":[
s
],
"readonly":b
},
"menu":[
{
"id":n,
"title":s,
"icon":s,
"detail":s,
"children":[
...
]
}|{
"id":n,
"title":s,
"icon":s,
"detail":s,
"section":s,
"served":b,
"func":s|null,
"write":{
"add":b,
"edit":b,
"delete":b
}
}
],
"progress":{
"sections":n,
"served":n
}
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI sections

2026-08-19T08:28:26Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Every section this service serves, with what each offers and what THIS caller may do with it. Read-only. Paired with func=options, which describes one section in full: ask this what exists, then ask that how to talk to it - a client that reads both hardcodes neither the list of sections nor the shape of any one of them.

{{Note|1=A '''generic verb''': it works over any section via the <code>section</code> parameter. Discover sections with [[OperatorAPI sections]] and a section's fields/capabilities with [[OperatorAPI options]].}}

== Call ==
GET|POST https://YOUR_HOST:9089/newadm?func=sections
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=sections</code>.

== Example ==
<nowiki>https://host:port/newadm?func=sections</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"sections":[
{
"section":s,
"relation":s,
"scope":s,
"default_order":s,
"fields":[
s
],
"writable":b,
"complete":b,
"can":{
"insert":b,
"update":b,
"delete":b,
"import":b
},
"options":s
}
],
"served":n,
"complete":n,
"verbs":s
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI request

2026-08-19T08:28:26Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Starts an operator login. Send the address; a one-click link is emailed. The answer is ALWAYS "sent", even for an unknown or rate-limited address - that is anti-enumeration and is deliberate. The browser never holds a credential at this point.

== Call ==
GET|POST https://YOUR_HOST:9089/newadm?func=request
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>email</code> || string || Yes || — || The operator login address.
|}
== Example ==
<nowiki>https://host:port/newadm?func=request</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"status":"sent",
"session_code":s,
"expires_in":n
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI recman:list

2026-08-19T08:28:25Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Lists manual credit entries (prepaid top-ups). importe_con_iva is a SI/NO flag meaning the amount includes IVA - it is not the IVA amount. 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=recman:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=recman:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=recman:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"date":s(ISO-8601, naive),
"accountcode":s,
"detalle":s,
"importe":n,
"importe_con_iva":s,
"factura":s
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI recargas:list

2026-08-19T08:28:25Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Lists TPV recharges - every payment of the tenant, unfiltered, which is the legacy's own lock. recman reads the SAME table through a narrower lock and different columns. 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=recargas:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=recargas:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=recargas:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"date":s(ISO-8601, naive),
"accountcode":s,
"importe":n,
"detalle":s,
"pedido":s,
"estado":n
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI protarde:list

2026-08-19T08:28:25Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Lists the LIVE provider rates - the promoted copy the platform buys at. GLOBAL data, like the providers and destinations it joins. 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=protarde:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=protarde:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=protarde:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"provider":s,
"destination":s,
"prefix":s,
"rate":n,
"minseg":n,
"adjust_sec_billing":n,
"pickup":n,
"route":n
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI protar:list

2026-08-19T08:28:24Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Lists the DRAFT provider rates - the staging copy edited before promotion. 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=protar:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=protar:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=protar:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"provider":s,
"destination":s,
"prefix":s,
"rate":n,
"pickup":n,
"minseg":n,
"adjust_sec_billing":n,
"entrance":s(ISO-8601, naive),
"ownprefix":s,
"nota":s
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI pro:list

2026-08-19T08:28:24Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Lists the upstream carriers. GLOBAL data: a carrier belongs to the platform, not to a tenant. 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=pro:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=pro:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=pro:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"provider":s,
"proxy_uri1":s,
"proxy_uri2":s,
"route":n
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI porta:list

2026-08-19T08:28:24Z

Maintenance script: Operator API reference: multi-line response shape

''newadmapi (Operator API) function. Available to: '''Operator'''.''

== Description ==
Number portability requests. OPERATOR AUDIENCE ONLY (super withheld pending console's ruling) and READ-ONLY by the legacy's own decision - all three verb groups are the deny spelling. 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=porta:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=porta:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=porta:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"date_time":s(ISO-8601, naive),
"cli":s,
"status":s,
"chan_date":s(ISO-8601, naive),
"nota":s
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI poll

2026-08-19T08:28:23Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Polls a login started with func=request. Returns pending, ok, expired or consumed. On the FIRST ok it returns a SHORT, server-revocable session token - never the permanent key.

== Call ==
GET|POST https://YOUR_HOST:9089/newadm?func=poll
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>session_code</code> || string || Yes || — || From func=request.
|}
== Example ==
<nowiki>https://host:port/newadm?func=poll&session_code=CODE</nowiki>

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

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI pbxvirext:list

2026-08-19T08:28:23Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Lists VIRTUAL extensions - wcl_clientes_ext narrowed by the legacy's own unconditional restriction virt = 1, carried in Extra. BOTH AUDIENCES and NOTHING HELD: neither tree overrides globallock and neither declares a self.lock, so there is no super/operator divergence to hold and all 27 adm-tree brand copies are byte-identical. READ-ONLY: the legacy form is 27 fields including password, buzon_clave and groups - the same three blockers as opus and uaccess, on the same relation as end. 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=pbxvirext:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=pbxvirext:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=pbxvirext:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"context":s,
"exten":s,
"cli":s,
"email":s
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI pbxsal:list

2026-08-19T08:28:22Z

Maintenance script: Operator API reference: multi-line response shape

''newadmapi (Operator API) function. Available to: '''Operator'''.''

== Description ==
Conference rooms. OPERATOR AUDIENCE ONLY (super withheld pending console's ruling). The room PIN and moderator PIN are credential-class and are published nowhere, which costs the ability to SET them - the write-only-field ruling would restore it. 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=pbxsal:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=pbxsal:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=pbxsal:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"confname":s,
"context":s,
"confno":s,
"members":n
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI pbxfax:list

2026-08-19T08:28:22Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Lists the fax-to-email extensions of the caller's tenant. 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=pbxfax:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=pbxfax:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=pbxfax:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"accountcode":s,
"context":s,
"fax_ext":s,
"email":s
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI pbxext:list

2026-08-19T08:28:22Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Lists REAL PBX extensions - wcl_clientes_ext narrowed by the legacy's own two unconditional restrictions: virt = 0, and context <> the CALLER'S OWN dialplan context. Both carried in Extra, so they can only narrow. The context is resolved server-side at authentication from wad_admins.context_id via voip_contexts - exactly as the legacy's session.py does - and is never taken from a request; an operator with no context resolved is REFUSED rather than shown every context. Note the direction: this section EXCLUDES your own context, where end (same relation) includes only it. BOTH AUDIENCES, nothing held - the two adm trees differ only in the write groups, and this route is READ-ONLY: the legacy form is 26 fields including password, buzon_clave and groups. 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=pbxext:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=pbxext:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=pbxext:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"context":s,
"exten":s,
"cli":s,
"email":s,
"sip_trunk":s
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI pbx:list

2026-08-19T08:28:22Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Lists virtual PBXs (centralitas). Tenant-scoped. The section has INSERT and DELETE but NO UPDATE - the legacy grants no edit group in either tree - and DELETE is withheld: its trigger destroys the extensions, inbound number, dialplan and voicemail boxes of the centralita. 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=pbx:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=pbx:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=pbx:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"accountcode":s,
"context":s,
"name":s,
"fexten":n,
"ecount":n,
"cli":s,
"date":s(ISO-8601, naive)
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI pas:list

2026-08-19T08:28:21Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Lists the bridge/callback gateway entries of the caller's tenant. The PIN column the legacy shows is NOT carried - see the declaration. 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=pas:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=pas:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=pas:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"accountcode":s,
"cli":s,
"context":s,
"exten":s,
"cid_num":s,
"service":s,
"callback":s,
"language":s
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI opus:list

2026-08-19T08:28:21Z

Maintenance script: Operator API reference: multi-line response shape

''newadmapi (Operator API) function. Available to: '''Operator'''.''

== Description ==
Lists the ADMIN ACCOUNTS of the adm application - wad_admins, the table every caller authenticates against. READ-ONLY, and both reasons are recorded: the legacy's editable set is password (credential-class, held on console's write-only-field ruling with pas.secret and three others) and groups (a PRIVILEGE GRANT read straight into the session). Its row lock is privilege separation rather than tidiness - "rootadmin = false" is what stops an operator admin reaching the platform's super-root accounts, carried in Extra and failed on by check-row-restrictions.sh if it is ever dropped. Delete is off too and deliberately not shipped alone: a screen that removes an admin but cannot create or edit one is worse than no screen. 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=opus:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=opus:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=opus:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"login":s,
"groups":s
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI options

2026-08-19T08:28:21Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
What a SECTION offers, and what THIS caller may do with it: the readable fields with their types and whether each is sortable or searchable, the writable fields with required/immutable, the group writes demand, the export choices, and what a delete would cascade to. func=help describes the FUNCTIONS; this describes a section, because with one engine over many sections "what may I do here" is a property of the section rather than of the verb. Computed from the same declarations the routes enforce, so a panel built from it cannot offer what the route refuses.

{{Note|1=A '''generic verb''': it works over any section via the <code>section</code> parameter. Discover sections with [[OperatorAPI sections]] and a section's fields/capabilities with [[OperatorAPI options]].}}

== Call ==
GET|POST https://YOUR_HOST:9089/newadm?func=options
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>section</code> || string || Yes || — || The section key, e.g. bonos.
|}
== Example ==
<nowiki>https://host:port/newadm?func=options&section=bonos</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"section":s,
"scope":s,
"default_order":s,
"fields":[
{
"name":s,
"type":s,
"sortable":b,
"searchable":b
}
],
"writable":[
{
"name":s,
"type":s,
"required":b,
"immutable":b
}
],
"write_groups":{
...
}|null,
"can":{
"insert":b,
"update":b,
"delete":b,
"import":b
},
"export":{
...
},
"delete":{
...
}
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI opme:list

2026-08-19T08:28:20Z

Maintenance script: Operator API reference: multi-line response shape

''newadmapi (Operator API) function. Available to: '''Operator'''.''

== Description ==
Which groups reach each menu option. Edit-only by root, operator audience only. `name`, `detalle`, `imagen` and `url` are READABLE BUT NOT WRITABLE: the legacy renders them into an inline JavaScript block unescaped, so a write path here would let an operator run script in another administrator's browser. Narrower than the legacy, deliberately, and NOT a fix - the sink remains open. 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=opme:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=opme:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=opme:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"app":s,
"name":s,
"detalle":s,
"mowner":s,
"groups":s
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI opap:list

2026-08-19T08:28:20Z

Maintenance script: Operator API reference: multi-line response shape

''newadmapi (Operator API) function. Available to: '''Operator'''.''

== Description ==
Which groups reach each application - the access-control data itself. Edit-only by root, operator audience only. Editing it changes what is DISPLAYED and grants nothing: Helm gates execution on scope, role and groups, never on these rows. 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=opap:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=opap:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=opap:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"name":s,
"groups":s
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI lookup

2026-08-19T08:28:19Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
One writable field's picker, served for a GIVEN root instead of baked into the func=options contract for your own. It exists so a client list can FOLLOW a selected root: ssipdevices lets a super reassign a device to any root, and the Cliente dropdown must become that root's clients or a save silently reassigns. The super may ask for ANY root (reasign.all); an operator may ask only for its own and a different root is refused, never quietly answered for the wrong tenant. The picker is shaped by the SAME engine func=options uses, so it cannot drift; only the tenant it is pinned to differs. The section's own read gate applies first.

{{Note|1=A '''generic verb''': it works over any section via the <code>section</code> parameter. Discover sections with [[OperatorAPI sections]] and a section's fields/capabilities with [[OperatorAPI options]].}}

== Call ==
GET|POST https://YOUR_HOST:9089/newadm?func=lookup
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>section</code> || string || Yes || — || The section key, e.g. ssipdevices.
|-
| <code>field</code> || string || Yes || — || The writable field whose picker you want, e.g. accountcode_id.
|-
| <code>root</code> || integer || No || — || The root whose list you want. (REQUIRED for a super (any root). For an operator it may be omitted (means your own) and any other root is refused)
|}
== Example ==
<nowiki>https://host:port/newadm?func=lookup&section=ssipdevices&field=accountcode_id&root=5</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"section":s,
"field":s,
"root":n,
"options":[
{
"value":s,
"label":s
}
],
"options_error":s|null
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI login

2026-08-19T08:28:19Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Exchanges an operator ukey for a short, revocable session. The key goes in the X-API-Key HEADER and is never accepted in the query string or body. Every failure returns the same auth_invalid, so a blocked key cannot be told apart from an unknown one.

== Call ==
GET|POST https://YOUR_HOST:9089/newadm?func=login
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=login</code>.

== Example ==
<nowiki>https://host:port/newadm?func=login</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"session":s,
"operator":{
"accountcode":s,
"name":s,
"groups":[
s
],
"readonly":b
}
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI llamadasacentrantes:list

2026-08-19T08:28:19Z

Maintenance script: Operator API reference: multi-line response shape

''newadmapi (Operator API) function. Available to: '''Operator'''.''

== Description ==
Lists inbound calls IN PROGRESS - the same view as incomingcalls with the same flags bit SET rather than clear ("flags & 8 = 8"). billsec is absent from this grid in both trees because a call in progress has no billed duration yet. OPERATOR AUDIENCE, READ-ONLY. 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=llamadasacentrantes:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=llamadasacentrantes:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=llamadasacentrantes:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"callstart":s(ISO-8601, naive),
"accountcode":s,
"src":s,
"dst":s,
"fromtag":s,
"msg":s
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI llamadasac:list

2026-08-19T08:28:19Z

Maintenance script: Operator API reference: multi-line response shape

''newadmapi (Operator API) function. Available to: '''Operator'''.''

== Description ==
Lists ALL calls in progress, from view_voip_calls_active - a DIFFERENT view and a DIFFERENT TENANT COLUMN (r_root, not root), both verified against information_schema. Predicate "flags & 8 = 8". The customer balance r_credit is published as money and is NOT searchable, per the rule ratified for user.credit. OPERATOR AUDIENCE, READ-ONLY. 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=llamadasac:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=llamadasac:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=llamadasac:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"callstart":s(ISO-8601, naive),
"r_accountcode":s,
"cid_name":s,
"cid_num":s,
"dial_cid_num":s,
"prefix":s,
"dst":s,
"r_tariff":s,
"r_credit":n,
"sipmsg":s,
"duracion":s
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI list

2026-08-19T08:28:18Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Lists any served section. The section names WHICH declaration is used; the declaration decides the relation, the tenant scope, the published fields and what may be sorted or searched. Same engine and same rules as the per-section <section>:list routes, which remain registered.

{{Note|1=A '''generic verb''': it works over any section via the <code>section</code> parameter. Discover sections with [[OperatorAPI sections]] and a section's fields/capabilities with [[OperatorAPI options]].}}

== Call ==
GET|POST https://YOUR_HOST:9089/newadm?func=list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>section</code> || string || Yes || — || The section key, e.g. bonos.
|-
| <code>order</code> || string || No || — || Sort field, from the declared set.
|-
| <code>dir</code> || string || No || <code>asc</code> || asc or desc.
|-
| <code>page</code> || integer || No || <code>0</code> || Zero-based page.
|-
| <code>pagesize</code> || integer || No || <code>50</code> || Rows per page, 1..500.
|-
| <code>filterby</code> || string || No || — || Field to search, from the declared set.
|-
| <code>filter</code> || string || No || — || Literal substring, case-insensitive.
|-
| <code>fields</code> || string || No || — || Comma-separated subset of the declared fields, in column order. (The same parameter export and print use, so all three agree on what "the current view" is)
|}
== Example ==
<nowiki>https://host:port/newadm?func=list&section=bonos&order=name</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
...
],
"page":n,
"pagesize":n,
"order":s,
"dir":s
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI insert

2026-08-19T08:28:18Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Creates a row in a section. The record fields travel as a JSON body and must be exactly the declared writable set - an unknown or duplicated field is refused BY NAME. The tenant is stamped from your credential and may not be supplied. Requires the group the section declares.

{{Note|1=A '''generic verb''': it works over any section via the <code>section</code> parameter. Discover sections with [[OperatorAPI sections]] and a section's fields/capabilities with [[OperatorAPI options]].}}

== Call ==
GET|POST https://YOUR_HOST:9089/newadm?func=insert
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>section</code> || string || Yes || — || The section key.
|}
== Example ==
<nowiki>POST https://host:port/newadm?func=insert&section=bonos body {"name":"Bono 60","price":1.5,"seconds":3600}</nowiki>

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

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI incomingcalls:list

2026-08-19T08:28:18Z

Maintenance script: Operator API reference: multi-line response shape

''newadmapi (Operator API) function. Available to: '''Operator'''.''

== Description ==
Lists inbound call history. OPERATOR AUDIENCE, READ-ONLY (all three verb groups are the [""] deny spelling in BOTH trees - not the [] that fail-opens). The legacy narrows this screen with globallock "flags & 8 = 0", carried here as a static predicate ANDed inside the tenant clause. Super audience HELD: adm applies the same mask with NO tenant clause. 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=incomingcalls:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=incomingcalls:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=incomingcalls:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"callstart":s(ISO-8601, naive),
"accountcode":s,
"src":s,
"dst":s,
"fromtag":s,
"msg":s,
"billsec":n
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI get

2026-08-19T08:28:17Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
One row of a section, by id, tenant-scoped and projected through the SAME declared field list as list - so an edit form can never receive a column the grid would not show.

{{Note|1=A '''generic verb''': it works over any section via the <code>section</code> parameter. Discover sections with [[OperatorAPI sections]] and a section's fields/capabilities with [[OperatorAPI options]].}}

== Call ==
GET|POST https://YOUR_HOST:9089/newadm?func=get
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>section</code> || string || Yes || — || The section key.
|-
| <code>id</code> || integer || Yes || — || The row key.
|}
== Example ==
<nowiki>https://host:port/newadm?func=get&section=bonos&id=123</nowiki>

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

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI extensions:list

2026-08-19T08:28:17Z

Maintenance script: Operator API reference: multi-line response shape

''newadmapi (Operator API) function. Available to: '''Operator'''.''

== Description ==
Lists the DIALPLAN - voip_extensions_conf, the rows that make a number ring. The legacy restricts to context <> ''default'' for [root, admin, user]; Helm applies it to every caller. MEASURED COST: ZERO - nobody holds mon or tl1 in either database, so the 15,479 hidden rows are hidden from a class of caller that does not exist, and this section's own verb grants to mon and tl1 grant nothing to anybody. Operator audience, super HELD. The operator has FULL CRUD; each write JOINS the statement-cache propagation family - this relation's only trigger sends the cached SQL to a platform node - acknowledged as an outward effect. 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=extensions:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=extensions:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=extensions:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"context":s,
"exten":s,
"priority":n,
"app":s,
"appdata":s,
"nota":s
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI end:list

2026-08-19T08:28:16Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Lists customer endpoints. The relation is a LOGIN ACCOUNT table - its password, voicemail PIN and groups columns are declared by nothing. 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=end:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=end:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=end:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"accountcode":s,
"cli":s,
"faxidnum":s,
"sip_trunk":s
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI didstock:list

2026-08-19T08:28:16Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Lists the numbering STOCK. BOTH audiences now. The SUPER reads it GLOBALLY and unfiltered - adm's globallock is 1=1 with restrictions=() - which is what the tucloudpbx alta needs: a number is chosen from this stock. The OPERATOR keeps the legacy's lock = false restriction, applied to every operator caller on newadm's narrowest-for-everyone ruling. MEASURED COST of that operator restriction, on tucalldev and production alike: 3 accounts hold neither admin nor user (the two port integration accounts and the one none account) and they lose 7,597 of 13,763 rows. The OPERATOR can EDIT (fromip, nota; cli is IMMUTABLE - the trigger silently reverts any change, NEW.cli = OLD.cli). The SUPER is read-only for now, its write a separate follow-up. 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=didstock:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=didstock:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=didstock:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"cli":s,
"root":n,
"province":s,
"lock":b,
"fromip":s,
"nota":s
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI didhist:list

2026-08-19T08:28:15Z

Maintenance script: Operator API reference: multi-line response shape

''newadmapi (Operator API) function. Available to: '''Operator'''.''

== Description ==
Numbering history - when each DID was opened and closed. OPERATOR AUDIENCE ONLY (super withheld pending console's row-filter ruling) and READ-ONLY BY THE LEGACY'S OWN DECISION: all three verb groups are the deny spelling. 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=didhist:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=didhist:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=didhist:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"alta":s(ISO-8601, naive),
"baja":s(ISO-8601, naive),
"cli":s,
"accountcode":s,
"nota":s
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI destinos:list

2026-08-19T08:28:15Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Lists the shared dialling-plan destinations. GLOBAL data: one row per prefix for every tenant, which is why this route is not tenant-filtered. 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=destinos:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=destinos:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=destinos:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"prefix":s,
"destination":s
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI delete

2026-08-19T08:28:15Z

Maintenance script: Operator API reference: multi-line response shape

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

== Description ==
Removes one row, addressed by id, within your tenant. When the row has dependants that would CASCADE, the first call is refused and states how many rows would go with it; repeat with confirm_cascade=true to proceed. A dependant that blocks the delete is named rather than surfaced as a constraint error.

{{Note|1=A '''generic verb''': it works over any section via the <code>section</code> parameter. Discover sections with [[OperatorAPI sections]] and a section's fields/capabilities with [[OperatorAPI options]].}}

== Call ==
GET|POST https://YOUR_HOST:9089/newadm?func=delete
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>section</code> || string || Yes || — || The section key.
|-
| <code>id</code> || integer || Yes || — || The row to remove.
|-
| <code>confirm_cascade</code> || boolean || No || <code>false</code> || Proceed although dependent rows will be deleted too. (Only needed when a previous call reported a cascade count)
|}
== Example ==
<nowiki>POST https://host:port/newadm?func=delete&section=bonos&id=123</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"section":s,
"id":n,
"deleted":true,
"cascaded":n
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]

OperatorAPI click2callinmovilla:list

2026-08-19T08:28:14Z

Maintenance script: Operator API reference: multi-line response shape

''newadmapi (Operator API) function. Available to: '''Operator'''.''

== Description ==
Lists the Inmovilla click-to-call agency links. OPERATOR-ONLY: the section exists in whitelabel/adm and NOT in the super-root tree - the first section in the port where the operator application has a screen the platform one does not. Tenant-scoped by the engine default. INSERT is off: cli and exten are NOT NULL with no default and the legacy form declares neither, so the legacy add has never worked. 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=click2callinmovilla:list
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=click2callinmovilla:list</code>.

== Example ==
<nowiki>https://host:port/newadm?func=click2callinmovilla:list</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
"ok":true,
"data":{
"rows":[
{
"id":n,
"accountcode":s,
"context":s,
"enabled":n
}
],
"page":n,
"pagesize":n,
"fields":[
s
],
"available":[
s
],
"order":s,
"dir":s,
"filterby":s?,
"filter":s?
}
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]