aliyun短信接口开发平台-开发指南

短信服务

https://help.aliyun.com/document_detail/101893.html?spm=a2c4g.11174283.6.649.687a2c42QwQpcl

查看产品>

短信服务（Short Message Service）是指通过调用短信发送API，将指定短信内容发送给指定手机用户。用户收到的短信来自106开头的号码，短信的内容多用于企业向用户传递验证码、系统通知、会员服务等信息。

产品简介

产品的接入流程、服务协议

产品简介

更多>

用户指南

控制台的操作功能介绍

用户指南

API参考

API文档与接口定义

API参考

常见问题

使用过程中遇到的常见问题

常见问题

aliyun短信接口开发平台-开发指南（旧版）
    短信服务（Short Message Service）是指通过调用短信发送API，将指定短信内容发送给指定手机用户。用户收到的短信来自106开头的号码，短信的内容多用于企业向用户传递验证码、系统通知、会员服务等信息。
    语音服务
    语音通知是指通过调用语音呼叫的API，通过阿里云语音服务，从运营商网络向指定号码发起一通呼叫，呼叫被应答后，播放一段指定的音频。根据音频形式的不同，语音通知的API分为两个：1、若播放的音频为固定内容的音频文件（mp3/wav），则调用singleCallByVoice语音文件外呼接2、若播放的音频为带有变量的文本模板，每次调用时根据变量替换值从文本模板转化为音频文件，则调用singleCallByTts语音文本外呼接口。
    移动推送
    阿里移动推送（Alibaba Cloud

SDK及DEMO下载

更新时间：2019-02-14 15:53:00

本页目录

注意：使用短信服务新版SDK调用API接口，请查看新版SDK参考和API参考。

短信产品相关的SDK及DEMO程序

文件清单

api_demo(短信服务API接口调用DEMO工程)
api_sdk(短信服务API接口依赖的SDK)
msg_demo(短信回执消息的DEMO)
msg_sdk(短信回执消息的SDK)

下载

（如无法下载，建议使用：IE 10 +，Edge，Chrome，Firefox浏览器版本进行下载，目前控制台产品不支持在Pad、手机等移动设备上使用。如果还是不能下载请确认电脑中是否安装P2P下载工具，当浏览器有下载任务的时候，不能使用P2P下载工具下载，浏览器默认的文件另存；建议关闭p2p下载工具。）

1.[JAVA]

2.[PHP]（仅支持5.5以上版本），[SDK轻量版]（轻量版支持php>=5.4，使用方法：先运行Test.php测试PHP环境，测试成功后再运行Demo）

3.[PYTHON]

4.[NET]

5.[Node.js]（node不支持7.6以下版本）

常见问题

Q1：SDK是否能在maven上获取？

可以从maven中获取，在pom文件中添加相关依赖即可。

 
<dependency>
 <groupId>com.aliyun</groupId>
 <artifactId>aliyun-java-sdk-core</artifactId>
 <version>4.0.6</version> <!-- 注：如提示报错，先升级基础包版，无法解决可联系技术支持 -->
</dependency>
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>aliyun-java-sdk-dysmsapi</artifactId>
<version>1.1.0</version>
</dependency>

Q2：除了SDK，还是否需要其他的依赖包？

A：SDK不需要其他的依赖包，只要引用的最新的SDK即可。

 
SDK--PHP--引用问题
由于PHP框架和版本差异较大，demo在系统上不一定能够跑起来，建议参照文档的调用步骤来 新建工程或者直接使用轻量版SDK，因为轻量版在封装签名、拼接部分时没有依赖。另外sdk只是帮助拼接了http请求和解析返回报文，若sdk版本问题无法编译通过，可以自行拼接下http请求来使用。另外如使用SDK有困难。
接口本身只是一个http请求调用，没有语言的限制。
拼接http请求请参照下面的链接，也可以参照sdk中的 源码：
https://help.aliyun.com/document_detail/56189.html?spm=5176.doc55501.6.562.WCtBcB

Q3：除JAVA、PHP、PYTHON、.NET外是否还有其他语言的SDK?

A：暂时没有其他语言的SDK，相关内容逐步完善中，敬请期待！

 
sdk只是帮助拼接了http请求和解析返回报文，如若sdk版本问题无法编译通过，可以自行拼接下http请求来使用。接口本身只是一个http请求调用，没有语言的限制。
拼接http请求请参照上面的链接，也可以参照sdk中的 源码：
https://help.aliyun.com/document_detail/56189.html?spm=5176.product44282.6.562.3wM8lS

Q4：程序引用库，显示引用失败，带一个黄色感叹号，

A：如显示引用失败，带一个黄色感叹号，是因错误使用开发工具造成，请核实开发工具是否正确。

Q5：按照文档进行操作后提示报错怎么办？

A：如提示报错请根据提示点击短信接口调用错误码查询并解决

Q6：如何订阅短信发送状态回执错误码和如何查询不同的错误码分别代表什么？

A：1.云通信的所有业务消息都用过MNS消息服务向外发送。用户每订阅一个类别的消息(比如上行短信消息SmsUp)，系统都会为用户分配一个独立的消息队列。用户可以通过阿里云账号拿到一个临时的token用于获取队列中的消息。用户可以下载demo，编写简单的消息处理类即可完成消息处理的任务。在页面上订阅消息，订阅完消息后，能拿到消息队列名称(queueName)。比如：Alicom-Queue-xxxxxx-SmsReport 。队列名字每个用户都不同。

2.点击查询发送状态回执错误码

Q7：提示：The OwnerId that your Access Key Id associated to is forbidden for this operation.怎么解决？

A：需要核实贵公司用的权限和接口是否一致，很多报错均是因为接口和权限混用导致，或者核实贵公司子账号是否没有开通该操作的权限。

Q8：提示：Can not find endpoint to access SDK.InvalidRegionId 如何解决？

A：示例中有标注不能更改regionId，cn-hangzhou不允许修改，修改后会导致此类报错，另外示例中有标准无需修改地方进行了修改也会导致此类报错。

上一篇：短信下行状态报告

下一篇：短信发送状态回执错误码

短信接口API

/**
 * Created by bingone on 15/12/16.
 */

    import org.apache.http.HttpEntity;
    import org.apache.http.NameValuePair;
    import org.apache.http.client.entity.UrlEncodedFormEntity;
    import org.apache.http.client.methods.CloseableHttpResponse;
    import org.apache.http.client.methods.HttpPost;
    import org.apache.http.impl.client.CloseableHttpClient;
    import org.apache.http.impl.client.HttpClients;
    import org.apache.http.message.BasicNameValuePair;
    import org.apache.http.util.EntityUtils;
    import java.io.IOException;
    import java.net.URISyntaxException;
    import java.net.URLEncoder;
    import java.util.ArrayList;
    import java.util.HashMap;
    import java.util.List;
    import java.util.Map;

/**
 * 短信http接口的java代码调用示例
 * 基于Apache HttpClient 4.3
 *
 * @author songchao
 * @since 2015-04-03
 */

public class JavaSmsApi {

    //查账户信息的http地址
    private static String URI_GET_USER_INFO = "https://sms.yunpian.com/v1/user/get.json";

    //智能匹配模板发送接口的http地址
    private static String URI_SEND_SMS = "https://sms.yunpian.com/v1/sms/send.json";

    //模板发送接口的http地址
    private static String URI_TPL_SEND_SMS = "https://sms.yunpian.com/v1/sms/tpl_send.json";

    //发送语音验证码接口的http地址
    private static String URI_SEND_VOICE = "https://voice.yunpian.com/v1/voice/send.json";

    //编码格式。发送编码格式统一用UTF-8
    private static String ENCODING = "UTF-8";

    public static void main(String[] args) throws IOException, URISyntaxException {

        //修改为您的apikey.apikey可在官网（http://www.yuanpian.com)登录后获取
        String apikey = "xxxxxxxxxxxxxxxxxxxxx";

        //修改为您要发送的手机号
        String mobile = "130xxxxxxxx";

        /**************** 查账户信息调用示例 *****************/
        System.out.println(JavaSmsApi.getUserInfo(apikey));

        /**************** 使用智能匹配模板接口发短信(推荐) *****************/
        //设置您要发送的内容(内容必须和某个模板匹配。以下例子匹配的是系统提供的1号模板）
        String text = "【云片网】您的验证码是1234";
        //发短信调用示例
       // System.out.println(JavaSmsApi.sendSms(apikey, text, mobile));

        /**************** 使用指定模板接口发短信(不推荐，建议使用智能匹配模板接口) *****************/
        //设置模板ID，如使用1号模板:【#company#】您的验证码是#code#
        long tpl_id = 1;
        //设置对应的模板变量值

        String tpl_value = URLEncoder.encode("#code#",ENCODING) +"="
            + URLEncoder.encode("1234", ENCODING) + "&"
            + URLEncoder.encode("#company#",ENCODING) + "="
            + URLEncoder.encode("云片网",ENCODING);
        //模板发送的调用示例
        System.out.println(tpl_value);
        System.out.println(JavaSmsApi.tplSendSms(apikey, tpl_id, tpl_value, mobile));

        /**************** 使用接口发语音验证码 *****************/
        String code = "1234";
        //System.out.println(JavaSmsApi.sendVoice(apikey, mobile ,code));
    }

    /**
     * 取账户信息
     *
     * @return json格式字符串
     * @throws java.io.IOException
     */

    public static String getUserInfo(String apikey) throws IOException, URISyntaxException {
        Map<String, String> params = new HashMap<String, String>();
        params.put("apikey", apikey);
        return post(URI_GET_USER_INFO, params);
    }

    /**
     * 智能匹配模板接口发短信
     *
     * @param apikey apikey
     * @param text   　短信内容
     * @param mobile 　接受的手机号
     * @return json格式字符串
     * @throws IOException
     */

    public static String sendSms(String apikey, String text, String mobile) throws IOException {
        Map<String, String> params = new HashMap<String, String>();
        params.put("apikey", apikey);
        params.put("text", text);
        params.put("mobile", mobile);
        return post(URI_SEND_SMS, params);
    }

    /**
     * 通过模板发送短信(不推荐)
     *
     * @param apikey    apikey
     * @param tpl_id    　模板id
     * @param tpl_value 　模板变量值
     * @param mobile    　接受的手机号
     * @return json格式字符串
     * @throws IOException
     */

    public static String tplSendSms(String apikey, long tpl_id, String tpl_value, String mobile) throws IOException {
        Map<String, String> params = new HashMap<String, String>();
        params.put("apikey", apikey);
        params.put("tpl_id", String.valueOf(tpl_id));
        params.put("tpl_value", tpl_value);
        params.put("mobile", mobile);
        return post(URI_TPL_SEND_SMS, params);
    }

    /**
     * 通过接口发送语音验证码
     * @param apikey apikey
     * @param mobile 接收的手机号
     * @param code   验证码
     * @return
     */

    public static String sendVoice(String apikey, String mobile, String code) {
        Map<String, String> params = new HashMap<String, String>();
        params.put("apikey", apikey);
        params.put("mobile", mobile);
        params.put("code", code);
        return post(URI_SEND_VOICE, params);
    }

    /**
     * 基于HttpClient 4.3的通用POST方法
     *
     * @param url       提交的URL
     * @param paramsMap 提交<参数，值>Map
     * @return 提交响应
     */

    public static String post(String url, Map<String, String> paramsMap) {
        CloseableHttpClient client = HttpClients.createDefault();
        String responseText = "";
        CloseableHttpResponse response = null;
        try {
            HttpPost method = new HttpPost(url);
            if (paramsMap != null) {
                List<NameValuePair> paramList = new ArrayList<NameValuePair>();
                for (Map.Entry<String, String> param : paramsMap.entrySet()) {
                    NameValuePair pair = new BasicNameValuePair(param.getKey(), param.getValue());
                    paramList.add(pair);
                }
                method.setEntity(new UrlEncodedFormEntity(paramList, ENCODING));
            }
            response = client.execute(method);
            HttpEntity entity = response.getEntity();
            if (entity != null) {
                responseText = EntityUtils.toString(entity);
            }
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            try {
                response.close();
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
        return responseText;
    }
}

标签: java