Untitled :: Documentation

telephony/VoicemailMessages

Voice mail message archive.

The entity is hosted by a script component Voicemail or subscriber function 'voicemail_send'. The conversion from 'new' to 'listened' as well as to 'archived' is also performed by a script component or a subscriber function 'voicemail'.

Further managed by the user application, product microservices or external systems via the API.

Available to users in the API with a filter on the 'boxNumber' field via Voice mail.

Storage Type: history.

Table 1. Class fields
Field	Description
`id`	Archive message identifier
`dateTime`	Time of order creation, in UTC.
`status`	Order status `new` - is assigned at the time of placement. `listened` - is assigned when listening. Only when a script component or subscriber function sets 'voicemail' at the end of playback of the corresponding voice message is considered listening. `archived` - is assigned when deleting and clearing a voice mailbox. Only when a script component or subscriber function sets 'voicemail' when selecting the delete or clear menu items is considered as deletion. `error` - is assigned when a record file upload error occurs, or from a client application or API when the only allowed state is set - 'error'.
`statusText`	Error text.
`nativeId`	The text identifier of the original message in the voice mailbox.
`boxNumber`	A voice mailbox number that matches the SIP subscriber’s SIP account number.
`from`	The number of the subscriber who left the message.
`listenedDateTime`	Time to move a recording from the new messages box to the listened messages box.
`archivedDateTime`	Time to delete a recording from the listened message box.
`recording`	Attached file with voice message (wav). Available for download.
`size`	Attachment size in bytes (duplicates meta-information about the attachment)