指定模板群发
提示:1. 不建议使用批量发送接口发送验证码短信,可能会造成验证码发送延迟。
2. 该接口为指定模板群发相同内容接口,即多个手机号调用同一模板传入相同变量,如需群发不同内容,可调用指定模板单发接口,通过多线程循环调用来实现。
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_batch_send.json 注意:海外服务器地址 us.yunpian.com 访问方式:POST http 支持:支持 https 与 http 两种访问,建议使用 https
防骚扰过滤:默认开启。过滤规则:同 1 个手机发相同内容,30 秒内最多发送 1 次,5 分钟内最多发送 3 次。
请求参数
参数名 | 类型 | 是否必须 | 描述 | 示例 |
apikey | string | 是 | 用户唯一标识,在"账号设置"-"子帐号管理"中查看 | 9b11127a9701975c734b8aee81ee3526 |
mobile | string | 是 | 接收的手机号,发送多个手机号请以英文逗号分隔,建议单次提交 200 个手机号以内,不要超过 1000 个,不需要带+86 前缀 | 单号码:15205201314 多号码:15205201314,15205201315 |
tpl_id | long | 是 | 模板 id | 100 |
tpl_value | string | 是 | 变量名和变量值对。请先对您的变量名和变量值分别进行 urlencode 再传递。使用参考:代码示例 。 注:模板中有变量时,变量名和变量值都不能为空,模板中没有变量时,赋值 tplvalue="" | 模板:【云片网】亲爱的#name#,您的验证码是#code#。如非本人操作,请忽略本短信。 最终发送结果: 【云片网】亲爱的张三,您的验证码是1234。如非本人操作,请忽略本短信。 tplvalue=urlencode("#code#") + "=" + urlencode("1234") + "&" + urlencode("#name#") + "=" + urlencode("张三"); 若您直接发送报文请求则使用下面这种形式 tplvalue=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 tplBatchSend(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_batch_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_batch_send.json", params); }
SDK 接入
云片提供多种语言的SDK以供您快速接入 API。
Json 响应示例
{ "total_count": 6, "total_fee": "0.3000", "unit": "RMB", "data": [ { "code": 0, "msg": "发送成功", "count": 1, "fee": 0.05, "unit": "RMB", "mobile": "13000000004", "sid": 3310228978 }, { "code": 2, "msg": "请求参数格式错误", "count": "0", "fee": "0", "unit": "RMB", "mobile": "123321", "sid": "0" }, { "code": 0, "msg": "发送成功", "count": 1, "fee": 0.05, "unit": "RMB", "mobile": "13000000005", "sid": 3310228970 }, { "code": 0, "msg": "发送成功", "count": 1, "fee": 0.05, "unit": "RMB", "mobile": "13000000006", "sid": 3310228972 }, { "code": 0, "msg": "发送成功", "count": 1, "fee": 0.05, "unit": "RMB", "mobile": "13000000007", "sid": 3310228974 }, { "code": 0, "msg": "发送成功", "count": 1, "fee": 0.05, "unit": "RMB", "mobile": "13000000005", "sid": 3310228976 }, { "code": 0, "msg": "发送成功", "count": 1, "fee": 0.05, "unit": "RMB", "mobile": "13000000005", "sid": 3310228980 }, { "code": 2, "msg": "请求参数格式错误", "count": "0", "fee": "0", "unit": "RMB", "mobile": "123321", "sid": "0" } ] }