OperatorAPI pbxext:list

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

Parameters

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

Example

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

Response

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

{
  "ok":true,
  "data":{
    "rows":[
      {
        "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?
  }
}

Errors

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

---

Back to OperatorAPI