Отправка индикатора набора текста
Метод отправляет в чат событие «печатает...» (typing) или индикатор обработки запроса (processing). Его можно вызывать перед отправкой ответа, чтобы пользователь видел индикатор ввода. Таймаут по умолчанию — 3 секунды.
HTTP метод: POST
URL: https://botapi.messenger.yandex.net/bot/v1/messages/sendTyping/
Заголовки
Authorization: OAuth <токен>
Content-Type: application/json
Тело запроса (JSON)
| Имя параметра | Обязательный | Тип | Описание | Ограничения, значение по умолчанию |
|---|---|---|---|---|
chat_id |
Нет* | string |
ID целевого чата | Бот должен состоять в чате |
user_id |
Нет* | string |
Идентификатор целевого пользователя (UUID) | — |
login |
Нет* | string |
Логин целевого пользователя | — |
thread_id |
Нет | integer |
Идентификатор треда (timestamp сообщения) | — |
type |
Нет | string |
Тип индикатора | text или processing. По умолчанию: text |
timeout |
Нет | integer |
Время отображения индикатора в секундах | От 1 до 60. По умолчанию: 3 |
processing_content |
Нет | object |
Параметры отображения индикатора обработки | Обязательно, если type имеет значение processing |
(*) Необходимо указать ровно один из параметров chat_id, user_id или login — в одном запросе нельзя передавать несколько из них одновременно.
Объект processing_content
| Имя параметра | Обязательный | Тип | Описание | Ограничения, значение по умолчанию |
|---|---|---|---|---|
display |
Да | string |
Режим отображения индикатора | text — показать заданный текст, default — показать стандартный индикатор |
text |
Нет | string |
Текст индикатора | Обязательно, если display имеет значение text. От 1 до 100 символов |
Ограничения
- Бот может отправлять события только в те чаты, в которых он является участником или админом.
- Бот не может отправлять личные события пользователям, для которых это запрещено настройками приватности.
- Бот не может отправлять личные события пользователям вне своей организации.
Важно
Тип processing доступен только в приватных чатах.
Результат
При успешном выполнении возвращается HTTP 200.
| Имя параметра | Обязательный | Тип | Описание |
|---|---|---|---|
ok |
Да | boolean |
Флаг успешности выполнения |
В случае ошибки возвращается соответствующий статус HTTP. Описание ошибки приходит в поле description.
| Имя параметра | Обязательный | Тип | Описание |
|---|---|---|---|
ok |
Да | boolean |
Флаг успешности выполнения |
description |
Да | string |
Описание ошибки |
Пример запроса
curl -X POST -H 'Authorization: OAuth AtXXXXXXXXXXX' -H "Content-Type: application/json" -d '{"chat_id":"0/0/4f24b544-697c-4e18-a9c1-b39432ee9bf9"}' 'https://botapi.messenger.yandex.net/bot/v1/messages/sendTyping/'
Пример запроса с индикатором обработки
curl -X POST \
-H 'Authorization: OAuth AtXXXXXXXXXXX' \
-H 'Content-Type: application/json' \
-d '{"chat_id":"0/0/4f24b544-697c-4e18-a9c1-b39432ee9bf9","type":"processing","timeout":10,"processing_content":{"display":"text","text":"Just a moment..."}}' \
'https://botapi.messenger.yandex.net/bot/v1/messages/sendTyping/'
Пример успешного ответа
{"ok": true}
Пример ответа с ошибкой
{"ok": false, "description": "Bot is not a member of the chat"}
Была ли статья полезна?
Предыдущая
Следующая