• 如何发送国际短信
    • 一、注册、报备及设置
    • 二、调通国际短信接口
    • 三、实现业务逻辑
    • 四、按需开发功能

    如何发送国际短信

    本教程可以实现给指定手机号发含验证码的短信，用于验证手机号真实性或验证操作安全性。

    一、注册、报备及设置

    注册云片，完成资质报备、签名报备及模板报备。tips:

    • 报备可以让产品经理、运营等业务人员完成。
    • 开发阶段，建议先关闭IP白名单，或将服务器IP及本地IP均设置在IP白名单内。
    • 为了避免开发调试中，您的手机号被系统防骚扰机制拦截，可以在测试白名单填写您的手机号。

    二、调通国际短信接口

    方法一：直接使用API

    请求

    URL：https://sms.yunpian.com/v2/sms/single_send.json访问方式：POSThttp支持：支持https 与 http 两种访问，建议使用https

    参数：

    参数名类型是否必传是否默认开放描述示例
    apikeyString是是用户唯一标识，在管理控制台获取9b11127a9701975c734b8aee81ee3526
    mobileString是是接收的手机号，仅支持单号码发送； 国际号码需包含国际地区前缀号码，格式必须是"+"号开头("+"号需要urlencode处理，否则会出现格式错误)urlencode("+93701234567")
    textString是是已审核短信模板【云片网】您的验证码是1234
    extendString否否下发号码扩展号，纯数字001
    uidString否否该条短信在您业务系统内的ID，如订单号或者短信发送记录流水号10001
    callback_urlString否是短信发送后将向这个地址推送(运营商返回的)状态报告。 如推送地址固定，建议在"数据推送与获取”做批量设置。 如后台已设置地址，且请求内也包含此参数，将以请求内地址为准http://your_receive_url\_address

    注：如需使用"extend""uid"参数，可免费向客服申请。

    请求示例

    1. /**
    2. *单条短信发送,智能匹配短信模板
    3. *
    4. * @param apikey成功注册后登录云片官网,进入后台可查看
    5. * @param text需要使用已审核通过的模板或者默认模板
    6. * @param mobile接收的手机号,仅支持单号码发送
    7. * @return json格式字符串
    8. */
    10. public static String singleSend(String apikey, String text, String mobile) {
    11.     Map<String, String> params = new HashMap<String, String>();//请求参数集合
    12.     params.put("apikey", apikey);
    13.     params.put("text", text);
    14.     params.put("mobile", mobile);
    15.     return post("https://sms.yunpian.com/v2/sms/single_send.json", params);//请自行使用post方式请求,可使用Apache HttpClient
    16. }

    响应

    名称类型描述
    codeinteger0代表发送成功，其他code代表出错，详细见"返回值说明"页面
    msgtext例如""发送成功""，或者相应错误信息
    countinteger发送成功短信的计费条数(计费条数：70个字一条，超出70个字时按每67字一条计费)
    feedouble扣费金额，单位：元，类型：双精度浮点型/double
    unitstring计费单位；例如：“RMB”
    mobilestring发送手机号
    sidlong(64位)短信id，64位整型， 对应Java和C#的long，不可用int解析

    Json返回示例

    1. {
    2.     "code": 0,
    3.     "msg": "发送成功",
    4.     "count": 1,
    5.     "fee": 0.05,
    6.     "unit": "RMB",
    7.     "mobile": "+93701234567",
    8.     "sid": 3310228982
    9. }

    特别注意: 国际短信接口每次调用只能发送一条短信，如需发送多条，请多次调用。

    方法二：下载、导入SDK，并配置。

    目前云片提供JAVA/PHP/Python/C#/Golang 5种语言SDK、如果您的编程语言云片未提供SDK，您可以根据文档自行对接。

    SDK下载地址（JAVA/PHP/Python/C#/GOLANG）：去下载

    1. //初始化clnt,使用单例方式
    2. YunpianClient clnt = new YunpianClient("apikey").init();
    4. //发送短信API
    5. Map<String, String> param = clnt.newParam(2);
    6. param.put(YunpianClient.MOBILE, "+1********");
    7. param.put(YunpianClient.TEXT, "【云片网】您的验证码是1234");
    8. Result<SmsSingleSend> r = clnt.sms().single_send(param);
    9. //获取返回结果，返回码:r.getCode(),返回码描述:r.getMsg(),API结果:r.getData(),其他说明:r.getDetail(),调用异常:r.getThrowable()
    11. //账户:clnt.user().* 签名:clnt.sign().* 模版:clnt.tpl().* 短信:clnt.sms().* 语音:clnt.voice().* 流量:clnt.flow().* 隐私通话:clnt.call().*
    13. //释放clnt
    14. clnt.close()

    三、实现业务逻辑

    调用接口传入参数。

    • 短信内容需和通过审核的模板匹配上才能发送，如不匹配接口会返回报错信息，报错记录在后台失败请求页可以看到。
    • 传入的手机号(mobile参数)会自动格式化到E.164格式，可能会造成传入mobile参数跟后续的状态报告中的号码不一致。E.164格式说明，参见： https://en.wikipedia.org/wiki/E.164

    四、按需开发功能

    • 对短信发送状态做实时监控如果您需要通过程序对短信的发送状态做实时监控，可以开发“推送/获取状态报告”接口。
    • 国外地区使用海外服务器如海外用户可以调用海外服务器地址us.yunpian.com,获得更快的请求和处理速度。例如使用短信接口时，将sms.yunpian.com替换为us.yunpian.com即可。