usermedia.get

Описание

целое число/массив usermedia.get(объект параметры)

Этот метод позволяет получать оповещения пользователей в соответствии с заданными параметрами.

параметры

(объект) Параметры задают желаемый вывод.

Этот метод поддерживает следующие параметры.

Параметр	Тип	Описание
mediaids	строка/массив	Возврат оповещений пользователей только с заданными ID.
usrgrpids	строка/массив	Возврат только тех оповещений пользователей, которые используются пользователями из заданных групп пользователей.
userids	строка/массив	Возврат только тех оповещений пользователей, которые используются заданными пользователями.
mediatypeids	строка/массив	Возврат только тех оповещений пользователей, которые используют заданные способы оповещений.
sortfield	строка/массив	Сортировка результата в соответствии с заданными свойствами. Возможные значения: `mediaid`, `userid` и `mediatypeid`.
countOutput	флаг	Эти параметры являются общими для всех методов `get` и они описаны в справочных комментариях.
editable	логический
excludeSearch	флаг
filter	объект
limit	целое число
output	запрос
preservekeys	флаг
search	объект
searchByAny	логический
searchWildcardsEnabled	логический
sortorder	строка/массив
startSearch	флаг

Возвращаемые значения

(целое число/массив) Возвращает либо:

массив объектов;
количество найденных объектов, если используется параметр countOutput.

Примеры

Получение оповещения пользователя по пользователю

Получение всех оповещений пользователя по заданному пользователю.

Запрос:

{
           "jsonrpc": "2.0",
           "method": "usermedia.get",
           "params": {
               "output": "extend",
               "userids": "1"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Ответ:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "mediaid": "8",
                   "userid": "1",
                   "mediatypeid": "3",
                   "sendto": "+3711231233",
                   "active": "0",
                   "severity": "48",
                   "period": "1-5,09:00-18:00"
               },
               {
                   "mediaid": "9",
                   "userid": "1",
                   "mediatypeid": "1",
                   "sendto": "[email protected]",
                   "active": "0",
                   "severity": "63",
                   "period": "1-7,00:00-24:00"
               }
           ],
           "id": 1
       }

Исходный код

CUserMedia::get() в frontends/php/include/classes/api/services/CUserMedia.php.

Documentation