Chatterfy API — что это и с чего начать

Chatterfy API — это способ подключить к Chatterfy вашу собственную программу, таблицу, CRM или AI-ассистента. Через API программа делает то же, что вы делаете руками в приложении: смотрит чаты, читает

Обновлено 2 ноября 2026 г.4 мин

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

API простыми словами

Представьте окно выдачи в кафе. Вы подаёте записку с заказом, на кухне готовят и возвращают поднос. API — такое окно в Chatterfy: ваша программа отправляет запрос («покажи чаты бота»), а Chatterfy возвращает ответ с данными.

Словарь API: ключ, сервисный аккаунт, эндпоинт, JSON, id

Слова, которые встречаются в статьях про Chatterfy API. Запоминать их не нужно — возвращайтесь к таблице, когда встретите незнакомое.

Слово	Что значит
Запрос	Сообщение вашей программы в Chatterfy: адрес, метод и, если нужно, данные.
Ответ	То, что возвращает Chatterfy: данные в формате JSON и код ответа. Код `200` значит, что всё получилось.
API-ключ	Пароль для программы — длинная строка, которая начинается с `cfy_prod_`. По ключу Chatterfy понимает, кто спрашивает и что ему можно.
Сервисный аккаунт	Отдельный «сотрудник-робот» в вашей компании. Ключ принадлежит ему, а не вам. У него своя роль и свой доступ к Space.
Эндпоинт	Адрес конкретного действия. Например, `/chats/v1/search` — найти чаты.
JSON	Текстовый формат данных вида `{"name": "Анна"}`. Его понимают и люди, и программы.
id	Уникальный номер объекта: компании, бота, чата, сообщения. Почти каждый запрос просит какой-нибудь id.

Что можно сделать через API

Задача	Как это выглядит	Инструкция
Читать чаты и переписку	Список чатов бота, поиск по имени, вся история сообщений	Как получить чаты и сообщения через API
Отвечать клиентам	Отправить текст, фото или документ, ответить на сообщение, запланировать отправку	Как отправить сообщение клиенту через API
Менять чат	Сменить статус, назначить ответственного, поставить тег, заполнить поле	Как изменить чат через API: статус, теги, ответственный, поля
Находить нужные чаты	Непрочитанные, без ответа, с тегом, за период, по UTM-метке	Фильтры чатов в API
Выгружать данные	Забрать все чаты в таблицу или в свою базу	Как выгрузить все чаты через API
Узнавать о событиях сразу	Получать новые сообщения без постоянных повторных запросов	Новые сообщения в реальном времени через API
Смотреть цифры	Новые и активные чаты, нагрузка и скорость ответа операторов, кампании и лиды Tracker	Аналитика и Tracker через API

Чего API не умеет

Часть действий доступна только в приложении Chatterfy. Через API нельзя:

приглашать людей, менять их роли и права;

создавать ботов, сценарии и кампании Tracker;

работать с оплатой и балансом;

загружать файлы — файл передаётся только ссылкой на него;

получать уведомления от Chatterfy на свой адрес (вебхуки). Вместо них используйте подписку на события в реальном времени — Новые сообщения в реальном времени через API — или регулярные запросы.

Как устроен любой запрос к API

У каждого запроса к API четыре части: метод, адрес, заголовки и тело. Разберите их один раз — дальше во всех статьях будет то же самое.

POST

https://api.chatterfy.ai/public-api/chats/v1/search

Найти чаты бота

Часть	Пример	Что это
Метод	`POST`	Тип действия: `GET` — получить, `POST` — найти или создать, `PATCH` — изменить, `DELETE` — удалить.
Адрес	`https://api.chatterfy.ai/public-api/chats/v1/search`	Общее начало `https://api.chatterfy.ai/public-api` и путь действия. `v1` — версия.
Заголовки	`ApiKey: cfy_prod_...` и `Content-Type: application/json`	Ключ и формат данных. Ключ передаётся именно в заголовке `ApiKey`.
Тело	`{"bot_id": "..."}`	Данные запроса в JSON. У запросов `GET` и `DELETE` тела нет.

Списки запрашиваются методом POST

Чаты, ботов, сообщения и Space ищут методом POST по адресу, который заканчивается на /search. Фильтры и количество записей передаются в теле запроса.