[comment]: # ({2fbbc9a6-2fbbc9a6})
# > Media type object

The following objects are directly related to the `mediatype` API.

[comment]: # ({/2fbbc9a6-2fbbc9a6})

[comment]: # ({4630c87a-4630c87a})
### Media type

The media type object has the following properties.

|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--------|---------------------------------------------------|-----------|
|mediatypeid|string|*(readonly)* ID of the media type.|
|**name**<br>(required)|string|Name of the media type.|
|**type**<br>(required)|integer|Transport used by the media type.<br><br>Possible values:<br>0 - email;<br>1 - script;<br>2 - SMS;<br>4 - Webhook.|
|exec\_path|string|For script media types `exec_path` contains the name of the executed script.<br><br>Required for script media types.|
|gsm\_modem|string|Serial device name of the GSM modem.<br><br>Required for SMS media types.|
|passwd|string|Authentication password.<br><br>Used for email media types.|
|smtp\_email|string|Email address from which notifications will be sent.<br><br>Required for email media types.|
|smtp\_helo|string|SMTP HELO.<br><br>Required for email media types.|
|smtp\_server|string|SMTP server.<br><br>Required for email media types.|
|smtp\_port|integer|SMTP server port to connect to.|
|smtp\_security|integer|SMTP connection security level to use.<br><br>Possible values:<br>0 - None;<br>1 - STARTTLS;<br>2 - SSL/TLS.|
|smtp\_verify\_host|integer|SSL verify host for SMTP.<br><br>Possible values:<br>0 - No;<br>1 - Yes.|
|smtp\_verify\_peer|integer|SSL verify peer for SMTP.<br><br>Possible values:<br>0 - No;<br>1 - Yes.|
|smtp\_authentication|integer|SMTP authentication method to use.<br><br>Possible values:<br>0 - None;<br>1 - Normal password.|
|status|integer|Whether the media type is enabled.<br><br>Possible values:<br>0 - *(default)* enabled;<br>1 - disabled.|
|username|string|User name.<br><br>Used for email media types.|
|exec\_params|string|Script parameters.<br><br>Each parameter ends with a new line feed.|
|maxsessions|integer|The maximum number of alerts that can be processed in parallel.<br><br>Possible values for SMS:<br>1 - *(default)*<br><br>Possible values for other media types:<br>0-100|
|maxattempts|integer|The maximum number of attempts to send an alert.<br><br>Possible values:<br>1-100<br><br>Default value:<br>3|
|attempt\_interval|string|The interval between retry attempts. Accepts seconds and time unit with suffix.<br><br>Possible values:<br>0-1h<br><br>Default value:<br>10s|
|content\_type|integer|Message format.<br><br>Possible values:<br>0 - plain text;<br>1 - *(default)* html.|
|script|string|Media type webhook script javascript body.|
|timeout|string|Media type webhook script timeout. Accepts seconds and time unit with suffix.<br><br>Possible values:<br>1-60s<br><br>Default value:<br>30s|
|process\_tags|integer|Defines should the webhook script response to be interpreted as tags and these tags should be added to associated event.<br><br>Possible values:<br>0 - *(default)* Ignore webhook script response.<br>1 - Process webhook script response as tags.|
|show\_event\_menu|integer|Show media type entry in `problem.get` and `event.get` property `urls`.<br><br>Possible values:<br>0 - *(default)* Do not add `urls` entry.<br>1 - Add media type to `urls` property.|
|event\_menu\_url|string|Define `url` property of media type entry in `urls` property of `problem.get` and `event.get`.|
|event\_menu\_name|string|Define `name` property of media type entry in `urls` property of `problem.get` and `event.get`.|
|parameters|array|Array of [webhook input parameters](/manual/api/reference/mediatype/object#Webhook parameters).|
|description|string|Media type description.|

[comment]: # ({/4630c87a-4630c87a})

[comment]: # ({46e1e59a-46e1e59a})
### Webhook parameters

Parameters passed to webhook script when it is called, have the
following properties.

|Property|[Type](/manual/api/reference_commentary#data_types)|Description|
|--------|---------------------------------------------------|-----------|
|**name**<br>(required)|string|Parameter name.|
|value|string|Parameter value, support macros. Supported macros described on [page](/manual/appendix/macros/supported_by_location).|

[comment]: # ({/46e1e59a-46e1e59a})

[comment]: # ({48d58257-48d58257})
### 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](/manual/api/reference_commentary#data_types)|Description|
|--------|---------------------------------------------------|-----------|
|**eventsource**<br>(required)|integer|Event source.<br><br>Possible values:<br>0 - triggers;<br>1 - discovery;<br>2 - autoregistration;<br>3 - internal.|
|**recovery**<br>(required)|integer|Operation mode.<br><br>Possible values:<br>0 - operations;<br>1 - recovery operations;<br>2 - update operations.|
|subject|string|Message subject.|
|message|string|Message text.|

[comment]: # ({/48d58257-48d58257})