|
|
long? | id [get, set] |
| | Internal identifier of a message Format: int64 Example: 1724099032020.
|
|
string | uri [get, set] |
| | Canonical URI of a message Format: uri.
|
|
string | extensionId [get, set] |
| | Internal identifier of an extension.
|
|
MessageAttachmentInfo[] | attachments [get, set] |
| | List of message attachments.
|
|
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.
|
|
long? | conversationId [get, set] |
| | SMS and Pager only. Identifier of a conversation the message belongs to Format: int64.
|
|
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.
|
|
string | deliveryErrorCode [get, set] |
| | SMS only. Delivery error code returned by gateway.
|
|
long? | segmentCount [get, set] |
| | SMS size in segments Format: int32.
|
|
string | direction [get, set] |
| | Message direction (inbound or outbound) Enum: Inbound, Outbound.
|
|
long? | faxPageCount [get, set] |
| | Fax only. Page count in a fax message Format: int32.
|
|
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.
|
|
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.
|
|
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 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.
|
|
bool? | pgToDepartment [get, set] |
| | Pager only. true if at least one of the message recipients is 'Department' extension.
|
|
string | priority [get, set] |
| | Message priority Enum: Normal, High.
|
|
string | readStatus [get, set] |
| | Message read status Enum: Read, Unread.
|
|
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.
|
|
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.
|
|
string | subject [get, set] |
| | Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment.
|
|
MessageStoreCallerInfoResponseTo[] | to [get, set] |
| | Recipient information.
|
|
string | type [get, set] |
| | Message type Enum: Fax, SMS, VoiceMail, Pager, Text.
|
|
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.
|
|
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.
|
|
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.
|
|
OwnerResource | owner [get, set] |
|
GetMessageForwardingInfo | forwarding [get, set] |
|
MessageStoreCallerInfoResponseTo[] | vmSideRecipients [get, set] |
| | List of other users (side recipients) who also received the voicemail in case of VM sending to multiple users or VM forwarding to multiple users. Required.
|
1.15.0