Боты
Подключение нового бота через API не осуществляется, т.к. каждый мессенджер имеет свои особенности. Для добавления бота, пожалуйста, воспользуйтесь личным кабинетом.
Как определить статус бота (канала)
Каждый подключенный к платформе Shop2bot канал имеет два статуса:
Статус бота
Статус адаптера
Статус бота используется для ручной остановки и запуска бота. Возможные варианты:
1
- Бот создан
3
- Остановлен вручную
5
- Запущен
Статус бота можно получить выполнив запрос /bot/bots/:id/
в поле status
Статус адаптера отражает статус соединения платформы Shop2bot и серверов мессенджера для запущеных ботов (у которых статус бота 1
).
Статус адаптера отражает реальное состояние канала (бота). Узнать его можно, выполнив запрос /bot/bot/:id/status/
. Возможные статусы перечислены в документации к этому запросу.
Если бот остановлен вручную, то статус адаптера не имеет смысла, т.к. платформа Shop2bot закрывает все соединения с серверами мессенджера.
Список ботов
GET
https://app.hightouch.ai/api/bot/bots/
Query Parameters
Информация о боте
GET
https://app.hightouch.ai/api/bot/bots/:id/
Path Parameters
Статус бота
GET
https://app.hightouch.ai/api/bot/bot/:id/status/
Возможные статусы ботов:
0
- [all] Остановлен
1
- [vk] calllback сообщества не установлен
2
- [vk] отправка необходимых событий отключена для сообщества
3
- [vk] возможности ботов отключены для сообщества
21
- [telegram] access_token устарел
22
- [telegram] access_token не валиден (введен неверно)
5
- [all] Запускается
6
- [whatsapp] Телефон не подключен
7
- [avito] Бот подключен, ожидание первого сообщения от подписчиков
8
- [all] Webhook установлен, но URL вебхука неверен
10
- [all] Работает
Path Parameters
Перезагрузить (переподключить) бот
GET
https://app.hightouch.ai/api/bot/bot/:id/restart/
Данный запрос выполняет сразу несколько задач: 1. Перезапускает остановленных ботов 2. Переустанавливает webhook (в зависимости от мессенджера) 3. Обновляет подключения к серверам мессенджера
Path Parameters
Остановить бот
GET
https://app.hightouch.ai/api/bot/bot/:id/stop/
Бот перестанет принимать и отправлять сообщения.
В будущем вы сможете перезапустить бота запросом /bot/bot/:id/restart/
Path Parameters
Удалить бот
DELETE
https://app.hightouch.ai/api/bot/bots/:id/
Path Parameters
Última actualización