com.baidubce.services.sms

Class SmsClient

java.lang.Object

com.baidubce.AbstractBceClient

com.baidubce.services.sms.SmsClientSupport

com.baidubce.services.sms.SmsClient

public class SmsClient
extends SmsClientSupport

The entrance class for all client access to the API of SMS(Baidu message Service).

All of the API method of SMS is included in this class.

Field Summary

Fields inherited from class com.baidubce.services.sms.SmsClientSupport

SMS_HANDLERS

Fields inherited from class com.baidubce.AbstractBceClient

config, DEFAULT_CONTENT_TYPE, DEFAULT_ENCODING, DEFAULT_SERVICE_DOMAIN, URL_PREFIX

Constructor Summary

Constructors

Constructor and Description
SmsClient() Constructs a new SmsClient instance with default settings.
SmsClient(SmsClientConfiguration config) Constructs a new SmsClient instance with the specified configuration.

Method Summary

Modifier and Type	Method and Description
void	createMobileBlack(CreateBlackRequest request) create mobile black
CreateSignatureResponse	createSignature(CreateSignatureRequest request) Create the signature
CreateTemplateResponse	createTemplate(CreateTemplateRequest request) Create message template
CreateTemplateResponse	createTemplate(CreateTemplateRequest request) Create the template
void	deleteMobileBlack(String phones) delete mobile black
void	deleteSignature(DeleteSignatureRequest request) Delete the signature
void	deleteTemplate(DeleteTemplateRequest request) Delete message template
void	deleteTemplate(DeleteTemplateRequest request) Delete the template
GetSignatureResponse	getSignature(GetSignatureRequest request) Get signature detail info
GetTemplateResponse	getTemplate(GetTemplateRequest request) Get template detail info
GetTemplateDetailResponse	getTemplateDetail(GetTemplateDetailRequest request) Deprecated. This method is deprecated and will be removed from sdk in the future when SMS3.0 is officially released, we suggest you to use this.getTemplate(com.baidubce.services.sms.model.v3.GetTemplateRequest) instead.
ListBlackResponse	listMobileBlack(ListBlackRequest request) get the list of mobile black
ListSignatureResponse	listSignature(ListSignatureRequest request) Get the list of the signatures
ListStatisticsResponse	listStatistics(ListStatisticsRequest request) Query statistics data as a list format
ListTemplateResponse	listTemplate(ListTemplateRequest request) Get the list of the templates
ListTemplateResponse	listTemplate(SmsRequest request) Deprecated. This method is deprecated and will be removed from sdk in the future when SMS3.0 is officially released, we suggest you to use this.listTemplate(ListTemplateRequest request) instead.
void	modifySignature(ModifySignatureRequest request) Modify the signature when audit failure
void	modifyTemplate(ModifyTemplateRequest request) Modify the template when audit failure
QueryMessageDetailResponse	queryMessageDetail(QueryMessageDetailRequest request) Query message detail
QueryQuotaResponse	queryQuota(SmsRequest request) Deprecated. This method is deprecated and will be removed from sdk in the future when SMS3.0 is officially released, we suggest you to use this.queryQuotaRate() instead.
QueryQuotaRateResponse	queryQuotaRate() Query quota and rate-limit detail
SendMessageResponse	sendMessage(SendMessageRequest request) Deprecated. This method is deprecated and will be removed from sdk in the future when SMS3.0 is officially released, we suggest you to use sendMessage(SendMessageV3Request) instead.
SendMessageV2Response	sendMessage(SendMessageV2Request request) Deprecated. This method is deprecated and will be removed from sdk in the future when SMS3.0 is officially released, we suggest you to use sendMessage(SendMessageV3Request) instead.
SendMessageV3Response	sendMessage(SendMessageV3Request request) Send message
StatReceiverResponse	statReceiver(StatReceiverRequest request) Get the statistics about receiving message
void	updateQuotaRate(UpdateQuotaRateRequest request) Update quota and rate-limit

Methods inherited from class com.baidubce.services.sms.SmsClientSupport

assertListNotNullOrEmpty, assertMapNotNullOrEmpty, assertStringArrayNotNullOrEmpty, assertStringNotNullOrEmpty, createGeneralRequest, createRequest, fillRequestPayload

Methods inherited from class com.baidubce.AbstractBceClient

computeBktVirEndpoint, computeServiceId, getBktVirEndpoint, getClient, getEndpoint, getServiceId, invokeHttpClient, isRegionSupported, setClient, shutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

SmsClient

public SmsClient()

Constructs a new SmsClient instance with default settings.

SmsClient

public SmsClient(SmsClientConfiguration config)

Constructs a new SmsClient instance with the specified configuration.

Parameters:

config - the specified configuration, default inherit super class com.baidubce.BceClientConfiguration

See Also:

SmsClientConfiguration

Method Detail

sendMessage

@Deprecated
public SendMessageResponse sendMessage(SendMessageRequest request)

Deprecated. This method is deprecated and will be removed from sdk in the future when SMS3.0 is officially released, we suggest you to use sendMessage(SendMessageV3Request) instead.

Send message

To send message, you have to specify a template which is built by system, or created by yourself which is audited by BCE administrator.

One or more receiver can be specified while sending message.

Parameters:

request - The request object which includes the content to send and one or more receiver

Returns:

The response object which includes the id of message and the statistics of sending result

See Also:

SendMessageRequest, SendMessageResponse

sendMessage

@Deprecated
public SendMessageV2Response sendMessage(SendMessageV2Request request)

Deprecated. This method is deprecated and will be removed from sdk in the future when SMS3.0 is officially released, we suggest you to use sendMessage(SendMessageV3Request) instead.

Send message with parameter SendMessageV2Request

sendMessage

public SendMessageV3Response sendMessage(SendMessageV3Request request)

Send message

The interface of sending message by SMS3.0. To send message, you have to specify a template and a signature which are created by yourself.

Parameters:

request - refer to com.baidubce.services.sms.model.SendMessageV3Request

Returns:

refer to com.baidubce.services.sms.model.SendMessageV3Response

queryMessageDetail

public QueryMessageDetailResponse queryMessageDetail(QueryMessageDetailRequest request)

Query message detail

Parameters:

request - The request object which includes the id of message to query

Returns:

The response object which includes all the detail result, for example id, content, receiver, sendTime etc

See Also:

QueryMessageDetailRequest, QueryMessageDetailResponse

createTemplate

public CreateTemplateResponse createTemplate(CreateTemplateRequest request)

Create message template

The template which is created will have a unique id. after audited by BCE administrator, it can be used normally.

Parameters:

request - The request object which includes the name and content of template which is ready to be created

Returns:

The response object which includes the id of template which is created

See Also:

CreateTemplateRequest, CreateTemplateResponse

createTemplate

public CreateTemplateResponse createTemplate(CreateTemplateRequest request)

Create the template

Parameters:

request - refer to com.baidubce.services.sms.model.v3.CreateTemplateRequest

Returns:

The response object which indicates the detail of newly created template, refer to com.baidubce.services.sms.model.v3.CreateTemplateResponse

deleteTemplate

public void deleteTemplate(DeleteTemplateRequest request)

Delete message template

Parameters:

request - The request object which includes the id of template which is ready to be deleted

See Also:

DeleteTemplateRequest

deleteTemplate

public void deleteTemplate(DeleteTemplateRequest request)

Delete the template

Parameters:

request - refer to com.baidubce.services.sms.model.v3.DeleteTemplateRequest

getTemplateDetail

@Deprecated
public GetTemplateDetailResponse getTemplateDetail(GetTemplateDetailRequest request)

Deprecated. This method is deprecated and will be removed from sdk in the future when SMS3.0 is officially released, we suggest you to use this.getTemplate(com.baidubce.services.sms.model.v3.GetTemplateRequest) instead.

Get the detail of message template

Parameters:

request - The request object which includes the id of template which is ready to be get

Returns:

The response object which includes all of the detail of message template, refer to com.baidubce.services.sms.model.GetTemplateDetailResponse

See Also:

GetTemplateDetailRequest, GetTemplateDetailResponse

listTemplate

public ListTemplateResponse listTemplate(SmsRequest request)

Deprecated. This method is deprecated and will be removed from sdk in the future when SMS3.0 is officially released, we suggest you to use this.listTemplate(ListTemplateRequest request) instead.

Get the list of message template

Parameters:

request - The request object which is empty

Returns:

The response object which includes all of the detail of message template,refer to com.baidubce.services.sms.model.ListTemplateResponse

See Also:

ListTemplateResponse

listTemplate

public ListTemplateResponse listTemplate(ListTemplateRequest request)

Get the list of the templates

Parameters:

request - refer to com.baidubce.services.sms.model.v3.ListTemplateRequest

Returns:

The response object indicates the list of the template, refer to com.baidubce.services.sms.model.v3.ListTemplateResponse

queryQuota

public QueryQuotaResponse queryQuota(SmsRequest request)

Deprecated. This method is deprecated and will be removed from sdk in the future when SMS3.0 is officially released, we suggest you to use this.queryQuotaRate() instead.

Query the sending quota

Parameters:

request - The request object which is empty

Returns:

The response object which includes the detail of sending quota, refer to com.baidubce.services.sms.model.QueryQuotaResponse

See Also:

QueryQuotaResponse

statReceiver

public StatReceiverResponse statReceiver(StatReceiverRequest request)

Get the statistics about receiving message

Parameters:

request - refer to com.baidubce.services.sms.model.StatReceiverRequest

Returns:

refer to com.baidubce.services.sms.model.StatReceiverResponse

See Also:

StatReceiverRequest, StatReceiverResponse

createSignature

public CreateSignatureResponse createSignature(CreateSignatureRequest request)

Create the signature

Parameters:

request - refer to com.baidubce.services.sms.model.v3.CreateSignatureRequest

Returns:

The response object which indicates the detail of newly created signature, refer to com.baidubce.services.sms.model.v3.CreateSignatureResponse

deleteSignature

public void deleteSignature(DeleteSignatureRequest request)

Delete the signature

Parameters:

request - refer to com.baidubce.services.sms.model.v3.DeleteSignatureRequest

modifySignature

public void modifySignature(ModifySignatureRequest request)

Modify the signature when audit failure

Parameters:

request - refer to com.baidubce.services.sms.model.v3.ModifySignatureRequest

getSignature

public GetSignatureResponse getSignature(GetSignatureRequest request)

Get signature detail info

Parameters:

request - refer to com.baidubce.services.sms.model.v3.GetSignatureRequest

Returns:

The response object which includes the signature detail info, refer to com.baidubce.services.sms.model.v3.GetSignatureResponse

modifyTemplate

public void modifyTemplate(ModifyTemplateRequest request)

Modify the template when audit failure

Parameters:

request - refer to com.baidubce.services.sms.model.v3.ModifyTemplateRequest

getTemplate

public GetTemplateResponse getTemplate(GetTemplateRequest request)

Get template detail info

Parameters:

request - refer to com.baidubce.services.sms.model.v3.GetTemplateRequest

Returns:

The response object which includes the template detail info, refer to com.baidubce.services.sms.model.v3.GetTemplateResponse

updateQuotaRate

public void updateQuotaRate(UpdateQuotaRateRequest request)

Update quota and rate-limit

Parameters:

request - refer to com.baidubce.services.sms.model.v3.UpdateQuotaRateRequest

queryQuotaRate

public QueryQuotaRateResponse queryQuotaRate()

Query quota and rate-limit detail

Returns:

The response object which includes the detail quota and rate-limit info, refer to com.baidubce.services.sms.model.v3.QueryQuotaRateResponse

listSignature

public ListSignatureResponse listSignature(ListSignatureRequest request)

Get the list of the signatures

Parameters:

request - refer to com.baidubce.services.sms.model.v3.ListSignatureRequest

Returns:

The response object indicates the list of the template, refer to com.baidubce.services.sms.model.v3.ListSignatureResponse

createMobileBlack

public void createMobileBlack(CreateBlackRequest request)

create mobile black

deleteMobileBlack

public void deleteMobileBlack(String phones)

delete mobile black

listMobileBlack

public ListBlackResponse listMobileBlack(ListBlackRequest request)

get the list of mobile black

listStatistics

public ListStatisticsResponse listStatistics(ListStatisticsRequest request)

Query statistics data as a list format

Parameters:

request - The request object, refer to com.baidubce.services.sms.model.v3.ListStatisticsRequest

Returns:

The response object which includes a list of statistics data, refer to com.baidubce.services.sms.model.v3.ListStatisticsResponse

See Also:

QueryQuotaResponse