Сохранить сообщение в качестве быстрого ответа imopenlines.message.quick.save

Scope: imopenlines

Кто может выполнять метод: администратор или оператор открытой линии

Метод imopenlines.message.quick.save сохраняет сообщение из чата открытой линии в список быстрых ответов.

Параметры метода

Обязательные параметры отмечены *

Название
Тип

Описание

CHAT_ID*
integer

Идентификатор чата открытой линии, из которого нужно сохранить сообщение.

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

MESSAGE_ID*
integer

Идентификатор сообщения, которое нужно добавить в быстрые ответы.

Идентификатор сообщения можно получить с помощью метода imopenlines.session.history.get

Примеры кода

Как использовать примеры в документации

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"CHAT_ID":1331,"MESSAGE_ID":83507}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imopenlines.message.quick.save
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"CHAT_ID":1331,"MESSAGE_ID":83507,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/imopenlines.message.quick.save
        
try {
          const response = await $b24.callMethod(
            'imopenlines.message.quick.save',
            {
              CHAT_ID: 1331,
              MESSAGE_ID: 83507,
            }
          );
        
          const { result } = response.getData();
          console.log('Saved to quick answers:', result);
        } catch (error) {
          console.error('Error saving quick answer:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'imopenlines.message.quick.save',
                    [
                        'CHAT_ID'    => 1331,
                        'MESSAGE_ID' => 83507,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Saved to quick answers: ' . var_export($result->data(), true);
            }
        } catch (Throwable $exception) {
            error_log($exception->getMessage());
            echo 'Error saving quick answer: ' . $exception->getMessage();
        }
        
BX24.callMethod(
            'imopenlines.message.quick.save',
            {
                CHAT_ID: 1331,
                MESSAGE_ID: 83507,
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'imopenlines.message.quick.save',
            [
                'CHAT_ID'    => 1331,
                'MESSAGE_ID' => 83507,
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            echo 'Saved to quick answers: ' . var_export($result['result'], true);
        }

Обработка ответа

HTTP-код: 200

{
            "result": true,
            "time": {
                "start": 1728626400.456,
                "finish": 1728626400.539,
                "duration": 0.083,
                "processing": 0.031,
                "date_start": "2024-10-11T10:00:00+03:00",
                "date_finish": "2024-10-11T10:00:00+03:00",
                "operating": 0
            }
        }

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

Название
Тип

Описание

result
boolean

Содержит true при успешном сохранении в быстрые ответы

time
time

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

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

HTTP-статус: 400

{
            "error": "CANT_SAVE_QUICK_ANSWER",
            "error_description": "Ошибка сохранения быстрого ответа"
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Описание

CHAT_ID

Указан некорректный идентификатор чата

CHAT_TYPE

Указанный чат не является открытой линией

CANT_SAVE_QUICK_ANSWER

Ошибка сохранения быстрого ответа

ACCESS_DENIED

Недостаточно прав, чтобы открыть указанный чат

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Отправить сообщение в открытую линию
Следующая
Обзор методов