0  /  80

Работа с уведомлениями

Просмотров: 2966 (Статистика ведётся с 06.02.2017)

Обратите внимание! Все методы указаны с использованием функции restCommand - это метод отправки данных в Битрикс24, данный метод есть в примере ЭхоБота, и представлен здесь в качестве примера. Вы можете использовать свою функцию или javascript-метод BX24.callMethod или bitrix24-php-sdk.


Отправка персонального уведомления

Rest-метод: im.notify.personal.add

Вызов метода:
$result = restCommand('im.notify.personal.add', Array(

   'USER_ID' => 1, // идентификатор пользователя, кому будет адресовано уведомление (обяз.)
   'MESSAGE' => 'Персональное уведомление', // текст уведомления (обяз.)
   'MESSAGE_OUT' => 'Текст персонального уведомления для почты', // текст уведомления для почты, если не задано - используется поле MESSAGE
   'TAG' => 'TEST', // тег уведомления, уникальный в рамках системы, при добавлении уведомления с существующим тегом другие уведомления будут удалены
   'SUB_TAG' => 'SUB|TEST', // дополнительный тег, без проверки на уникальность
   'ATTACH' => '' // Вложение
  
), $_REQUEST["auth"]);
Обязательные поля: USER_ID (идентификатор пользователя, кому будет адресовано уведомление), MESSAGE (текст уведомления).

Результат выполнения: идентификатор уведомления ID или ошибка.

Ссылки по теме:

Как работать с вложениями

Возможные ошибки:

Код ошибкиОписание ошибки
USER_ID_EMPTY Идентификатор получателя не задан.
MESSAGE_EMPTY Не передан текст сообщения.
ATTACH_ERROR Весь переданный объект вложения не прошел валидацию.
ATTACH_OVERSIZE Превышен максимально допустимый размер вложения (30 Кб).


Отправка системного уведомления

Rest-метод: im.notify.system.add

Вызов метода:
$result = restCommand('im.notify.system.add', Array(

   'USER_ID' => 1, // идентификатор пользователя, кому будет адресовано уведомление (обяз.)
   'MESSAGE' => 'Системное уведомление', // текст уведомления (обяз.)
   'MESSAGE_OUT' => 'Текст системного уведомления для почты', // текст уведомления для почты, если не задано - используется поле MESSAGE
   'TAG' => 'TEST', // тег уведомления, уникальный в рамках системы, при добавлении уведомления с существующим тегом другие уведомления будут удалены
   'SUB_TAG' => 'SUB|TEST', // дополнительный тег, без проверки на уникальность
   'ATTACH' => Array() // вложение
  
), $_REQUEST["auth"]);
Обязательные поля: USER_ID (идентификатор пользователя, кому будет адресовано уведомление), MESSAGE (текст уведомления).

Результат выполнения: идентификатор уведомления ID или ошибка.

Ссылки по теме:

Как работать с вложениями

Возможные ошибки:

Код ошибкиОписание ошибки
USER_ID_EMPTY Идентификатор получателя не задан.
MESSAGE_EMPTY Не передан текст сообщения.
ATTACH_ERROR Весь переданный объект вложения не прошел валидацию.
ATTACH_OVERSIZE Превышен максимально допустимый размер вложения (30 Кб).


Удаление уведомления

Rest-метод: im.notify.delete

Вызов метода:
$result = restCommand('im.notify.delete', Array(

    'ID' => 13, // идентификатор уведомления (обяз. одно из трех параметров ID, TAG или SUB_TAG)
    'TAG' => 'TEST' // тег уведомления (обяз. одно из трех параметров ID, TAG или SUB_TAG)
    'SUB_TAG' => 'SUB|TEST' // дополнительный тег (обяз. одно из трех параметров ID, TAG или SUB_TAG)

), $_REQUEST["auth"]);
Обязательные поля: Указывать нужно один из трех параметров на выбор: ID (идентификатор уведомления), TAG (тег уведомления) или SUB_TAG (дополнительный тег).

Результат выполнения: true или ошибка.

Возможные ошибки:

Код ошибкиОписание ошибки
PARAMS_ERROR Ошибка удаления уведомления.


0
Курсы разработаны в компании «1С-Битрикс»