发送短信
更新时间:2020-12-15
注意:
下发短信前,需要先申请签名和短信模板,并通过审核。
参数说明
参数名称 | 类型 | 是否必需 | 描述 | 取值示例 |
---|---|---|---|---|
mobile | String | 是 | 手机号码,支持单个或多个手机号,多个手机号之间以英文逗号分隔,一次请求最多支持200个手机号。国际/港澳台号码请按照E.164规范表示,例如台湾手机号以+886开头,”+“不能省略。 | 13800138000,13800138001,+886951234567 |
template | String | 是 | 短信模板ID,模板申请成功后自动创建,全局内唯一 | sms-tmpl-KyAUkV64619 |
signatureId | String | 是 | 短信签名ID,签名表申请成功后自动创建,全局内唯一 | sms-signQxkiwz88470 |
contentVar | String | 是 | 模板变量内容,用于替换短信模板中定义的变量,为json字符串格式 | {"param1":"123","param2":"abc"} |
custom | String | 否 | 用户自定义参数,格式为字符串,状态回调时会回传该值 | - |
userExtId | String | 否 | 通道自定义扩展码,上行回调时会回传该值,其格式为纯数字串。默认为不开通,请求时无需设置该参数。如需开通请联系SMS帮助申请 | 123 |
代码示例
String ACCESS_KEY_ID = "626e6a284eac4e3f97cc30b38ffea6a4";
String SECRET_ACCESS_KEY = "bacbedee5a604a939cc4c996371856b8";
String ENDPOINT = "http://smsv3.bj.baidubce.com";
SmsClientConfiguration config = new SmsClientConfiguration();
config.setCredentials(new DefaultBceCredentials(ACCESS_KEY_ID, SECRET_ACCESS_KEY));
config.setEndpoint(ENDPOINT);
SmsClient smsClient = new SmsClient(config);
SendMessageV3Request request = new SendMessageV3Request();
request.setMobile("13800138000");
request.setSignatureId("sms-signQxkiwz88470");
request.setTemplate("sms-tmpl-awKvRY85349");
Map<String, String> contentVar = new HashMap<>();
contentVar.put("code", "23456");
contentVar.put("minute", "1");
request.setContentVar(contentVar);
SendMessageV3Response response = smsClient.sendMessage(request);
// 解析请求响应 response.isSuccess()为true 表示成功
if (response != null && response.isSuccess()) {
// submit success
} else {
// fail
}