com.baidubce.services.sms.SmsClient Maven / Gradle / Ivy
/*
* Copyright (c) 2014 Baidu.com, Inc. All Rights Reserved
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*/
package com.baidubce.services.sms;
import static com.google.common.base.Preconditions.checkNotNull;
import com.baidubce.http.HttpMethodName;
import com.baidubce.internal.InternalRequest;
import com.baidubce.services.sms.model.CreateTemplateRequest;
import com.baidubce.services.sms.model.CreateTemplateResponse;
import com.baidubce.services.sms.model.DeleteTemplateRequest;
import com.baidubce.services.sms.model.GetTemplateDetailRequest;
import com.baidubce.services.sms.model.GetTemplateDetailResponse;
import com.baidubce.services.sms.model.ListTemplateResponse;
import com.baidubce.services.sms.model.QueryMessageDetailRequest;
import com.baidubce.services.sms.model.QueryMessageDetailResponse;
import com.baidubce.services.sms.model.QueryQuotaResponse;
import com.baidubce.services.sms.model.SendMessageRequest;
import com.baidubce.services.sms.model.SendMessageResponse;
import com.baidubce.services.sms.model.SmsRequest;
import com.baidubce.services.sms.model.SmsResponse;
import com.baidubce.services.sms.model.StatReceiverRequest;
import com.baidubce.services.sms.model.StatReceiverResponse;
import com.baidubce.util.JsonUtils;
/**
* 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.
*
*/
public class SmsClient extends SmsClientSupport {
/**
* Constructs a new SmsClient instance with default settings.
*/
public SmsClient() {
this(new SmsClientConfiguration());
}
/**
* Constructs a new SmsClient instance with the specified configuration.
*
* @param config the specified configuration, default inherit super class
* com.baidubce.BceClientConfiguration
*
* @see com.baidubce.services.sms.SmsClientConfiguration
*/
public SmsClient(SmsClientConfiguration config) {
super(config, SMS_HANDLERS);
}
/**
* 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.
*
*
* @param request The request object which includes the content to send and one or more receiver
* @return The response object which includes the id of message and the statistics of sending result
*
* @see com.baidubce.services.sms.model.SendMessageRequest
* @see com.baidubce.services.sms.model.SendMessageResponse
*/
public SendMessageResponse sendMessage(SendMessageRequest request) {
checkNotNull(request, "object request should not be null.");
assertStringNotNullOrEmpty(request.getTemplateId(),
"string templateId of request should not be null or empty.");
assertListNotNullOrEmpty(request.getReceiver(), "list receiver of request should not be null or empty.");
// allow params is empty
// assertStringNotNullOrEmpty(request.getContentVar(), "contentVar should not be null or empty.");
// validate the receiver
for (String receiver : request.getReceiver()) {
assertStringNotNullOrEmpty(receiver, "receiver should not be null or empty.");
}
InternalRequest internalRequest = this.createRequest("message", request, HttpMethodName.POST);
// fill in the request payload
internalRequest = fillRequestPayload(internalRequest, JsonUtils.toJsonString(request));
return this.invokeHttpClient(internalRequest, SendMessageResponse.class);
}
/**
* Query message detail
*
* @param request The request object which includes the id of message to query
* @return The response object which includes all the detail result, for example id,
* content, receiver, sendTime etc
*
* @see com.baidubce.services.sms.model.QueryMessageDetailRequest
* @see com.baidubce.services.sms.model.QueryMessageDetailResponse
*/
public QueryMessageDetailResponse queryMessageDetail(QueryMessageDetailRequest request) {
checkNotNull(request, "object request should not be null.");
assertStringNotNullOrEmpty(request.getMessageId(), "object messageId should not be null or empty.");
InternalRequest internalRequest =
this.createRequest("message", request, HttpMethodName.GET, request.getMessageId());
return this.invokeHttpClient(internalRequest, QueryMessageDetailResponse.class);
}
/**
* Create message template
*
* The template which is created will have a unique id. after audited by BCE administrator, it can be used normally.
*
*
* @param request The request object which includes the name and content of template which is ready to be created
* @return The response object which includes the id of template which is created
*
* @see com.baidubce.services.sms.model.CreateTemplateRequest
* @see com.baidubce.services.sms.model.CreateTemplateResponse
*/
public CreateTemplateResponse createTemplate(CreateTemplateRequest request) {
checkNotNull(request, "object request should not be null.");
assertStringNotNullOrEmpty(request.getName(), "string name of request object should not be null or empty.");
assertStringNotNullOrEmpty(request.getContent(),
"string content of request object should not be null or empty.");
InternalRequest internalRequest = this.createRequest("template", request, HttpMethodName.POST);
// fill in the request payload
internalRequest = fillRequestPayload(internalRequest, JsonUtils.toJsonString(request));
return this.invokeHttpClient(internalRequest, CreateTemplateResponse.class);
}
/**
* Delete message template
*
* @param request The request object which includes the id of template which is ready to be deleted
*
* @see com.baidubce.services.sms.model.DeleteTemplateRequest
*/
public void deleteTemplate(DeleteTemplateRequest request) {
checkNotNull(request, "object request should not be null.");
assertStringNotNullOrEmpty(request.getTemplateId(), "object templateId should not be null or empty.");
InternalRequest internalRequest =
this.createRequest("template", request, HttpMethodName.DELETE, request.getTemplateId());
this.invokeHttpClient(internalRequest, SmsResponse.class);
}
/**
* Get the detail of message template
*
* @param request The request object which includes the id of template which is ready to be get
* @return The response object which includes all of the detail of message template, refer to
* com.baidubce.services.sms.model.GetTemplateDetailResponse
*
* @see com.baidubce.services.sms.model.GetTemplateDetailRequest
* @see com.baidubce.services.sms.model.GetTemplateDetailResponse
*/
public GetTemplateDetailResponse getTemplateDetail(GetTemplateDetailRequest request) {
checkNotNull(request, "object request should not be null.");
assertStringNotNullOrEmpty(request.getTemplateId(), "object templateId should not be null or empty.");
InternalRequest internalRequest =
this.createRequest("template", request, HttpMethodName.GET, request.getTemplateId());
return this.invokeHttpClient(internalRequest, GetTemplateDetailResponse.class);
}
/**
* Get the list of message template
*
* @param request The request object which is empty
* @return The response object which includes all of the detail of message template,refer to
* com.baidubce.services.sms.model.ListTemplateResponse
*
* @see com.baidubce.services.sms.model.ListTemplateResponse
*/
public ListTemplateResponse listTemplate(SmsRequest request) {
checkNotNull(request, "object request should not be null.");
InternalRequest internalRequest = this.createRequest("template", request, HttpMethodName.GET);
return this.invokeHttpClient(internalRequest, ListTemplateResponse.class);
}
/**
* Query the sending quota
*
* @param request The request object which is empty
* @return The response object which includes the detail of sending quota, refer to
* com.baidubce.services.sms.model.QueryQuotaResponse
*
* @see com.baidubce.services.sms.model.QueryQuotaResponse
*/
public QueryQuotaResponse queryQuota(SmsRequest request) {
checkNotNull(request, "object request should not be null.");
InternalRequest internalRequest = this.createRequest("quota", request, HttpMethodName.GET);
return this.invokeHttpClient(internalRequest, QueryQuotaResponse.class);
}
/**
* Get the statistics about receiving message
*
* @param request refer to com.baidubce.services.sms.model.StatReceiverRequest
* @return refer to com.baidubce.services.sms.model.StatReceiverResponse
*
* @see com.baidubce.services.sms.model.StatReceiverRequest
* @see com.baidubce.services.sms.model.StatReceiverResponse
*/
public StatReceiverResponse statReceiver(StatReceiverRequest request) {
checkNotNull(request, "object request should not be null.");
assertStringNotNullOrEmpty(request.getPhoneNumber(), "object phoneNumber should not be null or empty.");
InternalRequest internalRequest =
this.createRequest("receiver", request, HttpMethodName.GET, request.getPhoneNumber());
return this.invokeHttpClient(internalRequest, StatReceiverResponse.class);
}
}