registered
The following APIs are available on Brekeke SIP Server 3.16.0 or later.
registered/list
Description:
List registered data
registered
Parameters:
condition – an object including the following two fields.
field – one of the following string
“urlalias”, “urloriginal”, “namealias”, “nameoriginal”, “acceptpattern”, “requester”,”expires”, “timeupdate”, “expirestime”, “priority”, “mappedport”, “awake”, “useragent”, “param”
text – A search text.
limit – the maximum number of search results to be returned.
offset – the starting position of the search.
Retruns:
data – an array of registered entry
total – a total number of the entries that match the given conditions
offset – a starting position of the data
Example of sending request:
registered/listAllIpAddresses
Description:
List of remote IP addresses of registered devices will be returned.
registered
Parameters:
Retruns:
data – an array of remote IP addresses of registered devices.
Example of sending request:
registered/register
Description:
Register an entry
registered
Parameters:
urlalias – user info to register
urloriginal – SIP URI for the contact
expires – time (milliseconds) to expire (optional)
priority – priority number (optional)
Example of sending request:
register/unregister
Description:
Unregister an entry
registered
Parameters:
urlalias – user info to register
urloriginal – SIP URI for the contact
