91  /  108

im.notify.system.add

Просмотров: 541 (Статистика ведётся с 06.02.2017)
Александр Суворов
Сложность урока:
4 уровень - сложно, требуется сосредоточится, внимание деталям и точному следованию инструкции.
1
2
3
4
5

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

Ревизия: 18
Получить информацию о текущей ревизии API (версии платформы) – im.revision.get.

Параметры

Параметр Пример Обязат. Описание Ревизия
USER_ID 1 Да Идентификатор пользователя, кому будет адресовано уведомление 18
MESSAGE Системное уведомление Да Текст уведомления 18
MESSAGE_OUT Текст системного уведомления для почты Нет Текст уведомления для почты. Если не задано, то используется поле MESSAGE 18
TAG TEST Нет Тег уведомления, уникальный в рамках системы. При добавлении уведомления с существующим тегом другие уведомления будут удалены 18
SUB_TAG SUB|TEST Нет Дополнительный тег, без проверки на уникальность 18
ATTACH Array() Нет Вложение 18

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

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


Вызов метода

PHP

$result = restCommand('im.notify.system.add', Array(

   'USER_ID' => 1,
   'MESSAGE' => 'Системное уведомление',
   'MESSAGE_OUT' => 'Текст системного уведомления для почты',
   'TAG' => 'TEST',
   'SUB_TAG' => 'SUB|TEST',
   'ATTACH' => Array()
  
), $_REQUEST["auth"]);

Пример ответа

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


Пример ответа при возникновения ошибки

{
    "error": "USER_ID_EMPTY",
    "error_description": "Идентификатор получателя не задан"
}

Описание ключей:

  • error – код возникшей ошибки
  • error_description – краткое описание возникшей ошибки

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

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

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



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