OperatorAPI extensions:list

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

Parameters

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

Example

https://host:port/newadm?func=extensions: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,
        "priority":n,
        "app":s,
        "appdata":s,
        "nota":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