单条发送接口

提示：

  • 因为运营商政策，请先在后台完成报备签名、模板及做相关设置(详见接入引导)，再开发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/single_send.json

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

访问方式：POST

http支持：支持https 与 http 两种访问，建议使用https

请求参数

参数名类型是否必传是否默认开放描述示例
apikeystring是是用户唯一标识，在管理控制台获取9b11127a9701975c734b8aee81ee3526
mobilestring是是接收的手机号，仅支持单号码发送；15205201314
textstring是是已审核短信模板 （注意：国际短信的签名和模板须绑定使用）【云片网】您的验证码是1234
extendstring否否下发号码扩展号，纯数字001
uidstring否否该条短信在您业务系统内的ID，如订单号或者短信发送记录流水号。默认不开放，如有需要请联系客服申请。10001
callback_urlstring否是短信发送后将向这个地址推送(运营商返回的)发送报告。 如推送地址固定，建议在"数据推送与获取”做批量设置。 如后台已设置地址，且请求内也包含此参数，将以请求内地址为准http://your_receive_url_address
registerboolean否否是否为注册验证码短信，如果传入true，则该条短信作为注册验证码短信统计注册成功率，需联系客服开通。true
mobile_statboolean否是若短信中包含云片短链接，此参数传入true将会把短链接替换为目标手机号的专属链接，用于统计哪些号码的机主点击了短信中的链接，可在云片后台查看。详情参考短信点击统计。true

附注：如需使用"extend""uid"参数，可免费向客服申请。

java请求示例

  1. /**单条短信发送,智能匹配短信模板
  3. * @param apikey成功注册后登录云片官网,进入后台可查看
  5. * @param text需要使用已审核通过的模板或者默认模板
  7. * @param mobile接收的手机号,仅支持单号码发送
  9. * @return json格式字符串
  11. */
  13. public static String singleSend(String apikey, String text, String mobile) {
  14.     Map<String, String> params = new HashMap<String, String>();
  15.     params.put("apikey", apikey);
  16.     params.put("text", text);
  17.     params.put("mobile", mobile);
  18.     return post("https://sms.yunpian.com/v2/sms/single_send.json", params);
  19. }

php请求示例

  1. /**单条短信发送,智能匹配短信模板
  3. * @param apikey成功注册后登录云片官网,进入后台可查看
  5. * @param text需要使用已审核通过的模板或者默认模板,如果内容含有％注意需要是中文全角的
  7. * @param mobile接收的手机号,仅支持单号码发送
  9. * @return json格式字符串
  11. */
  13. public function singleSend($apikey, $text, $mobile) {
  14.         $param = [
  15.                 'apikey' => $apikey,
  16.                 'mobile' => $mobile,
  17.                 'text' => $text,
  18.                 ];
  19.     return post("https://sms.yunpian.com/v2/sms/single_send.json", params);
  20. }

cURL请求示例

  1. #单条短信发送,智能匹配短信模板
  3. # @param apikey成功注册后登录云片官网,进入后台可查看
  5. # @param text需要使用已审核通过的模板或者默认模板,如果内容含有％注意需要是中文全角的
  7. # @param mobile接收的手机号,仅支持单号码发送
  9. # @return json格式字符串
  11. curl -X "POST" "https://sms.yunpian.com/v2/sms/single_send.json" \
  12.   -H "content-type: application/x-www-form-urlencoded" \
  13.   -d "apikey=4d6cxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  14.   -d "mobile=158xxxxxxxx" \
  15.   -d "text=【云片网】您的验证码是1234"

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": "13200000000",
  8.     "sid": 3310228982
  9. }