Package com.ringcentral.definitions

Class GetSMSMessageInfoResponse

java.lang.Object

com.ringcentral.definitions.GetSMSMessageInfoResponse

public class GetSMSMessageInfoResponse
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
MessageAttachmentInfo[]	attachments	List of message attachments
String	availability	Message availability status.
ConversationInfo	conversation
Long	conversationId	SMS and Pager only.
String	creationTime	Message creation date/time in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z Format: date-time
String	deliveryErrorCode	SMS only.
String	direction	Text message direction.
MessageStoreCallerInfoResponseFrom	from
Long	id	Internal identifier of a message Format: int64
String	lastModifiedTime	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	Message status.
String	priority	Message priority Enum: Normal, High
String	readStatus	Message read status Enum: Read, Unread
String	smsDeliveryTime	SMS only.
Long	smsSendingAttemptsCount	SMS only.
String	subject	Message subject.
MessageStoreCallerInfoResponseTo[]	to	Recipient information
String	type	Message type Enum: Fax, SMS, VoiceMail, Pager, Text
String	uri	Canonical URI of a message Format: uri

Constructor Summary

Constructors

Constructor	Description
GetSMSMessageInfoResponse()

Method Summary

Modifier and Type	Method	Description
GetSMSMessageInfoResponse	attachments(MessageAttachmentInfo[] attachments)
GetSMSMessageInfoResponse	availability(String availability)
GetSMSMessageInfoResponse	conversation(ConversationInfo conversation)
GetSMSMessageInfoResponse	conversationId(Long conversationId)
GetSMSMessageInfoResponse	creationTime(String creationTime)
GetSMSMessageInfoResponse	deliveryErrorCode(String deliveryErrorCode)
GetSMSMessageInfoResponse	direction(String direction)
GetSMSMessageInfoResponse	from(MessageStoreCallerInfoResponseFrom from)
GetSMSMessageInfoResponse	id(Long id)
GetSMSMessageInfoResponse	lastModifiedTime(String lastModifiedTime)
GetSMSMessageInfoResponse	messageStatus(String messageStatus)
GetSMSMessageInfoResponse	priority(String priority)
GetSMSMessageInfoResponse	readStatus(String readStatus)
GetSMSMessageInfoResponse	smsDeliveryTime(String smsDeliveryTime)
GetSMSMessageInfoResponse	smsSendingAttemptsCount(Long smsSendingAttemptsCount)
GetSMSMessageInfoResponse	subject(String subject)
GetSMSMessageInfoResponse	to(MessageStoreCallerInfoResponseTo[] to)
GetSMSMessageInfoResponse	type(String type)
GetSMSMessageInfoResponse	uri(String uri)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

id

public Long id

Internal identifier of a message Format: int64

uri

public String uri

Canonical URI of a message Format: uri

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

from

public MessageStoreCallerInfoResponseFrom from

lastModifiedTime

public String lastModifiedTime

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

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. The 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 the 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

Constructor Details

GetSMSMessageInfoResponse

public GetSMSMessageInfoResponse()

Method Details

id

public GetSMSMessageInfoResponse id(Long id)

uri

public GetSMSMessageInfoResponse uri(String uri)

attachments

public GetSMSMessageInfoResponse attachments(MessageAttachmentInfo[] attachments)

availability

public GetSMSMessageInfoResponse availability(String availability)

conversationId

public GetSMSMessageInfoResponse conversationId(Long conversationId)

conversation

public GetSMSMessageInfoResponse conversation(ConversationInfo conversation)

creationTime

public GetSMSMessageInfoResponse creationTime(String creationTime)

deliveryErrorCode

public GetSMSMessageInfoResponse deliveryErrorCode(String deliveryErrorCode)

direction

public GetSMSMessageInfoResponse direction(String direction)

from

public GetSMSMessageInfoResponse from(MessageStoreCallerInfoResponseFrom from)

lastModifiedTime

public GetSMSMessageInfoResponse lastModifiedTime(String lastModifiedTime)

messageStatus

public GetSMSMessageInfoResponse messageStatus(String messageStatus)

priority

public GetSMSMessageInfoResponse priority(String priority)

readStatus

public GetSMSMessageInfoResponse readStatus(String readStatus)

smsDeliveryTime

public GetSMSMessageInfoResponse smsDeliveryTime(String smsDeliveryTime)

smsSendingAttemptsCount

public GetSMSMessageInfoResponse smsSendingAttemptsCount(Long smsSendingAttemptsCount)

subject

public GetSMSMessageInfoResponse subject(String subject)

to

public GetSMSMessageInfoResponse to(MessageStoreCallerInfoResponseTo[] to)

type

public GetSMSMessageInfoResponse type(String type)