Аккаунты в API и сессии авторизации
Аккаунт — подключённый аккаунт мессенджера, от имени которого NN Agent пишет и читает. Подключение идёт через сессию авторизации: вы открываете сессию, мессенджер присылает код, вы передаёте код в сессию.
Все запросы требуют bearer-токен, см. Авторизацию.
Сессии авторизации#
/v2/accounts/auth-sessionsОткрыть сессию авторизации по номеру телефона. Возвращает идентификатор сессии, к которому дальше привязываются код и пароль. Тело запроса — JSON.
Отправляется как заголовок Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
/v2/accounts/auth-sessions/qrОткрыть сессию авторизации по QR-коду — альтернатива коду из сообщения. Тело запроса — JSON.
Отправляется как заголовок Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
/v2/accounts/auth-sessions/{auth_id}Состояние сессии: ждёт код, ждёт пароль, завершена, отклонена. Опрашивайте эту операцию между шагами подключения.
Отправляется как заголовок Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID сессии авторизации
/v2/accounts/auth-sessions/{auth_id}/codeПередать код подтверждения, который мессенджер прислал на номер. Тело запроса — JSON.
Отправляется как заголовок Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID сессии авторизации
/v2/accounts/auth-sessions/{auth_id}/passwordПередать облачный пароль, если у аккаунта включена двухфакторная защита. Тело запроса — JSON.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID сессии авторизации
/v2/accounts/auth-sessions/{auth_id}/resend-codeЗапросить повторную отправку кода подтверждения.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID сессии авторизации
/v2/accounts/auth-sessions/{auth_id}Прервать незавершённую сессию авторизации.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID сессии авторизации
Пошаговый разбор этой последовательности — Подключить аккаунт по API.
Аккаунты#
/v2/accountsСписок подключённых аккаунтов клиента. Клиент определяется по токену.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
/v2/accounts/{account_id}Карточка одного аккаунта.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID аккаунта
/v2/accounts/{account_id}/updateИзменить параметры аккаунта. Тело запроса — JSON.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID аккаунта
/v2/accounts/{account_id}Отключить аккаунт от NN Agent.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID аккаунта
Привязка аккаунтов к кампании#
Аккаунты сами по себе ничего не рассылают — они привязываются к кампании. Операции привязки и отвязки описаны на странице Кампании и контакты.
Дальше#
- Подключить аккаунт по API — порядок вызовов целиком.
- Диалоги — что читать и отправлять после подключения.
- Мульти-аккаунтинг — та же механика в кабинете.
Updated