метод REST scope: imopenlines

imopenlines.crm.message.add

Отправить сообщение в открытую линию

Кто может выполнять: пользователь с правом чтения элемента CRM, к которому привязан чат

Описание

Метод imopenlines.crm.message.add отправляет сообщение от имени сотрудника или бота в чат, который привязан к элементу CRM.

Параметры

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

Тип объекта CRM:
- lead — лид
- deal — сделка
- company — компания
- contact — контакт

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

Идентификатор элемента CRM, к которому привязан чат.

Список элементов определенного типа объекта CRM можно получить с помощью метода crm.item.list

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

Идентификатор отправителя сообщения — пользователя или бота, который должен быть участником чата и иметь доступ к элементу CRM.

Идентификатор пользователя можно получить с помощью метода user.get или user.search.

Список чат-ботов можно получить с помощью метода imbot.bot.list

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

Идентификатор чата открытой линии, который связан с элементом CRM.

Идентификатор чата можно получить с помощью метода imopenlines.crm.chat.get или imopenlines.dialog.get

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

Текст сообщения, который будет отображен в чате

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CRM_ENTITY_TYPE":"lead","CRM_ENTITY":1195,"USER_ID":27,"CHAT_ID":1341,"MESSAGE":"Текст сообщения"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imopenlines.crm.message.add

Ответ

HTTP-статус: 200

{
    "result": 19880117,
    "time": {
        "start": 1728626400.123,
        "finish": 1728626400.234,
        "duration": 0.111,
        "processing": 0.045,
        "date_start": "2024-10-11T10:00:00+03:00",
        "date_finish": "2024-10-11T10:00:00+03:00",
        "operating_reset_at":1762349466,
        "operating": 0
    }
}

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

HTTP-статус: 400

{
    "error": "CHAT_NOT_IN_CRM",
    "error_description": "Chat does not belong to the CRM entity being checked"
}
Код Описание Значение
400 CHAT_NOT_IN_CRM Chat does not belong to the CRM entity being checked
403 ACCESS_DENIED Access denied! You dont have access to this action
403 ACCESS_DENIED Access denied! User dont have access to this entity
400 ERROR_ARGUMENT Argument 'CRM_ENTITY_TYPE' is null or empty
400 ERROR_ARGUMENT Argument 'CRM_ENTITY' is null or empty
400 ERROR_ARGUMENT The value of an argument 'CRM_ENTITY' has an invalid type
400 ERROR_ARGUMENT Argument 'USER_ID' is null or empty
400 ERROR_ARGUMENT The value of an argument 'USER_ID' has an invalid type
400 ERROR_ARGUMENT Argument 'CHAT_ID' is null or empty
400 ERROR_ARGUMENT The value of an argument 'CHAT_ID' has an invalid type
400 ERROR_ARGUMENT Argument 'MESSAGE' is null or empty
400 MESSAGE_ADD_ERROR Message isn't added

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

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