|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.baidubce.AbstractBceClient
com.baidubce.services.sms.SmsClientSupport
com.baidubce.services.sms.SmsClient
public class SmsClient
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 | |
|---|---|
SmsClient()
Constructs a new SmsClient instance with default settings. |
|
SmsClient(SmsClientConfiguration config)
Constructs a new SmsClient instance with the specified configuration. |
|
| Method Summary | |
|---|---|
CreateSignatureResponse |
createSignature(CreateSignatureRequest request)
Create the signature |
CreateTemplateResponse |
createTemplate(CreateTemplateRequest request)
Create message template |
CreateTemplateResponse |
createTemplate(CreateTemplateRequest request)
Create the template |
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. |
ListTemplateResponse |
listTemplate(SmsRequest request)
Get the list of message template |
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 |
|---|
computeServiceId, 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 |
|---|
public SmsClient()
SmsClient instance with default settings.
public SmsClient(SmsClientConfiguration config)
SmsClient instance with the specified configuration.
config - the specified configuration, default inherit super class
com.baidubce.BceClientConfigurationSmsClientConfiguration| Method Detail |
|---|
@Deprecated public SendMessageResponse sendMessage(SendMessageRequest request)
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.
request - The request object which includes the content to send and one or more receiver
SendMessageRequest,
SendMessageResponse@Deprecated public SendMessageV2Response sendMessage(SendMessageV2Request request)
public SendMessageV3Response sendMessage(SendMessageV3Request request)
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.
request - refer to com.baidubce.services.sms.model.SendMessageV3Request
com.baidubce.services.sms.model.SendMessageV3Responsepublic QueryMessageDetailResponse queryMessageDetail(QueryMessageDetailRequest request)
request - The request object which includes the id of message to query
id,
content, receiver, sendTime etcQueryMessageDetailRequest,
QueryMessageDetailResponsepublic CreateTemplateResponse createTemplate(CreateTemplateRequest request)
The template which is created will have a unique id. after audited by BCE administrator, it can be used normally.
request - The request object which includes the name and content of template which is ready to be created
CreateTemplateRequest,
CreateTemplateResponsepublic CreateTemplateResponse createTemplate(CreateTemplateRequest request)
request - refer to com.baidubce.services.sms.model.v3.CreateTemplateRequest
com.baidubce.services.sms.model.v3.CreateTemplateResponsepublic void deleteTemplate(DeleteTemplateRequest request)
request - The request object which includes the id of template which is ready to be deletedDeleteTemplateRequestpublic void deleteTemplate(DeleteTemplateRequest request)
request - refer to com.baidubce.services.sms.model.v3.DeleteTemplateRequest@Deprecated public GetTemplateDetailResponse getTemplateDetail(GetTemplateDetailRequest request)
request - The request object which includes the id of template which is ready to be get
com.baidubce.services.sms.model.GetTemplateDetailResponseGetTemplateDetailRequest,
GetTemplateDetailResponsepublic ListTemplateResponse listTemplate(SmsRequest request)
request - The request object which is empty
com.baidubce.services.sms.model.ListTemplateResponseListTemplateResponsepublic QueryQuotaResponse queryQuota(SmsRequest request)
request - The request object which is empty
com.baidubce.services.sms.model.QueryQuotaResponseQueryQuotaResponsepublic StatReceiverResponse statReceiver(StatReceiverRequest request)
request - refer to com.baidubce.services.sms.model.StatReceiverRequest
com.baidubce.services.sms.model.StatReceiverResponseStatReceiverRequest,
StatReceiverResponsepublic CreateSignatureResponse createSignature(CreateSignatureRequest request)
request - refer to com.baidubce.services.sms.model.v3.CreateSignatureRequest
com.baidubce.services.sms.model.v3.CreateSignatureResponsepublic void deleteSignature(DeleteSignatureRequest request)
request - refer to com.baidubce.services.sms.model.v3.DeleteSignatureRequestpublic void modifySignature(ModifySignatureRequest request)
request - refer to com.baidubce.services.sms.model.v3.ModifySignatureRequestpublic GetSignatureResponse getSignature(GetSignatureRequest request)
request - refer to com.baidubce.services.sms.model.v3.GetSignatureRequest
com.baidubce.services.sms.model.v3.GetSignatureResponsepublic void modifyTemplate(ModifyTemplateRequest request)
request - refer to com.baidubce.services.sms.model.v3.ModifyTemplateRequestpublic GetTemplateResponse getTemplate(GetTemplateRequest request)
request - refer to com.baidubce.services.sms.model.v3.GetTemplateRequest
com.baidubce.services.sms.model.v3.GetTemplateResponsepublic void updateQuotaRate(UpdateQuotaRateRequest request)
request - refer to com.baidubce.services.sms.model.v3.UpdateQuotaRateRequestpublic QueryQuotaRateResponse queryQuotaRate()
com.baidubce.services.sms.model.v3.QueryQuotaRateResponse
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||