This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
manual:api:reference:mediatype:object [2017/06/07 10:55] gcalenko fixed attempt_iterval possible values definition (ZBXNEXT-2442) |
manual:api:reference:mediatype:object [2020/08/25 11:54] (current) martins-v internal link to data type commentary (ZBX-17160) |
||
---|---|---|---|
Line 7: | Line 7: | ||
The media type object has the following properties. | The media type object has the following properties. | ||
- | ^ Property ^ Type ^ Description ^ | + | ^ Property ^ [[:manual/api/reference_commentary#data_types|Type]] ^ Description ^ |
| mediatypeid | string | //(readonly)// ID of the media type. | | | mediatypeid | string | //(readonly)// ID of the media type. | | ||
| **description** \\ (required) | string | Name of the media type. | | | **description** \\ (required) | string | Name of the media type. | | ||
Line 17: | Line 17: | ||
| smtp_helo | string | SMTP HELO. \\ \\ Required for email media types. | | | smtp_helo | string | SMTP HELO. \\ \\ Required for email media types. | | ||
| smtp_server | string | SMTP server. \\ \\ Required for email media types. | | | smtp_server | string | SMTP server. \\ \\ Required for email media types. | | ||
+ | | smtp_port | integer | SMTP server port to connect to. | | ||
+ | | smtp_security | integer | SMTP connection security level to use. \\ \\ Possible values: \\ 0 - None; \\ 1 - STARTTLS; \\ 2 - SSL/TLS. | | ||
+ | | smtp_verify_host | integer | SSL verify host for SMTP. \\ \\ Possible values: \\ 0 - No; \\ 1 - Yes. | | ||
+ | | smtp_verify_peer | integer | SSL verify peer for SMTP. \\ \\ Possible values: \\ 0 - No; \\ 1 - Yes. | | ||
+ | | smtp_authentication | integer | SMTP authentication method to use. \\ \\ Possible values: \\ 0 - None; \\ 1 - Normal password. | | ||
| status | integer | Whether the media type is enabled. \\ \\ Possible values: \\ 0 - //(default)// enabled; \\ 1 - disabled. | | | status | integer | Whether the media type is enabled. \\ \\ Possible values: \\ 0 - //(default)// enabled; \\ 1 - disabled. | | ||
| username | string | Username or Jabber identifier. \\ \\ Required for Jabber and Ez Texting media types. | | | username | string | Username or Jabber identifier. \\ \\ Required for Jabber and Ez Texting media types. | | ||
Line 22: | Line 27: | ||
| 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 | | | 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 | | ||
| maxattempts | integer | The maximum number of attempts to send an alert. \\ \\ Possible values: \\ 1-10 \\ \\ Default value: \\ 3| | | maxattempts | integer | The maximum number of attempts to send an alert. \\ \\ Possible values: \\ 1-10 \\ \\ Default value: \\ 3| | ||
- | | attempt_interval | string | The interval between retry attempts. Accepts seconds and time unit with suffix. \\ \\ Possible values: \\ 0s-60s \\ \\ Default value: \\ 10s| | + | | attempt_interval | string | The interval between retry attempts. Accepts seconds and time unit with suffix. \\ \\ Possible values: \\ 0-60s \\ \\ Default value: \\ 10s| |