user.addmedia
Description
object user.addmedia(object parameters)
This method allows to add new media to multiple users.
Parameters
(object) Parameters defining the media to create and the users to add them to.
| Parameter | Type | Description |
|---|---|---|
| medias (required) |
object/array | Media to create for the given users.
The media |
| users (required) |
object/array | Users to add the media to.
The users must have the |
Return values
(object) Returns an object containing the IDs of the created media under the mediaids property.
Examples
Adding a media to multiple users
Create a common e-mail media for two users. The media must send notifications about all alerts at any time.
Request:
{ "jsonrpc": "2.0", "method": "user.addmedia", "params": { "users": [ { "userid": "1" }, { "userid": "2" } ], "medias": { "mediatypeid": "1", "sendto": "[email protected]", "active": 0, "severity": 63, "period": "1-7,00:00-24:00" } }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }
Response:
{ "jsonrpc": "2.0", "result": { "mediaids": [ "12", "13" ] }, "id": 1 }
See also
Source
CUser::addMedia() in frontends/php/api/classes/CUser.php.
Data source: Zabbix