Chonry

国际短信发送接口

用户通过 HTTP(或 HTTPS)的 POST 或 GET 方式提交短信发送请求。编码采用 UTF-8 编码。

接口地址

POST
http://intlapi.1cloudsp.com/intl/api/v2/send

请求参数

参数名 类型 必填 说明 示例
accesskeyString秘钥keyxxxxxxxxxx
secretString秘钥secretyyyyyyyyyy
mobileString接收短信的手机号码,多个号码以半角逗号 , 隔开 注:最大支持5万13900000000,13900000001
contentString发送的短信内容是模板变量内容,多个变量中间用 ## 或者 $$ 隔开,采用utf8编码先生##9:40##快递公司##1234567 (示例模板:{1}您好,您的订单于{2}已通过{3}发货,运单号{4})
dataJSON该字段用于发送个性短信,mobile和content字段不需要填写,该字段json字符串,json的key是手机号,value是短信内容变量,等同于上面的content 包含多个变量中间用 ## 或者 $$ 隔开,采用utf8编码 最大支持1万{"13700000001":"女士##10:10##物流公司##000000","13700000000":"先生##9:40##快递公司##1234567"}
scheduleSendTimeString短信定时发送时间,格式为:2018-01-01 18:00:00;参数如果为空表示立即发送2018-01-01 18:00:00
senderIdString该字段用于短信下发标识发件人信息xxxxxx

返回参数

参数名 类型 说明 描述
codeString请求状态数0表示请求成功,非0表示请求失败;详细参考 错误码列表
msgString状态说明
batchIdString批次id

请求示例

/* ---示例代码 POST方式----*/

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://intlapi.1cloudsp.com/intl/api/v2/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("mobile", "8613900000001,8613900000002"),
                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());
    }

    //个性短信
    private void sendsms2() throws Exception {
        HttpClient httpClient = new HttpClient();
        PostMethod postMethod = new PostMethod("http://intlapi.1cloudsp.com/intl/api/v2/send");
        postMethod.getParams().setContentCharset("UTF-8");
        postMethod.getParams().setParameter(HttpMethodParams.RETRY_HANDLER,new DefaultHttpMethodRetryHandler());

        String accesskey = "xxxxxxxxxx"; //用户开发key
        String accessSecret = "yyyyyyyyyy"; //用户开发秘钥

        //组装个性短信内容
        JSONObject jsonObj = new JSONObject();
        jsonObj.put("8613700000000","先生##9:40##快递公司##1234567");
        jsonObj.put("8613700000001","女士##10:10##物流公司##000000");//(示例模板:{1}您好,您的订单于{2}已通过{3}发货,运单号{4})

        NameValuePair[] data = {
                new NameValuePair("accesskey", accesskey),
                new NameValuePair("secret", accessSecret),
                new NameValuePair("sign", "123"),
                new NameValuePair("templateId", "100"),
                new NameValuePair("data", URLEncoder.encode(jsonObj.toString(), "utf-8"))
        };
        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();

        //个性短信
        t.sendsms2();
    }
}

/* ---示例代码 POST方式----*/

返回示例

{
    "code": "0",
    "msg": "SUCCESS",
    "batchId": ""
}

详细说明

安全提醒

请妥善保管您的 appSecret,切勿在客户端暴露。所有 API 请求应从服务端发起。

我们使用 Cookie 以及类似技术来改善您的体验、分析流量并进行个性化内容展示。继续浏览即表示您同意我们的 Cookie 政策隐私政策