接口描述:

  • 获取通知系统列表。

请求 URL:

  • http|https://host/api/v1/notice/method/get.notice.list/

请求方式:

  • GET
  • POST

是否授权:

  • 需要授权

业务参数:

参数名 类型 是否必须 范围值 默认值 示例值 描述

响应参数:

参数名 类型 是否返回 示例值 描述
status integer 200 状态码
message string success 消息信息
data object [] 返回对象
data 类型 是否返回 示例值 描述
sms object [] sms配置对象
email object [] email配置对象
sms|email 类型 是否返回 示例值 描述
code string sms 通知系统编码
value object [] 配置对象,详见备注
module string notice 对应模块
description string 短信通知 简介

响应示例:

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": {
  5. "sms": {
  6. "code": "sms",
  7. "value": {
  8. "key_id": {
  9. "name": "Access Key ID",
  10. "value": "LTAIS84N5Iozg0Nj"
  11. },
  12. "key_secret": {
  13. "name": "Access Key Secret",
  14. "value": "2vaz6AmNMmgKO5htYUs1bm2B1iYams"
  15. },
  16. "status": {
  17. "name": "启用状态",
  18. "value": "1"
  19. }
  20. },
  21. "module": "notice",
  22. "description": "短信通知"
  23. },
  24. "email": {
  25. "code": "email",
  26. "value": {
  27. "email_host": {
  28. "name": "SMTP服务器",
  29. "value": "smtp.careyshop.cn"
  30. },
  31. "email_port": {
  32. "name": "SMTP端口",
  33. "value": 465
  34. },
  35. "email_addr": {
  36. "name": "发信人邮箱地址",
  37. "value": "admin@careyshop.cn"
  38. },
  39. "email_id": {
  40. "name": "SMTP身份验证用户名",
  41. "value": "admin"
  42. },
  43. "email_pass": {
  44. "name": "SMTP身份验证码",
  45. "value": "admin888"
  46. },
  47. "email_ssl": {
  48. "name": "是否使用安全链接",
  49. "value": 0
  50. },
  51. "status": {
  52. "name": "启用状态",
  53. "value": "1"
  54. }
  55. },
  56. "module": "notice",
  57. "description": "邮件通知"
  58. }
  59. }
  60. }

备注:

  1. sms模块配置格式可参考「sms配置格式」

  2. email模块配置格式可参考「email配置格式」

文档更新时间: 2018-06-06 09:57