Кампании и контакты в API
Кампания собирается из трёх частей: контакты, пул вариантов первого сообщения и привязанные аккаунты. Ниже операции версии v2; идентификатор клиента подставляется по токену.
Кампании#
/v2/campaignsСписок кампаний клиента.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
/v2/campaignsСоздать кампанию. Тело запроса — JSON.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
/v2/campaigns/{campaign_id}Карточка кампании.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID кампании
/v2/campaigns/{campaign_id}/updateИзменить параметры кампании. Тело запроса — JSON.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID кампании
/v2/campaigns/{campaign_id}Удалить кампанию вместе с её контактами и пулом сообщений.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID кампании
Аккаунты кампании#
/v2/campaigns/{campaign_id}/accountsПривязать аккаунты к кампании: с них пойдут исходящие. Тело запроса — JSON.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID кампании
/v2/campaigns/{campaign_id}/accountsОтвязать аккаунты от кампании. Тело запроса — JSON.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID кампании
Контакты#
Контакты кампании загружаются файлом и выгружаются в том же формате. Параметр format принимает только csv или xlsx, по умолчанию csv.
/v2/campaigns/{campaign_id}/contacts/uploadЗагрузить базу контактов файлом. Тело запроса — multipart/form-data с полем file.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID кампании
csv или xlsx, по умолчанию csv
/v2/campaigns/{campaign_id}/contactsСписок контактов кампании.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID кампании
/v2/campaigns/{campaign_id}/contacts/statsСводка по контактам кампании.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID кампании
/v2/campaigns/{campaign_id}/contacts/exportВыгрузить контакты кампании файлом.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID кампании
csv или xlsx, по умолчанию csv
/v2/campaigns/{campaign_id}/contactsОчистить базу контактов кампании.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID кампании
Пул сообщений#
Пул хранит варианты первичного сообщения. NN Agent берёт из него текст для очередного контакта, поэтому одинаковый текст не уходит всей базе подряд.
/v2/campaigns/{campaign_id}/message-poolСписок вариантов первого сообщения кампании.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID кампании
/v2/campaigns/{campaign_id}/message-poolДобавить вариант сообщения в пул. Тело запроса — JSON.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID кампании
/v2/campaigns/{campaign_id}/message-pool/{message_id}Удалить один вариант из пула.
Отправляется в заголовке Authorization. Ваш ключ используется только вашим браузером для этого запроса — он никогда не отправляется в Docsbook и не сохраняется.
UUID кампании
UUID варианта сообщения
Дальше#
- Запустить первую кампанию по API — порядок вызовов целиком.
- Диалоги — что происходит после отправки первого сообщения.
- AI Outreach — та же механика в кабинете.