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

Properties

long? id [get, set]
 Internal identifier of a message Format: int64 Example: 1724099032020 More...
 
string uri [get, set]
 Canonical URI of a message Format: uri More...
 
string extensionId [get, set]
 Internal identifier of an extension More...
 
MessageAttachmentInfo[] attachments [get, set]
 List of message attachments 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...
 
long? conversationId [get, set]
 SMS and Pager only. Identifier of a conversation the message belongs to Format: int64 More...
 
ConversationInfo conversation [get, set]
 
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 deliveryErrorCode [get, set]
 SMS only. Delivery error code returned by gateway 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...
 
long? faxPageCount [get, set]
 Fax only. Page count in a fax message Format: int32 More...
 
string faxResolution [get, set]
 Fax only. Resolution of a fax message. 'High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi Enum: High, Low More...
 
MessageStoreCallerInfoResponseFrom from [get, set]
 
string lastModifiedTime [get, set]
 The date/time when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z Format: date-time 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...
 
bool? pgToDepartment [get, set]
 Pager only. true if at least one of the message recipients is 'Department' extension More...
 
string priority [get, set]
 Message priority Enum: Normal, High More...
 
string readStatus [get, set]
 Message read status Enum: Read, Unread More...
 
string smsDeliveryTime [get, set]
 SMS only. Date/time when outbound SMS was delivered to recipient's handset in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. It is filled only if a carrier sends a delivery receipt to RingCentral Format: date-time More...
 
long? smsSendingAttemptsCount [get, set]
 SMS only. Number of attempts made to send an outbound SMS to the Gateway (if Gateway is temporary unavailable) Format: int32 More...
 
string subject [get, set]
 Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment More...
 
MessageStoreCallerInfoResponseTo[] to [get, set]
 Recipient information More...
 
string type [get, set]
 Message type Enum: Fax, SMS, VoiceMail, Pager, Text More...
 
string vmTranscriptionStatus [get, set]
 Voicemail only. Status of a voicemail to text transcription. If 'VoicemailToText' feature is not activated for account, the 'NotAvailable' value is returned Enum: NotAvailable, InProgress, TimedOut, Completed, CompletedPartially, Failed, Unknown More...
 
long? coverIndex [get, set]
 Cover page identifier. If coverIndex is set to '0' (zero) cover page is not attached. For the list of available cover page identifiers (1-13) please call the Fax Cover Pages method. If not specified, the default cover page is attached (which is configured in 'Outbound Fax Settings') Format: int32 More...
 
string coverPageText [get, set]
 Cover page text, entered by the fax sender and printed on the cover page. Maximum length is limited to 1024 symbols More...
 

Property Documentation

◆ attachments

MessageAttachmentInfo [] RingCentral.GetMessageInfoResponse.attachments
getset

List of message attachments

◆ availability

string RingCentral.GetMessageInfoResponse.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.GetMessageInfoResponse.conversation
getset

◆ conversationId

long? RingCentral.GetMessageInfoResponse.conversationId
getset

SMS and Pager only. Identifier of a conversation the message belongs to Format: int64

◆ coverIndex

long? RingCentral.GetMessageInfoResponse.coverIndex
getset

Cover page identifier. If coverIndex is set to '0' (zero) cover page is not attached. For the list of available cover page identifiers (1-13) please call the Fax Cover Pages method. If not specified, the default cover page is attached (which is configured in 'Outbound Fax Settings') Format: int32

◆ coverPageText

string RingCentral.GetMessageInfoResponse.coverPageText
getset

Cover page text, entered by the fax sender and printed on the cover page. Maximum length is limited to 1024 symbols

◆ creationTime

string RingCentral.GetMessageInfoResponse.creationTime
getset

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

◆ deliveryErrorCode

string RingCentral.GetMessageInfoResponse.deliveryErrorCode
getset

SMS only. Delivery error code returned by gateway

◆ direction

string RingCentral.GetMessageInfoResponse.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

◆ extensionId

string RingCentral.GetMessageInfoResponse.extensionId
getset

Internal identifier of an extension

◆ faxPageCount

long? RingCentral.GetMessageInfoResponse.faxPageCount
getset

Fax only. Page count in a fax message Format: int32

◆ faxResolution

string RingCentral.GetMessageInfoResponse.faxResolution
getset

Fax only. Resolution of a fax message. 'High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi Enum: High, Low

◆ from

MessageStoreCallerInfoResponseFrom RingCentral.GetMessageInfoResponse.from
getset

◆ id

long? RingCentral.GetMessageInfoResponse.id
getset

Internal identifier of a message Format: int64 Example: 1724099032020

◆ lastModifiedTime

string RingCentral.GetMessageInfoResponse.lastModifiedTime
getset

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

◆ messageStatus

string RingCentral.GetMessageInfoResponse.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

◆ pgToDepartment

bool? RingCentral.GetMessageInfoResponse.pgToDepartment
getset

Pager only. true if at least one of the message recipients is 'Department' extension

◆ priority

string RingCentral.GetMessageInfoResponse.priority
getset

Message priority Enum: Normal, High

◆ readStatus

string RingCentral.GetMessageInfoResponse.readStatus
getset

Message read status Enum: Read, Unread

◆ smsDeliveryTime

string RingCentral.GetMessageInfoResponse.smsDeliveryTime
getset

SMS only. Date/time when outbound SMS was delivered to recipient's handset in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. It is filled only if a carrier sends a delivery receipt to RingCentral Format: date-time

◆ smsSendingAttemptsCount

long? RingCentral.GetMessageInfoResponse.smsSendingAttemptsCount
getset

SMS only. Number of attempts made to send an outbound SMS to the Gateway (if Gateway is temporary unavailable) Format: int32

◆ subject

string RingCentral.GetMessageInfoResponse.subject
getset

Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment

◆ to

MessageStoreCallerInfoResponseTo [] RingCentral.GetMessageInfoResponse.to
getset

Recipient information

◆ type

string RingCentral.GetMessageInfoResponse.type
getset

Message type Enum: Fax, SMS, VoiceMail, Pager, Text

◆ uri

string RingCentral.GetMessageInfoResponse.uri
getset

Canonical URI of a message Format: uri

◆ vmTranscriptionStatus

string RingCentral.GetMessageInfoResponse.vmTranscriptionStatus
getset

Voicemail only. Status of a voicemail to text transcription. If 'VoicemailToText' feature is not activated for account, the 'NotAvailable' value is returned Enum: NotAvailable, InProgress, TimedOut, Completed, CompletedPartially, Failed, Unknown


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