|
||||||||||
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 | |
---|---|
CreateTemplateResponse |
createTemplate(CreateTemplateRequest request)
Create message template |
void |
deleteTemplate(DeleteTemplateRequest request)
Delete message template |
GetTemplateDetailResponse |
getTemplateDetail(GetTemplateDetailRequest request)
Get the detail of message template |
ListTemplateResponse |
listTemplate(SmsRequest request)
Get the list of message template |
QueryMessageDetailResponse |
queryMessageDetail(QueryMessageDetailRequest request)
Query message detail |
QueryQuotaResponse |
queryQuota(SmsRequest request)
Query the sending quota |
SendMessageResponse |
sendMessage(SendMessageRequest request)
Send message |
SendMessageV2Response |
sendMessage(SendMessageV2Request request)
|
StatReceiverResponse |
statReceiver(StatReceiverRequest request)
Get the statistics about receiving message |
Methods inherited from class com.baidubce.services.sms.SmsClientSupport |
---|
assertListNotNullOrEmpty, assertStringArrayNotNullOrEmpty, assertStringNotNullOrEmpty, createGeneralRequest, createRequest, fillRequestPayload |
Methods inherited from class com.baidubce.AbstractBceClient |
---|
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.BceClientConfiguration
SmsClientConfiguration
Method Detail |
---|
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
public SendMessageV2Response sendMessage(SendMessageV2Request request)
public QueryMessageDetailResponse queryMessageDetail(QueryMessageDetailRequest request)
request
- The request object which includes the id of message to query
id
,
content
, receiver
, sendTime
etcQueryMessageDetailRequest
,
QueryMessageDetailResponse
public 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
,
CreateTemplateResponse
public void deleteTemplate(DeleteTemplateRequest request)
request
- The request object which includes the id of template which is ready to be deletedDeleteTemplateRequest
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.GetTemplateDetailResponse
GetTemplateDetailRequest
,
GetTemplateDetailResponse
public ListTemplateResponse listTemplate(SmsRequest request)
request
- The request object which is empty
com.baidubce.services.sms.model.ListTemplateResponse
ListTemplateResponse
public QueryQuotaResponse queryQuota(SmsRequest request)
request
- The request object which is empty
com.baidubce.services.sms.model.QueryQuotaResponse
QueryQuotaResponse
public StatReceiverResponse statReceiver(StatReceiverRequest request)
request
- refer to com.baidubce.services.sms.model.StatReceiverRequest
com.baidubce.services.sms.model.StatReceiverResponse
StatReceiverRequest
,
StatReceiverResponse
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |