List all voicemail messages

This action will return a list of all voicemail messages received in a specific voicemail box, configured in the given unit.

Try this request in your browser

/api/ /voicemail_messages/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

voicemail_box_id Integer
page Integer
per_page Integer

The request output will be shown here...

URL

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

Access

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

Parameters

Parameter Type Default

voicemail_box_id Required

The ID of the voicemail box

Integer null

page

The page number

Integer 1

per_page

The number of items to return per page

Integer 30

Errors

Error Attributes

VoicemailBoxNotFound

No voicemail box was found given the ID provided

  • voicemail_box_id

    The provided ID

NoAccessToVoicemailBox

Your authenticated identity is not permitted to access this voicemail box

Response Data

This action will return an array of voicemail message structures.

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