接口描述:

  • 获取一个通知系统。

请求 URL:

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

请求方式:

  • GET
  • POST

是否授权:

  • 需要授权

业务参数:

参数名 类型 是否必须 范围值 默认值 示例值 描述
code string in:sms,email sms 通知系统编码

响应参数:

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

code=sms 响应示例:

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": {
  5. "code": "sms",
  6. "value": {
  7. "key_id": {
  8. "name": "Access Key ID",
  9. "value": "LTAIS84N5AozgaNj"
  10. },
  11. "key_secret": {
  12. "name": "Access Key Secret",
  13. "value": "2vaz6AmNMmgKO5oaYUs1bm2B1iYams"
  14. },
  15. "status": {
  16. "name": "启用状态",
  17. "value": "1"
  18. }
  19. },
  20. "module": "notice",
  21. "description": "短信通知"
  22. }
  23. }

备注:

  1. 参数code值为sms时返回的配置对象格式参考「sms配置格式」,值为email时的返回请参考「email配置格式」
文档更新时间: 2018-06-05 15:33