NN Agent
Overview

Как запустить первую кампанию по API

Перед началом подключите хотя бы один аккаунт — см. Подключить аккаунт по API.

1
Создайте кампанию
curl -X POST https://api.nexifyneo.com/v2/campaigns \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d 'YOUR_JSON_BODY'

В ответе вернётся идентификатор кампании в формате UUID. Дальше он подставляется в путь всех остальных запросов.

2
Загрузите базу контактов

Контакты загружаются файлом, а не построчно. Поддерживаются CSV и XLSX; формат указывается параметром запроса format, по умолчанию csv.

curl -X POST "https://api.nexifyneo.com/v2/campaigns/CAMPAIGN_ID/contacts/upload?format=csv" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file=@contacts.csv"

Проверить, что база встала, можно сводкой: GET /v2/campaigns/{campaign_id}/contacts/stats.

3
Наполните пул первых сообщений
curl -X POST https://api.nexifyneo.com/v2/campaigns/CAMPAIGN_ID/message-pool \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d 'YOUR_JSON_BODY'

Добавьте несколько вариантов, а не один. NN Agent берёт из пула текст для очередного контакта, и это единственный способ не отправить всей базе один и тот же текст символ в символ.

4
Привяжите аккаунты
curl -X POST https://api.nexifyneo.com/v2/campaigns/CAMPAIGN_ID/accounts \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d 'YOUR_JSON_BODY'

С привязанных аккаунтов пойдут исходящие. Отвязка выполняется тем же адресом методом DELETE.

5
Проверьте состав кампании
curl https://api.nexifyneo.com/v2/campaigns/CAMPAIGN_ID \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Сверьте, что у кампании есть контакты, пул сообщений и хотя бы один аккаунт. Кампания без пула или без аккаунта отправлять не с чего и нечего.

Как запускается отправка#

Отдельной операции «запустить кампанию» опубликованная спецификация не объявляет. Запуск выполняется обновлением кампании (POST /v2/campaigns/{campaign_id}/update) либо из кабинета; какие именно поля меняет запуск, уточните у менеджеров в боте @nn_official_bot.

Что дальше происходит с диалогами#

После первого касания разговор ведёт AI по вашему сценарию — см. Чат-флоу. Переписку можно читать и продолжать вручную через операции диалогов.

Выгрузить базу с результатами обратно: GET /v2/campaigns/{campaign_id}/contacts/export?format=xlsx.

Дальше#

Updated

Работает на Docsbook
Как запустить первую кампанию по API — NN Agent