cn.jsms.api.common

类 SMSClient

java.lang.Object

cn.jsms.api.common.SMSClient

public class SMSClient
extends Object

构造器概要

构造器

构造器和说明
SMSClient(String masterSecret, String appkey)
SMSClient(String masterSecret, String appkey, cn.jiguang.common.connection.HttpProxy proxy, JSMSConfig conf)

方法概要

限定符和类型	方法和说明
void	close()
cn.jiguang.common.resp.ResponseWrapper	deleteScheduleSMS(String scheduleId) Delete schedule SMS by scheduleId
AppBalanceResult	getAppSMSBalance() Get app's SMS balance of an account
ScheduleSMSResult	getScheduleSMS(String scheduleId) Get schedule SMS by scheduleId
AccountBalanceResult	getSMSBalance() Get account's SMS balance
ScheduleListResult	sendBatchScheduleSMS(ScheduleSMSPayload payload) Submit a mission that sending a batch of SMS with schedule
ScheduleResult	sendScheduleSMS(ScheduleSMSPayload payload) Submit a mission that sending a template SMS with pointed schedule
SendSMSResult	sendSMSCode(SMSPayload payload) Send SMS verification code to mobile
SendSMSResult	sendTemplateSMS(SMSPayload payload) Send template SMS to mobile
ValidSMSResult	sendValidSMSCode(String msgId, String code) Send SMS verification code to server, to verify if the code valid
SendSMSResult	sendVoiceSMSCode(SMSPayload payload) Send voice SMS verification code to mobile
void	setHttpClient(cn.jiguang.common.connection.IHttpClient client)
ScheduleListResult	updateBatchScheduleSMS(ScheduleSMSPayload payload, String scheduleId) Update batch of SMS with schedule
ScheduleResult	updateScheduleSMS(ScheduleSMSPayload payload, String scheduleId) Modify SMS with schedule

从类继承的方法 java.lang.Object

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

构造器详细资料

SMSClient

public SMSClient(String masterSecret,
                 String appkey)

SMSClient

public SMSClient(String masterSecret,
                 String appkey,
                 cn.jiguang.common.connection.HttpProxy proxy,
                 JSMSConfig conf)

方法详细资料

sendSMSCode

public SendSMSResult sendSMSCode(SMSPayload payload)
                          throws cn.jiguang.common.resp.APIConnectionException,
                                 cn.jiguang.common.resp.APIRequestException

Send SMS verification code to mobile

参数:

payload - include two parameters: mobile number and templete id. The second parameter is optional.

返回:

return SendSMSResult which includes msg_id

抛出:

cn.jiguang.common.resp.APIConnectionException - connection exception

cn.jiguang.common.resp.APIRequestException - request exception

sendValidSMSCode

public ValidSMSResult sendValidSMSCode(String msgId,
                                       String code)
                                throws cn.jiguang.common.resp.APIConnectionException,
                                       cn.jiguang.common.resp.APIRequestException

Send SMS verification code to server, to verify if the code valid

参数:

msgId - The message id of the verification code

code - Verification code

返回:

return ValidSMSResult includes is_valid

抛出:

cn.jiguang.common.resp.APIConnectionException - connection exception

cn.jiguang.common.resp.APIRequestException - request exception

sendVoiceSMSCode

public SendSMSResult sendVoiceSMSCode(SMSPayload payload)
                               throws cn.jiguang.common.resp.APIConnectionException,
                                      cn.jiguang.common.resp.APIRequestException

Send voice SMS verification code to mobile

参数:

payload - payload includes two parameters: mobile number and ttl(time to live), the second one is optional(if miss ttl, will use default value 60 seconds).

返回:

return SendSMSResult which includes msg_id

抛出:

cn.jiguang.common.resp.APIConnectionException - connection exception

cn.jiguang.common.resp.APIRequestException - request exception

sendTemplateSMS

public SendSMSResult sendTemplateSMS(SMSPayload payload)
                              throws cn.jiguang.common.resp.APIConnectionException,
                                     cn.jiguang.common.resp.APIRequestException

Send template SMS to mobile

参数:

payload - payload includes mobile, temp_id and temp_para, the temp_para is a map, which's key is what you had set in jiguang portal

返回:

return SendSMSResult which includes msg_id

抛出:

cn.jiguang.common.resp.APIConnectionException - connection exception

cn.jiguang.common.resp.APIRequestException - request exception

setHttpClient

public void setHttpClient(cn.jiguang.common.connection.IHttpClient client)

close

public void close()

sendScheduleSMS

public ScheduleResult sendScheduleSMS(ScheduleSMSPayload payload)
                               throws cn.jiguang.common.resp.APIConnectionException,
                                      cn.jiguang.common.resp.APIRequestException

Submit a mission that sending a template SMS with pointed schedule

参数:

payload - ScheduleSMSPayload

返回:

ScheduleResult which includes schedule_id

抛出:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

updateScheduleSMS

public ScheduleResult updateScheduleSMS(ScheduleSMSPayload payload,
                                        String scheduleId)
                                 throws cn.jiguang.common.resp.APIConnectionException,
                                        cn.jiguang.common.resp.APIRequestException

Modify SMS with schedule

参数:

payload - ScheduleSMSPayload

scheduleId - id

返回:

ScheduleResult which includes schedule_id

抛出:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

sendBatchScheduleSMS

public ScheduleListResult sendBatchScheduleSMS(ScheduleSMSPayload payload)
                                        throws cn.jiguang.common.resp.APIConnectionException,
                                               cn.jiguang.common.resp.APIRequestException

Submit a mission that sending a batch of SMS with schedule

参数:

payload - Payload should include sendTime and recipients

返回:

ScheduleListResult

抛出:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

updateBatchScheduleSMS

public ScheduleListResult updateBatchScheduleSMS(ScheduleSMSPayload payload,
                                                 String scheduleId)
                                          throws cn.jiguang.common.resp.APIConnectionException,
                                                 cn.jiguang.common.resp.APIRequestException

Update batch of SMS with schedule

参数:

payload - ScheduleSMSPayload

scheduleId - id

返回:

ScheduleListResult

抛出:

cn.jiguang.common.resp.APIConnectionException - connection exception

cn.jiguang.common.resp.APIRequestException - request exception

getScheduleSMS

public ScheduleSMSResult getScheduleSMS(String scheduleId)
                                 throws cn.jiguang.common.resp.APIConnectionException,
                                        cn.jiguang.common.resp.APIRequestException

Get schedule SMS by scheduleId

参数:

scheduleId - id

返回:

ScheduleSMSResult

抛出:

cn.jiguang.common.resp.APIConnectionException - connection exception

cn.jiguang.common.resp.APIRequestException - request exception

deleteScheduleSMS

public cn.jiguang.common.resp.ResponseWrapper deleteScheduleSMS(String scheduleId)
                                                         throws cn.jiguang.common.resp.APIConnectionException,
                                                                cn.jiguang.common.resp.APIRequestException

Delete schedule SMS by scheduleId

参数:

scheduleId - id

返回:

No content

抛出:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

getSMSBalance

public AccountBalanceResult getSMSBalance()
                                   throws cn.jiguang.common.resp.APIConnectionException,
                                          cn.jiguang.common.resp.APIRequestException

Get account's SMS balance

返回:

AccountBalanceResult

抛出:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

getAppSMSBalance

public AppBalanceResult getAppSMSBalance()
                                  throws cn.jiguang.common.resp.APIConnectionException,
                                         cn.jiguang.common.resp.APIRequestException

Get app's SMS balance of an account

返回:

AppBalanceResult

抛出:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception