View source for OperatorAPI sip:list

''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. <small>(id and the twelve shown)</small>
|-
| <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 || &mdash; || Field to search. <small>(context, name, regexten, callerid - the legacy search box)</small>
|-
| <code>filter</code> || string || No || &mdash; || 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>{"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?}}</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]]