• 国际短信单条发送接口
    • 请求
    • 请求参数
    • java请求示例
    • php请求示例
    • SDK接入
    • 响应
    • Json返回示例

    国际短信单条发送接口

    提示:因为运营商政策,请先在后台完成报备签名、模板及做相关设置(详见接入引导),再开发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接收的手机号,仅支持单号码发送; 国际号码需包含国际地区前缀号码+93701234567
    textString已审核短信模板 (注意:国际短信的签名和模板须绑定使用)【云片网】您的验证码是1234
    uidString该条短信在您业务系统内的ID,如订单号或者短信发送记录流水号。默认不开放,如有需要请联系客服申请。10001
    callback_urlString短信发送后将向这个地址推送(运营商返回的)状态报告。 如推送地址固定,建议在"数据推送与获取”做批量设置。 如后台已设置地址,且请求内也包含此参数,将以请求内地址为准http://your_receive_url_address
    registerBoolean是否为注册验证码短信,如果传入true,则该条短信作为注册验证码短信统计注册成功率,需联系客服开通。http://your_licnese_address

    附注:

    • 如需使用"uid"参数,可免费向客服申请。

    • 请求必须以URL编码

    java请求示例

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

    php请求示例

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

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