主题
发送短信(通知/验证码/营销)
接口描述(通知/验证码/营销)
- 请求URL：
/admin-api/open/sms/sendSms - 请求方式：
POST - 请求类型：
application/json
请求参数
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 手机号 | mobile | 是 | String | 15800000000 | 手机号 |
| 模板编码 | templateCode | 是 | String | 116010 | 模板编码 |
| 模板参数 | params | 是 | JSON | { "code": "1234" } | 短信模板参数 |
| 下发短信号码扩展码 | ext | 否 | String | 10000 | 用于匹配上行回复，上行报告会回传。一般5位以内(只支持传数字)，不传默认为空 |
| 自定义参数 | outId | 否 | String | 2022081901 | 如订单号或短信发送记录流水号，状态查询会回传，最大支持256位 |
| 回调地址 | callbackUrl | 否 | String | http://127.0.0.1:48080/api/callback | 回调地址 |
请求示例数据
json
{
"mobile": "15800000000",
"templateCode": "116010",
"params": { "code": "1234" },
"ext": "10000",
"outId": "2022081901",
"callbackUrl": "http://127.0.0.1:48080/api/callback"
}返回参数
| 字段名 | 变量名 | 必需 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 返回状态 | code | 是 | int | 0 | 0-处理成功，其他-处理有误，详见错误码 |
| 返回信息 | msg | 否 | String | success | 具体错误原因，例如：参数格式校验错误 |
| 返回数据 | data | 否 | String | {} | 返回数据,json格式数据 |
| 响应时间 | time | 否 | String | 1661227655420 | 请求响应时间 |
返回示例数据
json
{
"code": 0,
"data": {
"requestId": "2162",
"mobile": "15800000000"
},
"msg": "success",
"time": 1697177004487
}