Package com.ringcentral.definitions

Class MessageBatchResponse

java.lang.Object

com.ringcentral.definitions.MessageBatchResponse

public class MessageBatchResponse
extends Object

Batch of A2P SMS messages. This object provides a specification to send message(s) to many recipients. It contains top-level attributes which apply to all messages. In addition to that, it is possible to override this attribute for each message. This way a single API call may be used to send individual messages to many recipients

Field Summary

Fields

Modifier and Type	Field	Description
Long	batchSize	Total number of messages in the accepted batch Format: int32 Example: 5
Double	cost	The estimated batch cost for completed batch.
String	creationTime	The time at which the batch was created Format: date-time
String	from	Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format from which the messages are going to be sent Example: +15551234567
String	id	Unique identifier of the message batch Example: 12345
String	lastModifiedTime	The last time the batch was processed.
Long	processedCount	Total number of messages currently processed in the batch Format: int32 Example: 1
RejectedRecipientResponseResource[]	rejected	The list of rejected/invalid recipients
String	status	Current status of a message batch Example: Processing Enum: Processing, Completed

Constructor Summary

Constructors

Constructor	Description
MessageBatchResponse()

Method Summary

Modifier and Type	Method	Description
MessageBatchResponse	batchSize(Long batchSize)
MessageBatchResponse	cost(Double cost)
MessageBatchResponse	creationTime(String creationTime)
MessageBatchResponse	from(String from)
MessageBatchResponse	id(String id)
MessageBatchResponse	lastModifiedTime(String lastModifiedTime)
MessageBatchResponse	processedCount(Long processedCount)
MessageBatchResponse	rejected(RejectedRecipientResponseResource[] rejected)
MessageBatchResponse	status(String status)

Methods inherited from class java.lang.Object

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

Field Details

id

public String id

Unique identifier of the message batch Example: 12345

from

public String from

Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format from which the messages are going to be sent Example: +15551234567

batchSize

public Long batchSize

Total number of messages in the accepted batch Format: int32 Example: 5

processedCount

public Long processedCount

Total number of messages currently processed in the batch Format: int32 Example: 1

lastModifiedTime

public String lastModifiedTime

The last time the batch was processed. Format: date-time

status

public String status

Current status of a message batch Example: Processing Enum: Processing, Completed

creationTime

public String creationTime

The time at which the batch was created Format: date-time

rejected

public RejectedRecipientResponseResource[] rejected

The list of rejected/invalid recipients

cost

public Double cost

The estimated batch cost for completed batch. Calculated after batch processing is completed. Format: double Example: 0.007

Constructor Details

MessageBatchResponse

public MessageBatchResponse()

Method Details

id

public MessageBatchResponse id(String id)

from

public MessageBatchResponse from(String from)

batchSize

public MessageBatchResponse batchSize(Long batchSize)

processedCount

public MessageBatchResponse processedCount(Long processedCount)

lastModifiedTime

public MessageBatchResponse lastModifiedTime(String lastModifiedTime)

status

public MessageBatchResponse status(String status)

creationTime

public MessageBatchResponse creationTime(String creationTime)

rejected

public MessageBatchResponse rejected(RejectedRecipientResponseResource[] rejected)

cost

public MessageBatchResponse cost(Double cost)