RingCentral .Net SDK
Properties | List of all members
RingCentral.InstantMessageEventBody Class Reference

Notification payload body More...

Properties

string id [get, set]
 Internal identifier of a message More...
 
NotificationRecipientInfo[] to [get, set]
 Message receiver(s) information More...
 
SenderInfo from [get, set]
 
string type [get, set]
 Type of message. The default value is 'SMS' More...
 
string creationTime [get, set]
 Message creation date/time in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z Format: date-time More...
 
string lastModifiedTime [get, set]
 Date/time when the message was modified in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z Format: date-time More...
 
string readStatus [get, set]
 Message read status Enum: Read, Unread More...
 
string priority [get, set]
 Message priority Enum: Normal, High More...
 
MessageAttachmentInfo[] attachments [get, set]
 Message attachment data More...
 
string direction [get, set]
 Text message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound Enum: Inbound, Outbound More...
 
string availability [get, set]
 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 More...
 
string subject [get, set]
 Message subject. It replicates message text which is also returned as an attachment More...
 
string messageStatus [get, set]
 Message status. Different message types may have different allowed status values. For outbound faxes the aggregated message status is returned. If, for 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 More...
 
string conversationId [get, set]
 Deprecated. Identifier of a conversation the message belongs to More...
 
ConversationInfo conversation [get, set]
 
string ownerId [get, set]
 Internal identifier of a subscription owner extension More...
 

Detailed Description

Notification payload body

Property Documentation

◆ attachments

MessageAttachmentInfo [] RingCentral.InstantMessageEventBody.attachments
getset

Message attachment data

◆ availability

string RingCentral.InstantMessageEventBody.availability
getset

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

◆ conversation

ConversationInfo RingCentral.InstantMessageEventBody.conversation
getset

◆ conversationId

string RingCentral.InstantMessageEventBody.conversationId
getset

Deprecated. Identifier of a conversation the message belongs to

◆ creationTime

string RingCentral.InstantMessageEventBody.creationTime
getset

Message creation date/time in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z Format: date-time

◆ direction

string RingCentral.InstantMessageEventBody.direction
getset

Text message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound Enum: Inbound, Outbound

◆ from

SenderInfo RingCentral.InstantMessageEventBody.from
getset

◆ id

string RingCentral.InstantMessageEventBody.id
getset

Internal identifier of a message

◆ lastModifiedTime

string RingCentral.InstantMessageEventBody.lastModifiedTime
getset

Date/time when the message was modified in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z Format: date-time

◆ messageStatus

string RingCentral.InstantMessageEventBody.messageStatus
getset

Message status. Different message types may have different allowed status values. For outbound faxes the aggregated message status is returned. If, for 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

◆ ownerId

string RingCentral.InstantMessageEventBody.ownerId
getset

Internal identifier of a subscription owner extension

◆ priority

string RingCentral.InstantMessageEventBody.priority
getset

Message priority Enum: Normal, High

◆ readStatus

string RingCentral.InstantMessageEventBody.readStatus
getset

Message read status Enum: Read, Unread

◆ subject

string RingCentral.InstantMessageEventBody.subject
getset

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

◆ to

NotificationRecipientInfo [] RingCentral.InstantMessageEventBody.to
getset

Message receiver(s) information

◆ type

string RingCentral.InstantMessageEventBody.type
getset

Type of message. The default value is 'SMS'


The documentation for this class was generated from the following file: