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 X-API-Key: YOUR_KEY, or Authorization: Bearer YOUR_KEY, or the ukey query parameter).
Parameters
| Parameter | Type | Required | Default | Meaning |
|---|---|---|---|---|
order |
string | No | context |
Sort field. (id and the twelve shown) |
dir |
string | No | asc |
asc or desc. |
page |
integer | No | 0 |
Zero-based page. |
pagesize |
integer | No | 50 |
Rows per page. |
filterby |
string | No | — | Field to search. (context, name, regexten, callerid - the legacy search box) |
filter |
string | No | — | Literal substring, case-insensitive. |
Example
https://host:port/newadm?func=list§ion=sip&order=context
Response
Success is {"ok":true,"data":{...}}; on refusal {"ok":false,"code":"...","message":"..."}. This function's data shape: {"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?}}.
Errors
Refusals carry a machine-readable code (branch on the code, never the message). See OperatorAPI#Error codes.
Back to OperatorAPI