接口描述:

  • 编辑sms系统模板。

请求 URL:

  • http|https://host/api/v1/notice_tpl/method/set.notice.tpl.item/

请求方式:

  • GET
  • POST

是否授权:

  • 需要授权

业务参数:

参数名 类型 是否必须 范围值 默认值 示例值 描述
notice_tpl_id integer gt:0 2 通知系统模板编号
sms_code string max:20 SMS_126357841 阿里云短信模板编号
sms_sign string length:2,12 欧瑞 阿里云短信签名
template string min:0 {商城名称}{用户昵称} 通知系统模板

响应参数:

参数名 类型 是否返回 示例值 描述
status integer 200 状态码
message string success 消息信息
data object [] 返回对象
data 类型 是否返回 示例值 描述
notice_tpl_id integer 2 通知系统模板编号
name string 注册成功 通知系统模板名称
code string sms 通知系统编码 sms=短信 email=邮件
type integer 1 通知类型,详见「Type常量」
sms_code string SMS_126357841 阿里云短信模板编号
title string 欧瑞 阿里云短信签名
template string {商城名称}{用户昵称} 通知系统模板
status integer 1 模板是否启用 0=禁用 1=启用

响应示例:

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": {
  5. "notice_tpl_id": 2,
  6. "name": "注册成功",
  7. "code": "sms",
  8. "type": 1,
  9. "sms_code": "SMS_126357841",
  10. "title": "欧瑞",
  11. "template": "{商城名称}{用户昵称}",
  12. "status": 1
  13. }
  14. }

使用示例:

假设用户收到完整的内容是尊敬的carey您好,您在CareyShop注册的账号已生效。,则参数template的值实际只需要填{用户昵称}{商城名称}(前后顺序不影响),而在阿里云的模板内容中需要填写尊敬的${nick_name}您好,您在${shop_name}注册的账号已生效。${}是阿里云短信模板内容中变量的格式,至于nick_name的来源请参考「获取一个通知系统模板」

备注:

  1. 短信与邮件共用同一个结构,所以返回时存在多余字段则按需索取。

  2. 返回字段code值为sms时,字段title表示短信签名,否则表示邮件标题。

文档更新时间: 2018-06-06 01:32