List all voicemail boxes

This action will returns a full list of all voicemail boxes configured in the given unit.

Try this request in your browser

/api/ /voicemail_boxes/list

Headers

X-Auth-App
X-Auth-Token
X-Auth-Secret
X-Auth-Extension
X-Auth-Password
X-Proxy-Auth-Token
X-Proxy-Auth-Secret

Parameters

unit_id Integer
page Integer
per_page Integer
sort_by String
order String

The request output will be shown here...

URL

https://connectapi.dial9.co.uk/api/v2/voicemail_boxes/list

Access

Must be authenticated as a user or API token. If not authorised, a AccessDenied error will be returned.

Parameters

Parameter Type Default

unit_id

The ID of the unit

Integer null

page

The page number

Integer 1

per_page

The number of items to return per page

Integer 30

sort_by

The field to sort by

String number

order

The direction to order units by

String asc

Errors

Error Attributes

UnitNotFound

The given unit was not found

  • id

    The provided ID

Response Data

This action will return an array of voicemail box structures.

You'll receive just the basic attributes for this structure. No expansions are provided.