Get voicemail message details

This action will return information about a specific voicemail message in the given voicemail box.

Try this request in your browser

/api/ /voicemail_messages/info

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

id String

Structures

Include extended attributes?
Include expansions? 

The request output will be shown here...

URL

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

Access

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

Parameters

Parameter Type Default

id Required

The ID of the voicemail message

 String null

Errors

Error Attributes

VoicemailMessageNotFound

No voicemail message was found given the ID provided

  • id

    The provided ID

NoAccessToVoicemailMessage

Your authenticated identity is not permitted to access this voicemail message

Response Data

This action will return a voicemail message structure.

You'll receive all extended data with this structure, by default. You can change this behaviour by passing true or false in the _full parameter on the request. By default, you'll receive no expansions for the structure. You can add them by providing an array of new expansion names in the _expansions parameter on the request. You can send true rather than array to receive all expansions.