国际短信单条发送接口


提示:因为运营商政策,请先在后台完成报备签名、模板及做相关设置(详见接入引导),再开发 API。


HTTP 头信息:


Accept:application/json;charset=utf-8;
Content-Type:application/x-www-form-urlencoded;charset=utf-8;


请求


URL:https://sms.yunpian.com/v2/sms/single_send.json
注意:海外服务器地址 us.yunpian.com
访问方式:POST
支持 https 与 http 两种访问,建议使用 https


附注:国际短信接口每次调用只能发送一条短信,如需发送多条,请多次调用。


请求参数

参数名类型是否必传是否默认开放描述示例
apikeyString

用户唯一标识,在"账号设置"-"子帐号管理"中查看

9b11127a9701975c734b8aee81ee3526
mobileString接收的手机号,仅支持单号码发送; 国际号码需包含国际地区前缀号码+93701234567
textString

发送的短信内容需要与已审核的短信模板相匹配。新增模板可登录后台国际短信-模板报备页面

【云片网】您的验证码是 1234
uidString该条短信在您业务系统内的 ID,如订单号或者短信发送记录流水号。10001
callback_urlString短信发送后将向这个地址推送(运营商返回的)状态报告。 如推送地址固定,建议在"数据推送与获取”做批量设置。 如后台已设置地址,且请求内也包含此参数,将以请求内地址为准http://your_receive_url_address
registerBoolean是否为注册验证码短信,如果传入 true,则该条短信作为注册验证码短信统计注册成功率,需联系客服开通。http://your_licnese_address


附注:


  • 如需使用"uid"参数,可免费向客服申请。
  • 请求必须以 URL 编码


java 请求示例


/**单条短信发送,智能匹配短信模板

* @param apikey成功注册后登录云片官网,进入后台可查看

* @param text需要使用已审核通过的模板或者默认模板

* @param mobile接收的手机号,仅支持单号码发送

* @return json格式字符串

*/

public static String singleSend(String apikey, String text, String mobile) {
    Map<String, String> params = new HashMap<String, String>();//请求参数集合
    params.put("apikey", apikey);
    params.put("text", text);
    params.put("mobile", mobile);
    return post("https://sms.yunpian.com/v2/sms/single_send.json", params);//请自行使用post方式请求,可使用Apache HttpClient
}


php 请求示例


/**单条短信发送,智能匹配短信模板

* @param apikey成功注册后登录云片官网,进入后台可查看

* @param text需要使用已审核通过的模板或者默认模板,如果内容含有%注意需要是中文全角的

* @param mobile接收的手机号,仅支持单号码发送

* @return json格式字符串

*/

public function singleSend($apikey, $text, $mobile) {
        $param = [
                'apikey' => $apikey,
                'mobile' => $mobile,
                'text' => $text,
                ];
    return post("https://sms.yunpian.com/v2/sms/single_send.json", params);
}


SDK 接入


云片提供多种语言的SDK以供您快速接入 API。


响应

名称类型描述
codeinteger0 代表发送成功,其他 code 代表出错,详细见"返回值说明"页面
msgtext例如""发送成功"",或者相应错误信息
countinteger

发送成功短信的计费条数

1、纯英文:160字内计1条短信费,超过160字以153字每条计费,特殊字符|^€[]~\算两个字。

2、非纯英文:70字内计1条短信费,超过70字以67字每条计费。

3、如短信中含变量的,以实际发送短信字数为准

feedouble扣费金额,单位:元,类型:双精度浮点型/double
unitstring计费单位;例如:“RMB”
mobilestring发送手机号
sidlong(64 位)短信 id,64 位整型, 对应 Java 和 C#的 long,不可用 int 解析


Json 返回示例


{
  "code": 0,
  "msg": "发送成功",
  "count": 1,
  "fee": 0.05,
  "unit": "RMB",
  "mobile": "+93701234567",
  "sid": 3310228982
}