Package com.ringcentral.definitions

Class GetMessageInfoResponse

java.lang.Object
com.ringcentral.definitions.GetMessageInfoResponse
public class GetMessageInfoResponse extends Object

  • Field Details

    • id

      public Long id
      Internal identifier of a message Format: int64 Example: 1724099032020

    • uri

      public String uri
      Canonical URI of a message Format: uri

    • extensionId

      public String extensionId
      Internal identifier of an extension

    • attachments

      public MessageAttachmentInfo[] attachments
      List of message attachments

    • 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

    • conversationId

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

    • conversation

      public ConversationInfo conversation

    • creationTime

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

    • deliveryErrorCode

      public String deliveryErrorCode
      SMS only. Delivery error code returned by gateway

    • direction

      public String direction
      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

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

    • faxResolution

      public String faxResolution
      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

      public MessageStoreCallerInfoResponseFrom from

    • lastModifiedTime

      public String lastModifiedTime
      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

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

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

    • priority

      public String priority
      Message priority Enum: Normal, High

    • readStatus

      public String readStatus
      Message read status Enum: Read, Unread

    • smsDeliveryTime

      public String smsDeliveryTime
      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

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

    • subject

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

    • to

      public MessageStoreCallerInfoResponseTo[] to
      Recipient information

    • type

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

    • vmTranscriptionStatus

      public String vmTranscriptionStatus
      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

    • coverIndex

      public Long coverIndex
      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

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

  • Constructor Details

    • GetMessageInfoResponse

      public GetMessageInfoResponse()

  • Method Details