跳转到内容

发送短信(验证码)

接口描述
  • 请求URL:/admin-api/open/sms/sendSmsCode
  • 请求方式:POST
  • 请求类型:application/json
请求参数
字段名变量名必填类型示例值描述
手机号mobileString15800000000手机号
模板编码templateCodeString116010模板编码
模板参数paramsJSON{ "code":1234 }短信模板参数
下发短信号码扩展码extString10000用于匹配上行回复,上行报告会回传。一般5位以内(只支持传数字),不传默认为空
自定义参数outIdString2022081901如订单号或短信发送记录流水号,状态查询会回传,最大支持256位
回调地址callbackUrlStringhttp://127.0.0.1:48080/api/callback回调地址
请求示例数据
json
{
  "mobile": "15800000000",
  "templateCode": "tencent-sms-code",
  "params":{ "code":1234 },
  "ext": "10000",
  "outId": "2022081901",
  "callbackUrl": "http://127.0.0.1:48080/api/callback"
}
返回参数
字段名变量名必填类型示例值描述
返回状态codeint00-处理成功,其他-处理有误,详见错误码
返回信息msgStringsuccess具体错误原因,例如:参数格式校验错误
返回数据dataBooleantrue返回数据
响应时间timeString1662626378999请求响应时间
返回示例数据
json
{
  "code": 0,
  "data": true,
  "msg": "success",
  "time": 1662626378999
}