View source for OperatorAPI cli:list

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

== Description ==
Lists the inbound numbers 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=cli: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=cli:list</code>.

== Example ==
 <nowiki>https://host:port/newadm?func=cli: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,
        "cli":s,
        "accountcode":s,
        "pbx":s,
        "context":s,
        "exten":s,
        "fromip":s,
        "nota":s,
        "recordroute":n,
        "CliProvider":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]]