- 指定模板单发(不推荐使用)
- 请求
- 请求参数
- java请求示例
- php请求示例
- SDK接入
- 响应
- Json响应示例
指定模板单发(不推荐使用)
提示:验证码短信,请在手机验证环节,加入图片验证码,以免被恶意攻击。
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 | 是 | 接收的手机号 | 15205201314 |
tpl_id | long | 是 | 模板id | 1 |
tpl_value | string | 是 | 变量名和变量值对。请先对您的变量名和变量值分别进行urlencode再传递。使用参考:代码示例。 注:模板中有变量时,变量名和变量值都不能为空,模板中没有变量时,赋值tpl_value="" | 模板: 【#company#】您的验证码是#code#。 最终发送结果: 【云片网】您的验证码是1234。 tplvalue=urlencode("#code#") + "=" + urlencode("1234") + "&" + urlencode("#company#") + "=" + urlencode("云片网"); 若您直接发送报文请求则使用下面这种形式 tplvalue=urlencode(urlencode("#code#") + "=" + urlencode("1234") + "&" + urlencode("#company#") + "=" + urlencode("云片网")); |
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 , Int tpl_id) {
Map<String, String> params = new HashMap<String, String>();
params.put("apikey", apikey);
params.put("mobile", mobile);
params.put("tpl_id", tpl_id);
params.put.("tpl_value",urlencode("#code#") + "=" + urlencode("1234") + "&" + urlencode("#company#") + "=" + urlencode("云片网"))
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#').'='.urldecode('今年获取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
}