批量发送接口
提示:
- 因为运营商政策,请先在后台完成报备签名、模板及做相关设置(详见接入引导),再开发 API。
- 不建议使用批量发送接口发送验证码短信,可能会造成验证码发送延迟。
- 该接口为批量发送相同内容接口,如需批量发送不同内容,可调用单条发送接口,通过多线程循环调用来实现。
HTTP 头信息:
Accept:application/json;charset=utf-8; Content-Type:application/x-www-form-urlencoded;charset=utf-8;
请求
URL:`https://sms.yunpian.com/v2/sms/batch_send.json` 注意:海外服务器地址 us.yunpian.com 访问方式:POST http 支持:支持 https 与 http 两种访问,建议使用 https
请求参数
参数名 | 类型 | 是否必传 | 是否默认开放 | 描述 | 示例 |
apikey | string | 是 | 是 | 用户唯一标识,在"账号设置"-"子帐号管理"中查看 | 9b11127a9701975c734b8aee81ee3526 |
mobile | string | 是 | 是 | 接收的手机号,发送多个手机号请以英文逗号分隔,建议单次提交 200 个手机号以内,不要超过 1000 个,不需要带+86 前缀 | 单号码:15205201314 多号码:15205201314,15205201315 |
text | string | 是 | 是 | 需要发送的短信内容,需要与已审核的短信模板相匹配。 短信内容须在最前面携带审核通过的签名。 | 【云片网】您的订单已经发货,请注意查收 |
extend | string | 否 | 否 | 下发号码扩展号,纯数字 | 001 |
uid | string | 否 | 否 | 该条短信在您业务系统内的 ID,如订单号或者短信发送记录流水号。批量接口同一批短信只能有一个 uid。 | 10001 |
callback_url | string | 否 | 是 | 短信发送后将向这个地址推送(运营商返回的)发送报告。 如推送地址固定,建议在"数据推送与获取”做批量设置。 如后台已设置地址,且请求内也包含此参数,将以请求内地址为准 |
|
mobile_stat | boolean | 否 | 是 | 若短信中包含云片短链接,此参数传入 true 将会把短链接替换为目标手机号的专属链接,用于统计哪些号码的机主点击了短信中的链接,可在云片后台查看。详情参考短信点击统计 。 | true |
附注:如需使用"extend"参数,可免费向客服申请。
java 请求示例
/** * 批量发送短信,相同内容多个号码,智能匹配短信模板 * * @param apikey 成功注册后登录云片官网,进入后台可查看 * @param text 需要使用已审核通过的模板或者默认模板 * @param mobile 接收的手机号,多个手机号用英文逗号隔开 * @return json格式字符串 */ public static String batchSend(String apikey, String text, String mobile) { Map<String, String> params = new HashMap<String, String>();//请求参数集合 params.put("apikey", apikey); params.put("text", text); params.put("mobile", mobile); return post("https://sms.yunpian.com/v2/sms/batch_send.json", params);//请自行使用post方式请求,可使用Apache HttpClient }
php 请求示例
/** * 批量发送短信,相同内容多个号码,智能匹配短信模板 * @param apikey成功注册后登录云片官网,进入后台可查看 * @param text需要使用已审核通过的模板或者默认模板,如果内容含有%注意需要是中文全角的 * @param mobile接收的手机号,多个手机号用英文逗号分割 * @return json格式字符串 */ public function batchSend($apikey, $text, $mobile) { $param = [ 'apikey' => $apikey, 'mobile' => $mobile, 'text' => $text, ]; return post("https://sms.yunpian.com/v2/sms/batch_send.json", params); }
SDK 接入
云片提供多种语言的SDK以供您快速接入 API。
响应
名称 | 类型 | 描述 |
total_count | integer | 扣费条数,70 个字一条,超出 70 个字时按每 67 字一条计 |
total_fee | string | 扣费金额,单位:元 |
unit | string | 计费单位;例如:“RMB” |
data | json 数组 | 参考单个短信发送返回的数据 |
Json 响应示例
{ "total_count": 1, "total_fee": "0.0500", "unit": "RMB", "data": [ { "http_status_code": 400, "code": 2, "msg": "请求参数格式错误", "count": 0, "fee": 0, "unit": "RMB", "mobile": "1234567890123456", "sid": 0 }, { "code": 0, "count": 1, "fee": 0.05, "mobile": "15800000000", "msg": "发送成功", "sid": 42007252230, "unit": "RMB" } ] }