imbot.chat.sendTyping
Отправить признак «Чат-бот пишет»
Описание
Метод 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');
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imbot.chat.sendTyping", b24.Params{
"BOT_ID": 39,
"DIALOG_ID": "chat123",
"CLIENT_ID": "**put_your_client_id_here**",
})
if err != nil {
return fmt.Errorf("imbot.chat.sendTyping: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
Ответ
{
"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
}
}
Обработка ошибок
HTTP-статус: 400
{
"error": "DIALOG_ID_EMPTY",
"error_description": "Dialog ID can't be empty"
}
| Код | Описание | Значение |
|---|---|---|
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 | Не передан идентификатор диалога |

