telephony/VoicemailMessages

Voicemail message archive.

The entity is placed by the Voicemail script component or the 'voicemail_send' subscriber feature. Transition from 'new' to 'listened', as well as to 'archived', is also performed by the script component or the 'voicemail' subscriber feature.

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

Available to users in the API with filtering by the 'boxNumber' field via Voicemail.

Storage type: history or transactionlog.

Table 1. Class fields
Field Description

id

Archive message identifier

dateTime

Request creation time, in UTC.

status

Request status

  • new - assigned on placement.

  • listened - assigned on listening. Only setting by the script component or 'voicemail' subscriber feature at the end of playback of the corresponding voice message is considered listening.

  • archived - assigned on deletion and clearing of the voicemail box. Only setting by the script component or 'voicemail' subscriber feature when selecting the delete or clear menu items is considered deletion.

  • error - assigned on error loading the recording file, or from the client application or API when setting the only allowed state - 'error'.

statusText

Error text.

nativeId

Text identifier of the source message in the voicemail box.

boxNumber

Voicemail box number matching the SIP subscriber account number.

from

Number of the subscriber who left the message.

listenedDateTime

Time the record was moved from the new messages box to the listened messages box.

archivedDateTime

Time the record was deleted from the listened messages box.

recording

Nested file with the voice message (wav). Available for download.

size

Attachment size in bytes (duplicates attachment meta-information)