Table of Contents
> 对象
The following objects are directly related to the mediatype API. 以下对象是直接关联到mediatype接口
Media type 媒介类型
The media type object has the following properties. 媒介类型参数拥有以下参数
| Property | Type | Description |
|---|---|---|
| mediatypeid | string | (readonly) ID of the media type. 媒介类型ID |
| description (required) |
string | Name of the media type. 媒介类型名称 |
| type (required) |
integer | Transport used by the media type. Possible values: 0 - e-mail; 1 - script; 2 - SMS; 3 - Jabber; 100 - Ez Texting. 媒介类型的传输方式 可能的值： 0-电子邮件 1-脚本 2-SMS 3-Jabber 100-Ez Texting。 |
| exec_path | string | For script media types exec_path contains the name of the executed script.For Ez Texting exec_path contains the message text limit.Possible text limit values: 0 - USA (160 characters); 1 - Canada (136 characters). Required for script and Ez Texting media types. 对于脚本媒体类型，“exec_path”包含已执行脚本的名称。 对于z Texting exec_path包含了消息文本的限制可能的文本限定值 ：0- USA (160 characters) 1 - Canada (136 characters). 用于脚本和Ez短信媒体类型。 |
| gsm_modem | string | Serial device name of the GSM modem. Required for SMS media types. GSM调制解调器的串行设备名称。 用于SMS媒介类型 |
| passwd | string | Authentication password. Required for Jabber and Ez Texting media types. 认证的密码 \\用于Jabber和Ez Texting媒介类型 |
| smtp_email | string | Email address from which notifications will be sent. Required for email media types. 发送通知的电子邮件地址。 用于电子邮件媒介类型 |
| smtp_helo | string | SMTP HELO. Required for email media types. SMTP HELO 用于电子邮件媒介类型 |
| smtp_server | string | SMTP server. Required for email media types. SMTP server. \\用于电子邮件媒介类型 |
| status | integer | Whether the media type is enabled. Possible values: 0 - (default) enabled; 1 - disabled. 媒介类型是否是启用的 \\可能的值： 0-启用（默认） 1-禁用 |
| username | string | Username or Jabber identifier. Required for Jabber and Ez Texting media types. 用户名或Jabber标识符 用于Jabber and Ez Texting媒介类型 |
| exec_params | string | Script parameters. Each parameter ends with a new line feed. 脚本参数。 每个参数以新的行提要结束 |
| maxsessions | integer | The maximum number of alerts that can be processed in parallel. Possible values for SMS: 1 - (default) Possible values for other media types: 0-100 可以并行处理的警报的最大数量。 SMS可能的值：1（默认的）\\其他媒介类型可能的值：0-100 |
| maxattempts | integer | The maximum number of attempts to send an alert. Possible values: 1-10 Default value: 3 发送警报的最大尝试次数。 \\可能的值： 1-10，默认是3 |
| attempt_interval | string | The interval between retry attempts. Accepts seconds and time unit with suffix. Possible values: 0-60s Default value: 10s 重试尝试之间的间隔。接收带后缀的秒和时间单位。 可能的值：0~60s 默认是：10s |
Webhook parameters
Parameters passed to webhook script when it is called, have the following properties.
| Property | Type | Description |
|---|---|---|
| name (required) |
string | Parameter name. |
| value | string | Parameter value, support macros. Supported macros described on page. |
Message template
The message template object defines a template that will be used as a default message for action operations to send a notification. It has the following properties.
| Property | Type | Description |
|---|---|---|
| eventsource (required) |
integer | Event source. Possible values: 0 - triggers; 1 - discovery; 2 - autoregistration; 3 - internal. |
| recovery (required) |
integer | Operation mode. Possible values: 0 - operations; 1 - recovery operations; 2 - update operations. |
| subject | string | Message subject. |
| message | string | Message text. |