View source for OperatorAPI pbxvirext:list

''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>{"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?}}</code>.

== 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]]