NN Agent
Overview

Как подключить аккаунт мессенджера по API

Перед началом получите bearer-токен, см. Авторизацию.

1
Откройте сессию авторизации
curl -X POST https://api.nexifyneo.com/v2/accounts/auth-sessions \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d 'YOUR_JSON_BODY'

В ответе вернётся идентификатор сессии в формате UUID. Все следующие шаги адресуются им, а не идентификатором аккаунта: аккаунта пока не существует.

Альтернатива для входа по QR-коду вместо кода из сообщения — POST /v2/accounts/auth-sessions/qr.

2
Дождитесь, пока мессенджер пришлёт код

Опрашивайте состояние сессии, пока она не перейдёт в ожидание кода:

curl https://api.nexifyneo.com/v2/accounts/auth-sessions/AUTH_ID \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Если код не пришёл, запросите повторную отправку: POST /v2/accounts/auth-sessions/{auth_id}/resend-code.

3
Передайте код подтверждения
curl -X POST https://api.nexifyneo.com/v2/accounts/auth-sessions/AUTH_ID/code \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d 'YOUR_JSON_BODY'

После этого снова проверьте состояние сессии: она либо завершится успехом, либо запросит облачный пароль.

4
Передайте облачный пароль, если включена двухфакторная защита
curl -X POST https://api.nexifyneo.com/v2/accounts/auth-sessions/AUTH_ID/password \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d 'YOUR_JSON_BODY'

Этот шаг нужен только аккаунтам с двухфакторной защитой. Без неё сессия завершается сразу после кода.

5
Убедитесь, что аккаунт появился
curl https://api.nexifyneo.com/v2/accounts \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Новый аккаунт присутствует в списке со своим UUID. Этот UUID дальше используется для диалогов и для привязки к кампании.

Если что-то пошло не так#

  • Незавершённую сессию можно прервать: DELETE /v2/accounts/auth-sessions/{auth_id}.
  • Ответ 401 означает проблему с токеном, а не с аккаунтом — см. Авторизацию.
  • Обрыв на проверке TLS-сертификата не связан ни с токеном, ни с сессией: api.nexifyneo.com отдаёт самоподписанный сертификат, см. Известные ограничения.

Какие аккаунты подключать#

Для исходящих подключайте отдельные аккаунты, а не личные. Решение о блокировке принимает площадка, и при потере одного аккаунта переписка и контакты остаются в NN Agent — вы продолжите с другого. Разбор в частых вопросах.

Дальше#

Работает на Docsbook
Как подключить аккаунт мессенджера по API — NN Agent