指定模板单发(不推荐使用)

提示:验证码短信,请在手机验证环节,加入图片验证码,以免被恶意攻击。

HTTP头信息:

  1. Accept:application/json;charset=utf-8;
  2. 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

请求参数

参数名类型是否必须描述示例
apikeystring用户唯一标识9b11127a9701975c734b8aee81ee3526
mobilestring接收的手机号15205201314
tpl_idlong模板id1
tpl_valuestring变量名和变量值对。请先对您的变量名和变量值分别进行urlencode再传递。使用参考:代码示例。 注:模板中有变量时,变量名和变量值都不能为空,模板中没有变量时,赋值tpl_value=""模板: 【#company#】您的验证码是#code#。 最终发送结果: 【云片网】您的验证码是1234。 tplvalue=urlencode("#code#") + "=" + urlencode("1234") + "&" + urlencode("#company#") + "=" + urlencode("云片网"); 若您直接发送报文请求则使用下面这种形式 tplvalue=urlencode(urlencode("#code#") + "=" + urlencode("1234") + "&" + urlencode("#company#") + "=" + urlencode("云片网"));
extendstring扩展号。默认不开放,如有需要请联系客服申请001
uidstring用户自定义唯一id。最大长度不超过256的字符串。 默认不开放,如有需要请联系客服申请10001

附注:若使用该接口加密方式,需对手机号和内容加密。

java请求示例

  1. /**指定模版单发
  2. * @param apikey成功注册后登录云片官网,进入后台可查看
  3. * @param mobile接收的手机号,仅支持单号码发送
  4. * @param tpl_id发送的模版id
  5. * @param tpl_value模版内容,变量名和变量值对
  6. * @return json格式字符串
  7. */
  8. public static String tplSingleSend(String apikey, String mobile , Int tpl_id) {
  9. Map<String, String> params = new HashMap<String, String>();
  10. params.put("apikey", apikey);
  11. params.put("mobile", mobile);
  12. params.put("tpl_id", tpl_id);
  13. params.put.("tpl_value",urlencode("#code#") + "=" + urlencode("1234") + "&" + urlencode("#company#") + "=" + urlencode("云片网"))
  14. return post("https://sms.yunpian.com/v2/sms/tpl_single_send.json", params);
  15. }

php请求示例

  1. /**指定模版单发
  2. * @param apikey成功注册后登录云片官网,进入后台可查看
  3. * @param mobile接收的手机号,仅支持单号码发送
  4. * @param tpl_id发送的模版id
  5. * @param tpl_value模版内容,变量名和变量值对,如果内容含有%注意需要是中文全角的
  6. * @return json格式字符串
  7. */
  8. public function tplSingleSend( $apikey , $mobile , $tplId) {
  9. $param = [
  10. 'apikey' => $apikey,
  11. 'mobile' => $mobile,
  12. 'tpl_id' => $tplId,
  13. 'tpl_value' =>('#time#').'=2018-10-11 12:10:11'.'&'.('#content#').'='.urldecode('今年获取30%的红利')
  14. ];
  15. return post("https://sms.yunpian.com/v2/sms/tpl_single_send.json", params);
  16. }

SDK接入

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

响应

名称类型描述
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": "13000000004",
  8. "sid": 3310228978
  9. }