Отправить признак «Чат-бот пишет» imbot.chat.sendTyping

Scope: imbot

Кто может выполнять метод: авторизованный пользователь приложения, которое зарегистрировало чат-бота. Метод работает только с ботами этого приложения.

DEPRECATED

Развитие метода остановлено. Используйте imbot.v2.Chat.InputAction.notify.

Метод imbot.chat.sendTyping отправляет в диалог индикатор «Чат-бот пишет». Метод возвращает true сразу после отправки команды.

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

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

Название
Тип

Описание

BOT_ID
integer

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

Если параметр не передан, метод ищет первого бота, который зарегистрирован текущим приложением

DIALOG_ID*
string

Идентификатор объекта, который получит сообщение: пользователь или чат.

Поддерживаемые форматы:

  • USER_ID — идентификатор пользователя, который можно получить через user.get или user.search
  • chatXXX, где XXX — идентификатор чата, который можно получить через imbot.chat.get

CLIENT_ID
string

Параметр обязателен только для вебхуков. Передавайте тот же CLIENT_ID, который был указан при регистрации чат-бота

Примеры кода

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

curl -X POST /
          -H "Content-Type: application/json" /
          -H "Accept: application/json" /
          -d '{"BOT_ID":39,"DIALOG_ID":"chat123","CLIENT_ID":"**put_your_client_id_here**"}' /
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.chat.sendTyping
        
curl -X POST /
          -H "Content-Type: application/json" /
          -H "Accept: application/json" /
          -d '{"BOT_ID":39,"DIALOG_ID":"chat123","auth":"**put_access_token_here**"}' /
          https://**put_your_bitrix24_address**/rest/imbot.chat.sendTyping
        
try {
          const response = await $b24.callMethod('imbot.chat.sendTyping', {
            BOT_ID: 39,
            DIALOG_ID: 'chat123',
          });
        
          const { result } = response.getData();
          console.log('Typing sent:', result);
        } catch (error) {
          console.error('Error sending typing:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.chat.sendTyping',
                    [
                        'BOT_ID' => 39,
                        'DIALOG_ID' => 'chat123',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Typing sent: ' . ($result->data() ? 'true' : 'false');
            }
        } catch (Throwable $exception) {
            error_log($exception->getMessage());
            echo 'Error sending typing: ' . $exception->getMessage();
        }
        
BX24.callMethod(
            'imbot.chat.sendTyping',
            {
                BOT_ID: 39,
                DIALOG_ID: 'chat123',
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'imbot.chat.sendTyping',
            [
                'BOT_ID' => 39,
                'DIALOG_ID' => 'chat123',
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            echo 'Typing sent: ' . ($result['result'] ? 'true' : 'false');
        }

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

HTTP-код: 200

{
            "result": true,
            "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
            }
        }

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

Название
Тип

Описание

result
boolean

true, если команда отправки индикатора принята

time
time

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

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

HTTP-статус: 400

{
            "error": "DIALOG_ID_EMPTY",
            "error_description": "Dialog ID can't be empty"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Значение

BOT_ID_ERROR

Bot not found

Бот не найден или у приложения нет доступного бота для автоподстановки BOT_ID

APP_ID_ERROR

Bot was installed by another rest application

Переданный BOT_ID принадлежит другому приложению

DIALOG_ID_EMPTY

Dialog ID can't be empty

Не передан идентификатор диалога

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

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

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

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

Предыдущая
Выход чат-бота из указанного чата
Следующая
Обзор событий