跳至主内容

配置通知设置

此方法用于配置指定用户账户的通知设置。

参数

参数

类型

可选

描述

账户ID

字符串

需要配置通知设置的账户ID。若未提供值,则设置将应用于生成API密钥的账户。

自动删除天数

数字

生成的通知将在指定天数后自动删除。有效值为1至365天,默认值为30天。

emailAddresses

数组

发送通知时使用的额外电子邮件地址列表。

includeDeviceName

布尔值

该选项指定在可用时是否在通过电子邮件发送的通知中包含设备名称。值应为 True 以包含设备名称, False 则不包含。默认值为 False .

includeDeviceFQDN

布尔值

该选项指定在可用时是否在通过电子邮件发送的通知中包含FQDN。值应为 True 以包含FQDN, False 则不包含。默认值为 False .

notificationsSettings

数组

一个包含待配置通知设置的对象列表。仅指定的通知会被更新,未提及的设置将保留原有值。每个对象应具有以下结构:

sendOnlyPlainTextEmail

Boolean

Yes

该选项指定通知邮件是否仅以纯文本形式发送。值为 True 时发送纯文本邮件,值为 False 时使用HTML格式。

返回值

本方法返回布尔值,若通知设置成功配置则返回True。

示例

请求

{
       "params": {
           "accountId": "55896b87b7894d0f367b23c8",
           "deleteAfter": 17,
           "includeDeviceName": true,
           "includeDeviceFQDN": true,
           "emailAddresses": ["example1@example.com"],
           "notificationsSettings":[
               {
                   "type" : 1,
                   "enabled" : true,
                   "visibilitySettings" : {
                       "sendPerEmail" : true,
                       "showInConsole" : true,
                       "useCustomEmailDistribution": false,
                       "emails" : ["example2@example.com"],
                   },
                   "configurationSettings" : {
                       "threshold" : 15,
                       "useThreshold" : true
                   }
               }
           ],
           "sendOnlyPlainTextEmail": true
       },
       "jsonrpc": "2.0",
       "method": "configureNotificationsSettings",
       "id": "5399c9b5-0b46-45e4-81aa-889952433d68"
  }

响应

{
      "id":"5399c9b5-0b46-45e4-81aa-889952433d68",
      "jsonrpc":"2.0",
      "result": true
  }