批量发送接口

提示:

  • 因为运营商政策,请先在后台完成报备签名、模板及做相关设置(详见接入引导),再开发API。

  • 不建议使用批量发送接口发送验证码短信,可能会造成验证码发送延迟。

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/batch_send.json

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

访问方式:POST

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

请求参数

参数名类型是否必传是否默认开放描述示例
apikeystring用户唯一标识,在管理控制台获取9b11127a9701975c734b8aee81ee3526
mobilestring接收的手机号;发送多个手机号请以英文逗号分隔,一次不要超过1000个;单号码:15205201314 多号码:15205201314,15205201315
textstring已审核短信模板【云片网】您的订单已经发货,请注意查收
extendstring下发号码扩展号,纯数字001
uidstring该条短信在您业务系统内的ID,如订单号或者短信发送记录流水号。默认不开放,如有需要请联系客服申请。批量接口同一批短信只能有一个uid。10001
callback_urlstring短信发送后将向这个地址推送(运营商返回的)发送报告。 如推送地址固定,建议在"数据推送与获取”做批量设置。 如后台已设置地址,且请求内也包含此参数,将以请求内地址为准http://your_receive_url_address
mobile_statboolean若短信中包含云片短链接,此参数传入true将会把短链接替换为目标手机号的专属链接,用于统计哪些号码的机主点击了短信中的链接,可在云片后台查看。详情参考短信点击统计true

附注:如需使用"extend"参数,可免费向客服申请。

java请求示例

  1. /**
  2. * 批量发送短信,相同内容多个号码,智能匹配短信模板
  3. *
  4. * @param apikey 成功注册后登录云片官网,进入后台可查看
  5. * @param text 需要使用已审核通过的模板或者默认模板
  6. * @param mobile 接收的手机号,多个手机号用英文逗号隔开
  7. * @return json格式字符串
  8. */
  9. public static String batchSend(String apikey, String text, String mobile) {
  10. Map<String, String> params = new HashMap<String, String>();//请求参数集合
  11. params.put("apikey", apikey);
  12. params.put("text", text);
  13. params.put("mobile", mobile);
  14. return post("https://sms.yunpian.com/v2/sms/batch_send.json", params);//请自行使用post方式请求,可使用Apache HttpClient
  15. }

php请求示例

  1. /**批量发送短信,相同内容多个号码,智能匹配短信模板
  2. * @param apikey成功注册后登录云片官网,进入后台可查看
  3. * @param text需要使用已审核通过的模板或者默认模板,如果内容含有%注意需要是中文全角的
  4. * @param mobile接收的手机号,多个手机号用英文逗号分割
  5. * @return json格式字符串
  6. */
  7. public function batchSend($apikey, $text, $mobile) {
  8. $param = [
  9. 'apikey' => $apikey,
  10. 'mobile' => $mobile,
  11. 'text' => $text,
  12. ];
  13. return post("https://sms.yunpian.com/v2/sms/batch_send.json", params);
  14. }

SDK接入

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

响应

名称类型描述
total_countinteger扣费条数,70个字一条,超出70个字时按每67字一条计
total_feestring扣费金额,单位:元
unitstring计费单位;例如:“RMB”
datajson数组参考单个短信发送返回的数据

Json响应示例

  1. {
  2. "total_count": 2,
  3. "total_fee": "0.2000",
  4. "unit": "RMB",
  5. "data": [
  6. {
  7. "code": 0,
  8. "msg": "发送成功",
  9. "count": 1,
  10. "fee": 0.05,
  11. "unit": "RMB",
  12. "mobile": "13000000000",
  13. "sid": 3310228964
  14. },
  15. {
  16. "code": 0,
  17. "msg": "发送成功",
  18. "count": 1,
  19. "fee": 0.05,
  20. "unit": "RMB",
  21. "mobile": "13000000001",
  22. "sid": 3310228968
  23. }
  24. ]
  25. }