Table of Contents
> Media object
The following objects are directly related to the usermedia API.
Media
Media are created, updated and deleted via the the user API.
The media object defines how a media type should be used for a user. It has the following properties.
| Property | Type | Description |
|---|---|---|
| mediaid | string | (readonly) ID of the media. |
| active (required) |
integer | Whether the media is enabled. Possible values: 0 - enabled; 1 - disabled. |
| mediatypeid (required) |
string | ID of the media type used by the media. |
| period (required) |
string | Time when the notifications can be sent as a time period. |
| sendto (required) |
string | Address, user name or other identifier of the recipient. |
| severity (required) |
integer | Trigger severities to send notifications about. Severities are stored in binary form with each bit representing the corresponding severity. For example, 12 equals 1100 in binary and means, that notifications will be sent from triggers with severities warning and average. Refer to the trigger object page for a list of supported trigger severities. |
| userid (required) |
string | ID of the user that uses the media. |