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

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

Properties

string id [get, set]
 Unique identifier of the message batch Example: 12345 More...
 
string from [get, set]
 Phone number in E.164 format from which the messages are going to be sent Example: +15551234567 More...
 
long? batchSize [get, set]
 Total number of messages in the accepted batch Format: int32 Example: 5 More...
 
long? processedCount [get, set]
 Total number of messages currently processed in the batch Format: int32 Example: 1 More...
 
string lastModifiedTime [get, set]
 The last time the batch was processed. Format: date-time More...
 
string status [get, set]
 Current status of a message batch Example: Processing Enum: Processing, Completed More...
 
string creationTime [get, set]
 The time at which the batch was created Format: date-time More...
 
RejectedRecipientResponseResource[] rejected [get, set]
 The list of rejected/invalid recipients More...
 
decimal? cost [get, set]
 The estimated batch cost for completed batch. Calculated after batch processing is completed. Format: double Example: 0.007 More...
 

Detailed Description

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

Property Documentation

◆ batchSize

long? RingCentral.MessageBatchResponse.batchSize
getset

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

◆ cost

decimal? RingCentral.MessageBatchResponse.cost
getset

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

◆ creationTime

string RingCentral.MessageBatchResponse.creationTime
getset

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

◆ from

string RingCentral.MessageBatchResponse.from
getset

Phone number in E.164 format from which the messages are going to be sent Example: +15551234567

◆ id

string RingCentral.MessageBatchResponse.id
getset

Unique identifier of the message batch Example: 12345

◆ lastModifiedTime

string RingCentral.MessageBatchResponse.lastModifiedTime
getset

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

◆ processedCount

long? RingCentral.MessageBatchResponse.processedCount
getset

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

◆ rejected

RejectedRecipientResponseResource [] RingCentral.MessageBatchResponse.rejected
getset

The list of rejected/invalid recipients

◆ status

string RingCentral.MessageBatchResponse.status
getset

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


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