单条发送接口

单条发送接口
- 请求
- 请求参数
- java请求示例
- php请求示例
- cURL请求示例
- SDK接入
- 响应
- Json返回示例

提示：

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

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

访问方式：POST

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

请求参数

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

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

java请求示例

/**单条短信发送,智能匹配短信模板
* @param apikey成功注册后登录云片官网,进入后台可查看
* @param text需要使用已审核通过的模板或者默认模板
* @param mobile接收的手机号,仅支持单号码发送
* @return json格式字符串
*/
public static String singleSend(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/single_send.json", params);
}

php请求示例

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

cURL请求示例

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

SDK接入

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

响应

名称	类型	描述
code	integer	0代表发送成功，其他code代表出错，详细见"返回值说明"页面
msg	text	例如""发送成功""，或者相应错误信息
count	integer	发送成功短信的计费条数(计费条数：70个字一条，超出70个字时按每67字一条计费)
fee	double	扣费金额，单位：元，类型：双精度浮点型/double
unit	string	计费单位；例如：“RMB”
mobile	string	发送手机号
sid	long(64位)	短信id，64位整型，对应Java和C#的long，不可用int解析

Json返回示例

{
    "code": 0,
    "msg": "发送成功",
    "count": 1,
    "fee": 0.05,
    "unit": "RMB",
    "mobile": "13200000000",
    "sid": 3310228982
}