指定模板单发
提示:
- 验证码短信,请在手机验证环节,加入图片验证码,以免被恶意攻击。
- 相对于此接口,更推荐使用单条发送接口,接入更简单,也更适用于不同系统环境中接口的集成。
HTTP 头信息:
Accept:application/json;charset=utf-8;
Content-Type:application/x-www-form-urlencoded;charset=utf-8;
请求
URL:https://sms.yunpian.com/v2/sms/tpl_single_send.json
注意:海外服务器地址 us.yunpian.com
访问方式:POST
http 支持:支持 https 与 http 两种访问,建议使用 https
请求参数
参数名 | 类型 | 是否必须 | 描述 | 示例 |
apikey | string | 是 | 用户唯一标识,在"账号设置"-"子帐号管理"中查看 | 9b11127a9701975c734b8aee81ee3526 |
mobile | string | 是 | 接收的手机号,不需要带+86 前缀 | 15205201314 |
tpl_id | long | 是 | 模板 id | 100 |
tpl_value | string | 是 | 变量名和变量值对。请先对您的变量名和变量值分别进行 urlencode 再传递。 注:模板中有变量时,变量名和变量值都不能为空,模板中没有变量时,赋值 tpl_value="" | 模板: 【云片网】亲爱的#name#,您的验证码是#code#。如非本人操作,请忽略本短信。 最终发送结果: 【云片网】亲爱的张三,您的验证码是1234。如非本人操作,请忽略本短信。 tpl_value=urlencode("#code#") + "=" + urlencode("1234") + "&" + urlencode("#name#") + "=" + urlencode("张三"); 若您直接发送报文请求则使用下面这种形式 tpl_value=urlencode(urlencode("#code#") + "=" + urlencode("1234") + "&" + urlencode("#name#") + "=" + urlencode("张三")); |
callback_url | string | 否 | 短信发送后将向这个地址推送(运营商返回的)发送报告。 如推送地址固定,建议在"数据推送与获取”做批量设置。 如后台已设置地址,且请求内也包含此参数,将以请求内地址为准 |
|
extend | string | 否 | 扩展号。默认不开放,如有需要请联系客服申请 | 001 |
uid | string | 否 | 用户自定义唯一 id。最大长度不超过 256 的字符串。 | 10001 |
java 请求示例
/**指定模版单发
* @param apikey成功注册后登录云片官网,进入后台可查看
* @param mobile接收的手机号,仅支持单号码发送
* @param tpl_id发送的模版id
* @param tpl_value模版内容,变量名和变量值对
* @return json格式字符串
*/
public static String tplSingleSend(String apikey, String mobile, long tpl_id) {
Map<String, String> params = new HashMap<String, String>();
params.put("apikey", apikey);
params.put("mobile", mobile);
params.put("tpl_id", String.valueOf(tpl_id));
params.put("tpl_value",URLEncoder.encode("#code#", ENCODING) + "=" + URLEncoder.encode("1234", ENCODING) + "&" + URLEncoder.encode("#min#", ENCODING) + "=" + URLEncoder.encode("5",ENCODING));
return post("https://sms.yunpian.com/v2/sms/tpl_single_send.json", params);
}
php 请求示例
/**指定模版单发
* @param apikey成功注册后登录云片官网,进入后台可查看
* @param mobile接收的手机号,仅支持单号码发送
* @param tpl_id发送的模版id
* @param tpl_value模版内容,变量名和变量值对,如果内容含有%注意需要是中文全角的
* @return json格式字符串
*/
public function tplSingleSend( $apikey , $mobile , $tplId) {
$param = [
'apikey' => $apikey,
'mobile' => $mobile,
'tpl_id' => $tplId,
'tpl_value' =>('#time#').'=2018-10-11 12:10:11'.'&'.('#content#').'='.urlencode('今年获取30%的红利')
];
return post("https://sms.yunpian.com/v2/sms/tpl_single_send.json", params);
}
SDK 接入
云片提供多种语言的SDK以供您快速接入 API。
响应
名称 | 类型 | 描述 |
code | integer | 0 代表发送成功,其他 code 代表出错,详细见"返回值说明"页面 |
msg | text | 例如""发送成功"",或者相应错误信息 |
count | integer | 发送成功短信的计费条数(计费条数:70 个字一条,超出 70 个字时按每 67 字一条计费) |
fee | double | 扣费金额,单位:元,类型:双精度浮点型/double |
unit | string | 计费单位;例如:“RMB” |
mobile | string | 发送手机号 |
sid | long(64 位) | 短信 id,64 位整型, 对应 Java 和 C#的 long,不可用 int 解析 |
Json 响应示例
{
"code": 0,
"msg": "发送成功",
"count": 1,
"fee": 0.05,
"unit": "RMB",
"mobile": "13000000004",
"sid": 3310228978
}