OperatorAPI bonosdst:list
newadmapi (Operator API) function. Available to: Operator, SuperRoot.
Description
Lists the destination prefixes belonging to a VoIP bundle, for the caller's tenant. Paginated. Sorting is restricted to the declared fields. NOTE: the read audience is provisional - the legacy panel enforced none and its two surviving signals disagree - and is pending operator confirmation.
Call
GET|POST https://YOUR_HOST:9089/newadm?func=bonosdst: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 | name |
Sort field. One of the declared fields. (id, name, name_dst, prefix - anything else is rejected) |
dir |
string | No | asc |
Sort direction: asc or desc. |
page |
integer | No | 0 |
Zero-based page number. |
pagesize |
integer | No | 50 |
Rows per page. (1..500; the legacy grid used 50) |
filterby |
string | No | — | Field to search. One of the declared searchable fields. (name, name_dst, prefix - anything else is rejected) |
filter |
string | No | — | Literal substring to search for, case-insensitive. (LIKE metacharacters are escaped, so % and _ match themselves) |
Example
https://host:port/newadm?func=bonosdst:list&order=name&page=0
Response
Success is {"ok":true,"data":{...}}; on refusal {"ok":false,"code":"...","message":"..."}. This function's data shape: {"ok":true,"data":{"rows":[{"id":n,"name":s,"prefix":s,"name_dst":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