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

Оглавление

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

• Список Salesbot

• Запуск Salesbot

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

• Остановка Salesbot

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

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

Список Salesbot

Метод

GET /api/v4/bots

Описание

Метод позволяет получить список Salesbot в аккаунте.

Ограничения

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

GET параметры

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

Content-Type: application/hal+json

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

Content-Type: application/problem+json

HTTP коды ответа

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

Метод возвращает коллекцию моделей Salesbot, рассмотрим ниже свойства бота.

Параметры для GET-параметра with

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

{
    "_total_items": 1,
    "_page": 1,
    "_page_count": 1,
    "_links": {
        "self": {
            "href": "https://example.amocrm.ru/api/v4/bots/?page=1&limit=250"
        }
    },
    "_embedded": {
        "items": [
            {
                "id": 250704,
                "name": "Salesbot #1",
                "type_functionality": "regular",
                "is_visual_editor": true,
                "settings": {
                    "active": true,
                },
                "_links": {
                    "self": {
                        "href": "https://example.amocrm.ru/api/v4/bots/250704/?page=1&limit=250"
                    }
                }
            }
        ]
    }
}

Запуск Salesbot

Метод

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

Описание

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

Ограничения

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

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

Content-Type: application/json

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

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

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

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

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

Content-Type: text/html

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

Content-Type: application/problem+json

HTTP коды ответа

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

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

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

Метод

POST /api/v4/bots/run

Описание

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

Ограничения

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

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

Content-Type: application/json

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

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

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

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

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

Content-Type: text/html

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

Content-Type: application/problem+json

HTTP коды ответа

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

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

Остановка Salesbot

Метод

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

Описание

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

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

Content-Type: application/problem+json

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

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

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

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

HTTP коды ответа

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

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