通用短信发送接口

接口说明

[!NOTE]
通过后台手动申请提交模板id、短信模板、签名、变量,完成后通过该接口指定变量值、手机号、模板id完成短信发送(需要开通短信套餐)

http请求方式

[!NOTE]
POST application/x-www-form-urlencoded

http请求地址

[!NOTE]
$SERVICE_URL/v2/sign/commSendSms #其中$SERVICE_URL为生产或测试的地址

http请求参数

除公共必填参数外,还需要传以下参数

参数 类型 是否必填 默认值 说明
target string * 手机号
templateCode string * 模板编号 模板申请时的用户给出模板id
param string + 模板内容中的预设键值对json字符串

代码实现

JAVA实现
RequestUtils requestUtils=RequestUtils.init(SERVICE_URL,APP_KEY,APP_SECRET);//建议生成为spring bean
//构建请求参数
Map<String, Object> params=new HashMap<>();
params.put("target","186*****345");
params.put("templateCode","test001");
HashMap<String, String> hashMap = new HashMap<>();
hashMap.put("sponsor","张三");
hashMap.put("name", "李四");
hashMap.put("code", "123");
params.put("param",JSONObject.toJSONString(map));
ResultInfo<Void> ri= requestUtils.doPost("/v2/sign/commSendSms",params);
PHP实现
//构建请求工具
$requestUtils=new RequestUtils($serviceUrl, $appkey, $appSecret);
//初始化请求参数
$arr = ['sponsor'=>"张三",'name'=>'李四', 'code'=>'123'];
$request=array(
"target" => "186*****345" ,//TODO *
"templateCode" => "test001" ,//TODO *
"param" =>json_encode($arr);//编码为JSON字符串
);
$response=$requestUtils->doPost("/v2/sign/commSendSms",$request);

http返回参数

[!NOTE]
返回response为application/json的数据,其字段说明如下

参数 类型 是否必返回 说明
success bool * 成功true;异常false
msg string ? 异常时,返回异常原因
resultCode string ? 异常时返回

[!NOTE]
返回结果,参考:

//正确响应:
{"success":true}

//错误响应:
{"msg":"app_secret不可用","resultCode":"HTTP_PARAM_ERROR","success":false}

results matching ""

    No results matching ""