指定模板群发

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

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_batch_send.json

注意:海外服务器地址 us.yunpian.com

访问方式:POST

http支持:支持https 与 http 两种访问,建议使用https

防骚扰过滤:默认开启。过滤规则:同1个手机发相同内容,30秒内最多发送1次,5分钟内最多发送3次。

请求参数

参数名类型是否必须描述示例
apikeystring用户唯一标识9b11127a9701975c734b8aee81ee3526
mobilestring接收的手机号,发送多个手机号请以英文逗号分隔单号码:15205201314 多号码:15205201314,15205201315
tpl_idlong模板id1
tpl_valuestring变量名和变量值对。请先对您的变量名和变量值分别进行urlencode再传递。使用参考:代码示例。 注:模板中有变量时,变量名和变量值都不能为空,模板中没有变量时,赋值tplvalue=""模板: 【#company#】您的验证码是#code#。 最终发送结果: 【云片网】您的验证码是1234。 tpl_value=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 tplBatchSend(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_batch_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_batch_send.json", params);
  16. }

SDK接入

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

Json响应示例

  1. {
  2. "total_count": 6,
  3. "total_fee": "0.3000",
  4. "unit": "RMB",
  5. "data": [
  6. {
  7. "code": 0,
  8. "msg": "发送成功",
  9. "count": 1,
  10. "fee": 0.05,
  11. "unit": "RMB",
  12. "mobile": "13000000004",
  13. "sid": 3310228978
  14. },
  15. {
  16. "code": 2,
  17. "msg": "请求参数格式错误",
  18. "count": "0",
  19. "fee": "0",
  20. "unit": "RMB",
  21. "mobile": "123321",
  22. "sid": "0"
  23. },
  24. {
  25. "code": 0,
  26. "msg": "发送成功",
  27. "count": 1,
  28. "fee": 0.05,
  29. "unit": "RMB",
  30. "mobile": "13000000005",
  31. "sid": 3310228970
  32. },
  33. {
  34. "code": 0,
  35. "msg": "发送成功",
  36. "count": 1,
  37. "fee": 0.05,
  38. "unit": "RMB",
  39. "mobile": "13000000006",
  40. "sid": 3310228972
  41. },
  42. {
  43. "code": 0,
  44. "msg": "发送成功",
  45. "count": 1,
  46. "fee": 0.05,
  47. "unit": "RMB",
  48. "mobile": "13000000007",
  49. "sid": 3310228974
  50. },
  51. {
  52. "code": 0,
  53. "msg": "发送成功",
  54. "count": 1,
  55. "fee": 0.05,
  56. "unit": "RMB",
  57. "mobile": "13000000005",
  58. "sid": 3310228976
  59. },
  60. {
  61. "code": 0,
  62. "msg": "发送成功",
  63. "count": 1,
  64. "fee": 0.05,
  65. "unit": "RMB",
  66. "mobile": "13000000005",
  67. "sid": 3310228980
  68. },
  69. {
  70. "code": 2,
  71. "msg": "请求参数格式错误",
  72. "count": "0",
  73. "fee": "0",
  74. "unit": "RMB",
  75. "mobile": "123321",
  76. "sid": "0"
  77. }
  78. ]
  79. }