短信接口文档.md 2.4 KB

公共请求头

字段名 类型 是否必填 描述
token string 平台分配的token

发送短信

访问方式和地址

POST https://lw_test.jinjianghc.com/api/sms/send

请求参数(可不传,不传按默认值处理):

字段名 类型 是否必填 描述
mobile string 手机号
template_code string 模板id
template_param object 模板参数
type string 短信平台,默认"chuanglan"

短信平台参数说明:

参数 描述
chuanglan 创蓝短信
mas 移动MAS短信
ali 阿里云短信

响应参数说明:

字段名 类型 描述
code int 0成功,1失败
msg string 提示消息
data array 返回数据

响应示例:

{
	"code": 0,
	"msg": "成功",
	"data": []
}

获取短信模板类别

访问方式和地址 POST https://lw_test.jinjianghc.com/api/sms/getTemplateList 请求参数(可不传,不传按默认值处理):

字段名 类型 是否必填 描述
code string 模板编号,模糊搜索
page int 页码,默认1
limit object 每页显示数量,默认10

响应参数说明:

字段名 类型 描述
code int 0成功,1失败
msg string 提示消息
data array 返回数据
data.list array 数据列表
data.list.code string 模板编号
data.list.content string 模板内容
data.list.comment string 备注
data.count int 数据总数,用于分页计算

响应示例:

{
  "code": 0,
  "msg": "成功",
  "data": {
    "list": [
      {
        "code": "verification_code",
        "content": "您的验证码为:${code},请勿泄露于他人!",
        "comment": "短信验证码"
      }
    ],
    "count": 1
  }
}