Salesbot

В данном разделе описывается работа с Salesbot через API

Оглавление

Начало работы с Salesbot

Salesbot – это бот, которого можно запрограммировать на выполнение определенных действий. Он помогает получать от пользователей данные через мессенджеры. Подробнее о Salesbot.

Запуск Salesbot

Метод

POST /api/v4/bots/{id}/run

Описание

Метод для запуска Salesbot.

Ограничения

Метод доступен в соответствии с правами пользователя.

Заголовок запроса

Content-Type: application/json

Параметры запроса

Все поля являются обязательными

Параметр Тип данных Описание
entity_id int ID сущности, к которой привязан контакт с чатом, или самого контакта с чатом
entity_type string Тип сущности, ID которой передали. Возможные значения: leads, contacts, customers

Пример тела запроса

{
    entity_id: 76687686,
    entity_type: "leads"
}

Заголовок типа данных при успешном результате

Content-Type: text/html

Заголовок типа данных при ошибке

Content-Type: application/problem+json

HTTP коды ответа

Код ответа Условие
202 Задача была успешно создана
400 Переданы некорректные данные. Подробности доступны в теле ответа
401 Пользователь не авторизован
403 Не хватает прав для вызова данного метода для указанной сущности
404 Salesbot с таким ID не найден

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

Метод не возвращает тело ответа при успешном запросе.

Групповой запуск Salesbot

Метод

POST /api/v4/bots/run

Описание

Метод для группового запуска Salesbot.

Ограничения

Можно отправить не более 100 задач за раз. Метод доступен в соответствии с правами пользователя.

Заголовок запроса

Content-Type: application/json

Параметры запроса

Все поля являются обязательными

Параметр Тип данных Описание
bot_id int ID бота, которого нужно запустить
entity_id int ID сущности, к которой привязан контакт с чатом, или самого контакта с чатом
entity_type string Тип сущности, ID которой передали. Возможные значения: leads, contacts, customers

Пример запроса

[
    {
        bot_id: 565,
        entity_id: 76687686,
        entity_type: "leads"
    },
    {...}
]

Заголовок типа данных при успешном результате

Content-Type: text/html

Заголовок типа данных при ошибке

Content-Type: application/problem+json

HTTP коды ответа

Код ответа Условие
202 Задачи были успешно созданы
400 Переданы некорректные данные. Подробности доступны в теле ответа
401 Пользователь не авторизован
403 Не хватает прав для вызова данного метода для указанной сущности
404 Salesbot с таким ID не найден

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

Метод не возвращает тело ответа при успешном запросе.

Остановка Salesbot

Метод

POST /api/v4/bots/{id}/stop

Описание

Метод для остановки Salesbot.

Заголовок типа данных при ошибке

Content-Type: application/problem+json

Параметры запроса

Все поля являются обязательными.

Параметр Тип данных Описание
entity_id int ID сущности
entity_type string Тип сущности, ID которой передали. Возможные значения: leads

Пример запроса

{
  "entity_id": 23890022,
  "entity_type": "leads"
}

HTTP коды ответа

Код ответа Условие
202 Задачи были успешно созданы
400 Переданы некорректные данные. Подробности доступны в теле ответа
401 Пользователь не авторизован
403 Не хватает прав для вызова данного метода для указанной сущности

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

Метод не возвращает тело ответа при успешном запросе.