验证码短信发送接口
用户通过 HTTP(或 HTTPS)的 POST 或 GET 方式提交短信发送请求。编码采用 UTF-8 编码。
接口地址
POST
http://api.1cloudsp.com/api/v2/single_send
请求参数
| 参数名 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| accesskey | String | 是 | 秘钥key | xxxxxxxxxx |
| secret | String | 是 | 秘钥secret | yyyyyyyyyy |
| sign | String | 是 | 平台上申请的接口短信签名或者签名ID(须审核通过),采用utf8编码 | 测试签名 |
| templateId | String | 是 | 平台上申请的接口短信模板Id(须审核通过) | 123456 |
| mobile | String | 是 | 接收短信的手机号码(只支持单个手机号) | 18100000000 |
| content | String | 是 | 发送的短信内容是模板变量内容,多个变量中间用 ## 或者 $$ 隔开,采用utf8编码 | 先生##9:40##快递公司##1234567 (示例模板:{1}您好,您的订单于{2}已通过{3}发货,运单号{4}) |
返回参数
| 参数名 | 类型 | 说明 | 描述 |
|---|---|---|---|
| code | String | 请求状态数 | 0表示请求成功,非0表示请求失败;详细参考 错误码列表 |
| msg | String | 状态说明 | |
| smUuid | String | 短信的唯一码 |
请求示例
package apiserver;
import org.apache.commons.httpclient.DefaultHttpMethodRetryHandler;
import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.NameValuePair;
import org.apache.commons.httpclient.methods.PostMethod;
import org.apache.commons.httpclient.params.HttpMethodParams;
import com.alibaba.fastjson.JSONObject;
public class ApiTest {
//普通短信
private void sendsms() throws Exception {
HttpClient httpClient = new HttpClient();
PostMethod postMethod = new PostMethod("http://api.1cloudsp.com/api/v2/single_send");
postMethod.getParams().setContentCharset("UTF-8");
postMethod.getParams().setParameter(HttpMethodParams.RETRY_HANDLER,new DefaultHttpMethodRetryHandler());
String accesskey = "xxxxxxxxxx"; //用户开发key
String accessSecret = "yyyyyyyyyy"; //用户开发秘钥
NameValuePair[] data = {
new NameValuePair("accesskey", accesskey),
new NameValuePair("secret", accessSecret),
new NameValuePair("sign", "123"),
new NameValuePair("templateId", "100"),
new NameValuePair("mobile", "13900000001"),
new NameValuePair("content", URLEncoder.encode("先生##9:40##快递公司##1234567", "utf-8"))//(示例模板:{1}您好,您的订单于{2}已通过{3}发货,运单号{4})
};
postMethod.setRequestBody(data);
postMethod.setRequestHeader("Connection", "close");
int statusCode = httpClient.executeMethod(postMethod);
System.out.println("statusCode: " + statusCode + ", body: "
+ postMethod.getResponseBodyAsString());
}
public static void main(String[] args) throws Exception {
ApiTest t = new ApiTest();
//普通短信
t.sendsms();
}
}返回示例
{
"code": "0",
"msg": "SUCCESS",
"smUuid": "xxxx"
}详细说明
安全提醒
请妥善保管您的 appSecret,切勿在客户端暴露。所有 API 请求应从服务端发起。
