Боты

Подключение нового бота через API не осуществляется, т.к. каждый мессенджер имеет свои особенности. Для добавления бота, пожалуйста, воспользуйтесь личным кабинетом.

Как определить статус бота (канала)

Каждый подключенный к платформе Shop2bot канал имеет два статуса:

  1. Статус бота

  2. Статус адаптера

Статус бота - используется для ручной остановки и запуска бота. Возможные варианты: 1 - Бот создан 3 - Остановлен вручную 5 - Запущен

Статус бота можно получить выполнив запрос /bot/bots/:id/ в поле status

Статус адаптера - отражает статус соединения платформы Shop2bot и серверов мессенджера для запущеных ботов (у которых статус бота - 1).

Статус адаптера отражает реальное состояние канала (бота) и узнать его можно выполнив запрос /bot/bot/:id/status/. Возможные статусы перечислены в документации к этому запросу.

Если бот остановлен вручную, то статус адаптера не имеет смысла, т.к. платформа Shop2bot закрывает все соединения с серверами мессенджера.

get
Список ботов

https://shop2bot.ru/api/bot/bots/
Request
Response
Request
Query Parameters
shop_id
required
integer
ID магазина
Response
200: OK
{
"status": "ok",
"result": {
"count": 6,
"next": null,
"previous": null,
"results": [
{
"id": 503,
"shop_id": 2,
"bot_type": 1,
"name": "Кофе Доставка",
"avatar_url": "https://storage.yandexcloud.net/s2b-external/telegram/images/38/33989517433481129.jpeg",
"status": 5,
"wa_phone_number": null,
"tg_bot_nickname": "dostavka_kmv_bot",
"vk_group_id": null,
"fb_group_id": null,
"avito_user_id": null,
"waba_phone_number": null
},
...
]
}
}

get
Информация о боте

https://shop2bot.ru/api/bot/bots/:id/
Request
Response
Request
Path Parameters
id
required
integer
ID бота
Response
200: OK
{
"status": "ok",
"result": {
"id": 493,
"shop_id": 2,
"bot_type": 7,
"name": "Чат на сайт",
"avatar_url": null,
"status": 5,
"wa_phone_number": null,
"tg_bot_nickname": null,
"vk_group_id": null,
"fb_group_id": null,
"avito_user_id": null,
"waba_phone_number": "79163066646",
"livechat_jwt": "..."
}
}

get
Статус бота

https://shop2bot.ru/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] Работает
Request
Response
Request
Path Parameters
id
required
integer
ID бота
Response
200: OK
{
"status": "ok",
"result": {
"bot_id": 387,
"status_id": 10
}
}

get
Перезагрузить (переподключить) бот

https://shop2bot.ru/api/bot/bot/:id/restart/
Данный запрос выполняет сразу несколько задач: 1. Перезапускает остановленных ботов 2. Переустанавливает webhook (в зависимости от мессенджера) 3. Обновляет подключения к серверам мессенджера
Request
Response
Request
Path Parameters
id
required
integer
ID бота
Response
200: OK
{
"status": "ok",
"result": {
"bot_id": 387
}
}

get
Остановить бот

https://shop2bot.ru/api/bot/bot/:id/stop/
Бот перестанет принимать и отправлять сообщения. В будущем вы сможете перезапустить бота запросом /bot/bot/:id/restart/
Request
Response
Request
Path Parameters
id
required
integer
ID бота
Response
200: OK
{
"status": "ok",
"result": {
"bot_id": 387
}
}

delete
Удалить бот

https://shop2bot.ru/api/bot/bots/:id/
Request
Response
Request
Path Parameters
id
required
integer
ID бота
Response
204: No Content