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

Properties

long? id [get, set]
 Internal identifier of a message Format: int64 More...
 
string uri [get, set]
 Canonical URI of a message Format: uri More...
 
string type [get, set]
 Message type - 'Fax' Enum: Fax More...
 
MessageStoreCallerInfoResponseFrom from [get, set]
 
FaxResponseTo[] to [get, set]
 Recipient information 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 readStatus [get, set]
 Message read status Enum: Read, Unread More...
 
string priority [get, set]
 Message priority Enum: Normal, High More...
 
MessageAttachmentInfoIntId[] attachments [get, set]
 List of message attachments 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 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 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...
 
long? faxPageCount [get, set]
 Page count in a fax message Format: int32 More...
 
string lastModifiedTime [get, set]
 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...
 
long? coverIndex [get, set]
 Cover page identifier. If coverIndex is set to '0' (zero), a cover page is not attached. For a 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 a fax sender and printed on a cover page. Maximum length is limited to 1024 symbols More...
 

Property Documentation

◆ attachments

MessageAttachmentInfoIntId [] RingCentral.FaxResponse.attachments
getset

List of message attachments

◆ availability

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

◆ coverIndex

long? RingCentral.FaxResponse.coverIndex
getset

Cover page identifier. If coverIndex is set to '0' (zero), a cover page is not attached. For a 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.FaxResponse.coverPageText
getset

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

◆ creationTime

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

◆ faxPageCount

long? RingCentral.FaxResponse.faxPageCount
getset

Page count in a fax message Format: int32

◆ faxResolution

string RingCentral.FaxResponse.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.FaxResponse.from
getset

◆ id

long? RingCentral.FaxResponse.id
getset

Internal identifier of a message Format: int64

◆ lastModifiedTime

string RingCentral.FaxResponse.lastModifiedTime
getset

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.FaxResponse.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

◆ priority

string RingCentral.FaxResponse.priority
getset

Message priority Enum: Normal, High

◆ readStatus

string RingCentral.FaxResponse.readStatus
getset

Message read status Enum: Read, Unread

◆ to

FaxResponseTo [] RingCentral.FaxResponse.to
getset

Recipient information

◆ type

string RingCentral.FaxResponse.type
getset

Message type - 'Fax' Enum: Fax

◆ uri

string RingCentral.FaxResponse.uri
getset

Canonical URI of a message Format: uri


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