im.notify.delete

Просмотров: 13180
Дата последнего изменения: 19.11.2021

Александр Суворов

Сложность урока:

3 уровень - средняя сложность. Необходимо внимание и немного подумать.

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

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

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

Параметры

Параметр	Пример	Обязат.	Описание	Ревизия
ID	123	Да*	Идентификатор уведомления	18
TAG	TEST	Да*	Тег уведомления, уникальный в рамках системы.	18
SUB_TAG	SUB\|TEST	Да*	Дополнительный тег, без проверки на уникальность	18

* Указывать нужно один из трех обязательных параметров на выбор: ID (идентификатор уведомления), TAG (тег уведомления) или SUB_TAG (дополнительный тег).

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

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

Вызов метода и ответ

PHP

$result = restCommand('im.notify.delete', Array(

    'ID' => 13,
    'TAG' => 'TEST',
    'SUB_TAG' => 'SUB|TEST'

), $_REQUEST["auth"]);

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

{
	"result": true
}

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

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

{
    "error": "PARAMS_ERROR",
    "error_description": "Ошибка удаления уведомления"
}

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

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

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

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

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