Package com.ringcentral.definitions

Class VoicemailMessageEventBody

java.lang.Object

com.ringcentral.definitions.VoicemailMessageEventBody

public class VoicemailMessageEventBody
extends Object

Notification payload body

Field Summary

Fields

Modifier and Type	Field	Description
MessageAttachmentInfo[]	attachments	Message attachment data
String	availability	Message availability status.
String	creationTime	Message creation date/time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2019-03-10T18:07:52.534Z* Format: date-time
String	direction	Message direction (inbound or outbound) Enum: Inbound, Outbound
SenderInfo	from
Long	id	Internal identifier of a message Format: int64
String	lastModifiedTime	Date/time when a message was modified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2019-03-10T18:07:52.534Z* Format: date-time
String	messageStatus	Message status.
String	priority	Message priority Enum: Normal, High
String	readStatus	Message read status Enum: Read, Unread
String	subject	Message subject.
NotificationRecipientInfo[]	to	Message receiver(s) information
String	type	Type of message Enum: Voicemail
String	vmTranscriptionStatus	Status of a voicemail to text transcription.

Constructor Summary

Constructors

Constructor	Description
VoicemailMessageEventBody()

Method Summary

Modifier and Type	Method	Description
VoicemailMessageEventBody	attachments(MessageAttachmentInfo[] attachments)
VoicemailMessageEventBody	availability(String availability)
VoicemailMessageEventBody	creationTime(String creationTime)
VoicemailMessageEventBody	direction(String direction)
VoicemailMessageEventBody	from(SenderInfo from)
VoicemailMessageEventBody	id(Long id)
VoicemailMessageEventBody	lastModifiedTime(String lastModifiedTime)
VoicemailMessageEventBody	messageStatus(String messageStatus)
VoicemailMessageEventBody	priority(String priority)
VoicemailMessageEventBody	readStatus(String readStatus)
VoicemailMessageEventBody	subject(String subject)
VoicemailMessageEventBody	to(NotificationRecipientInfo[] to)
VoicemailMessageEventBody	type(String type)
VoicemailMessageEventBody	vmTranscriptionStatus(String vmTranscriptionStatus)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

id

public Long id

Internal identifier of a message Format: int64

to

public NotificationRecipientInfo[] to

Message receiver(s) information

from

public SenderInfo from

type

public String type

Type of message Enum: Voicemail

creationTime

public String creationTime

Message creation date/time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2019-03-10T18:07:52.534Z* Format: date-time

lastModifiedTime

public String lastModifiedTime

Date/time when a message was modified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2019-03-10T18:07:52.534Z* Format: date-time

readStatus

public String readStatus

Message read status Enum: Read, Unread

priority

public String priority

Message priority Enum: Normal, High

attachments

public MessageAttachmentInfo[] attachments

Message attachment data

direction

public String direction

Message direction (inbound or outbound) Enum: Inbound, Outbound

availability

public String availability

Message availability status. Message in `Deleted` state is still preserved with all its attachments and can be restored. `Purged` means that all attachments are already deleted and the message itself is about to be physically deleted shortly Enum: Alive, Deleted, Purged

subject

public String subject

Message subject. It replicates message text which is also returned as an attachment

messageStatus

public String messageStatus

Message status. Different message types may have different allowed status values. For outbound faxes the aggregated message status is returned. If, for multi-recipient outbound message, a status for at least one recipient is `Queued`, then the `Queued` value is returned. If a status for at least one recipient is `SendingFailed`, then the 'SendingFailed' value is returned. In other cases, the `Sent` status is returned Enum: Queued, Sent, Delivered, DeliveryFailed, SendingFailed, Received

vmTranscriptionStatus

public String vmTranscriptionStatus

Status of a voicemail to text transcription. Specifies if a voicemail message transcription is already completed or not If 'VoicemailToText' feature is not activated for account, the 'NotAvailable' value is returned Enum: NotAvailable, InProgress, TimedOut, Completed, CompletedPartially, Failed, Unknown

Constructor Details

VoicemailMessageEventBody

public VoicemailMessageEventBody()

Method Details

id

public VoicemailMessageEventBody id(Long id)

to

public VoicemailMessageEventBody to(NotificationRecipientInfo[] to)

from

public VoicemailMessageEventBody from(SenderInfo from)

type

public VoicemailMessageEventBody type(String type)

creationTime

public VoicemailMessageEventBody creationTime(String creationTime)

lastModifiedTime

public VoicemailMessageEventBody lastModifiedTime(String lastModifiedTime)

readStatus

public VoicemailMessageEventBody readStatus(String readStatus)

priority

public VoicemailMessageEventBody priority(String priority)

attachments

public VoicemailMessageEventBody attachments(MessageAttachmentInfo[] attachments)

direction

public VoicemailMessageEventBody direction(String direction)

availability

public VoicemailMessageEventBody availability(String availability)

subject

public VoicemailMessageEventBody subject(String subject)

messageStatus

public VoicemailMessageEventBody messageStatus(String messageStatus)

vmTranscriptionStatus

public VoicemailMessageEventBody vmTranscriptionStatus(String vmTranscriptionStatus)