OperatorAPI voicemail:list

newadmapi (Operator API) function. Available to: Operator.

Description

Customer voicemail boxes. OPERATOR AUDIENCE ONLY (super withheld pending console's ruling). The mailbox PIN is credential-class and published nowhere; INSERT is OFF because the column DEFAULTS to 0000, so a creation that omitted it would silently make a mailbox with a known PIN. 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=voicemail: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

None beyond the API key and func=voicemail:list.

Example

https://host:port/newadm?func=voicemail:list

Response

Success is {"ok":true,"data":{...}}; on refusal {"ok":false,"code":"...","message":"..."}. This function's data shape: {"ok":true,"data":{"rows":[{"context":s,"mailbox":s,"email":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