Package com.ringcentral.paths.restapi.account.a2psms.batches

Class Index

java.lang.Object

com.ringcentral.paths.restapi.account.a2psms.batches.Index

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
String	batchId
Index	parent
RestClient	rc

Constructor Summary

Constructors

Constructor	Description
Index(Index parent, String batchId)

Method Summary

Modifier and Type	Method	Description
MessageBatchResponse	get()	Returns information on a message batch.
BatchListResponse	list()
BatchListResponse	list(ListA2PBatchesParameters queryParams)	Returns the list of A2P batches sent from the current account.
String	path()
String	path(Boolean withParameter)
MessageBatchResponse	post(MessageBatchCreateRequest messageBatchCreateRequest)	Allows to send high volume of A2P (Application-to-Person) SMS messages (in message batches).

Methods inherited from class java.lang.Object

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

Field Details

rc

public RestClient rc

parent

public Index parent

batchId

public String batchId

Constructor Details

Index

public Index(Index parent,
 String batchId)

Method Details

path

public String path(Boolean withParameter)

path

public String path()

list

public BatchListResponse list(ListA2PBatchesParameters queryParams)
                       throws RestException,
IOException

Returns the list of A2P batches sent from the current account. The list can be filtered by message batch ID and/or from phone number.

HTTP Method: get Endpoint: /restapi/{apiVersion}/account/{accountId}/a2p-sms/batches Rate Limit Group: Light App Permission: A2PSMS

Throws:

RestException

IOException

list

public BatchListResponse list()
                       throws RestException,
IOException

Throws:

RestException

IOException

post

public MessageBatchResponse post(MessageBatchCreateRequest messageBatchCreateRequest)
                          throws RestException,
IOException

Allows to send high volume of A2P (Application-to-Person) SMS messages (in message batches). Only phone number with the `A2PSmsSender` feature can be used as a sender.

HTTP Method: post Endpoint: /restapi/{apiVersion}/account/{accountId}/a2p-sms/batches Rate Limit Group: Light App Permission: A2PSMS

Throws:

RestException

IOException

get

public MessageBatchResponse get()
                         throws RestException,
IOException

Returns information on a message batch. HTTP Method: get Endpoint: /restapi/{apiVersion}/account/{accountId}/a2p-sms/batches/{batchId} Rate Limit Group: Light App Permission: A2PSMS

Throws:

RestException

IOException