Zabbix Documentation 2.0

3.04.04.4 (current)| In development:5.0 (devel)| Unsupported:1.82.02.22.43.23.44.2Guidelines

User Tools

Site Tools


manual:appendix:api:mediatype:definitions

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

manual:appendix:api:mediatype:definitions [2017/06/07 10:55]
manual:appendix:api:mediatype:definitions [2014/09/25 14:42] (current)
sasha Page moved from 2.0:manual:appendix:api:mediatype:definitions to manual:appendix:api:mediatype:definitions
Line 1: Line 1:
 +===== > Media type object =====
  
 +The following objects are directly related to the ''​mediatype''​ API.
 +
 +==== Media type ====
 +
 +The media type object has the following properties.
 +
 +^  Property ​ ^  Type  ^  Description ​ ^
 +| mediatypeid | string | //​(readonly)//​ ID of the media type. |
 +| **description** \\ (required) | string | Name of the media type. |
 +| **type** \\ (required) | integer | Transport used by the media type. \\ \\ Possible values: \\ 0 - email; \\ 1 - script; \\ 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. |
 +| gsm_modem | string | Serial device name of the GSM modem. \\ \\ Required for SMS media types. |
 +| passwd | string | Authentication password. \\ \\ Required for Jabber and Ez Texting media types. |
 +| 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_server | string | SMTP server. \\ \\ Required for email media types. |
 +| 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. |