user.addmedia

Description

object user.addmedia(object parameters)

This method allows to add new media to multiple users.

This method is deprecated and will be removed in the future. Please use user.update instead.

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 userid property must not be defined.
users(required) object/array Users to add the media to. The users must have the userid property defined.

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:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "method": "user.addmedia",
  4.     "params": {
  5.         "users": [
  6.             {
  7.                 "userid": "1"
  8.             },
  9.             {
  10.                 "userid": "2"
  11.             }
  12.         ],
  13.         "medias": {
  14.             "mediatypeid": "1",
  15.             "sendto": "[email protected]",
  16.             "active": 0,
  17.             "severity": 63,
  18.             "period": "1-7,00:00-24:00"
  19.         }
  20.     },
  21.     "auth": "038e1d7b1735c6a5436ee9eae095879e",
  22.     "id": 1
  23. }

Response:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "result": {
  4.         "mediaids": [
  5.             "12",
  6.             "13"
  7.         ]
  8.     },
  9.     "id": 1
  10. }

See also

Source

CUser::addMedia() in frontends/php/include/classes/api/services/CUser.php.