метод REST scope: crm

crm.timeline.comment.add

Добавить комментарий

Кто может выполнять: любой пользователь

Описание

Метод добавляет новое дело типа «Комментарий» в таймлайн.

Параметры

fields object обязательный

Значения полей (подробное описание приведено ниже) для добавления нового дела типа «Комментарий» в виде структуры:


fields:
{
    "ENTITY_ID": 'значение',
    "ENTITY_TYPE": 'значение',
    "COMMENT": 'значение',
    "FILES": [
        [
            "название файла", 
            "содержимое файла"
        ],
        [
            "название файла",
            "содержимое файла"
        ],
    ]
}

Содержимое файла передается в виде base64-строки

С версии crm 23.100.0 метод принимает только параметры с ключом fields в нижнем регистре. Другие недокументированные варианты (Fields, FIELDS, arFields) не принимаются.

Параметр fields

ENTITY_ID integer обязательный

ID элемента, к которому привязан комментарий.

Значение можно получить методом crm.item.list или при создании элемента с помощью crm.item.add

ENTITY_TYPE string обязательный

Идентификатор системного или пользовательского типа объекта CRM, к элементу которого привязан комментарий. Например: lead, deal, contact, company, order, dynamic_1046

COMMENT string обязательный

Текст комментария

FILES attached_diskfile необязательный

Список файлов. Массив значений, описанный по правилам

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"ENTITY_ID":10,"ENTITY_TYPE":"deal","COMMENT":"New comment was added","FILES":[["1.gif","R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="],["2.gif","R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="]]}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.timeline.comment.add

Ответ

HTTP-статус: 200

{
    "result": 999,
    "time": {
        "start": 1715091541.642592,
        "finish": 1715091541.730599,
        "duration": 0.08800697326660156,
        "date_start": "2024-05-03T17:19:01+03:00",
        "date_finish": "2024-05-03T17:19:01+03:00",
        "operating": 0
    }
}

Возвращаемые данные

result integer

Возвращает целочисленный идентификатор добавленного комментария

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": "NOT_FOUND",
    "error_description": "Not found."
}
Код Описание Значение
OWNER_NOT_FOUND Владелец элемента не найден
ACCESS_DENIED Недостаточно прав
NOT_FOUND Элемент не найден
INVALID_ARG_VALUE Пустой коментарий
100 Не переданы обязательные поля

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.