接口描述:

  • 获取一个通知系统模板。

请求 URL:

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

请求方式:

  • GET
  • POST

是否授权:

  • 需要授权

业务参数:

参数名 类型 是否必须 范围值 默认值 示例值 描述
notice_tpl_id integer gt:0 1 通知系统模板编号

响应参数:

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

响应示例:

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": {
  5. "notice_tpl_id": 3,
  6. "name": "充值成功",
  7. "code": "sms",
  8. "type": 2,
  9. "sms_code": "",
  10. "title": "欧瑞",
  11. "template": "",
  12. "status": 1,
  13. "get_notice_item": [
  14. {
  15. "item_name": "{商城名称}",
  16. "replace_name": "shop_name"
  17. },
  18. {
  19. "item_name": "{用户账号}",
  20. "replace_name": "user_name"
  21. },
  22. {
  23. "item_name": "{用户昵称}",
  24. "replace_name": "nick_name"
  25. },
  26. {
  27. "item_name": "{充值金额}",
  28. "replace_name": "recharge_money"
  29. }
  30. ]
  31. }
  32. }

备注:

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

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

文档更新时间: 2018-06-06 00:38