GetHistory

Метод GetHistory

Примените этот метод для просмотра всех коммуникаций в рассылке по заданным параметрам (если параметры не указаны, выводятся все коммуникации в рамках рассылки). Для этого выполните POST-запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/campaign/v1/GetHistory

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

ИмяТипОписание
AuthorizationstringAPI-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения

Входные параметры

Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

ПараметрТипОписание
campaign_iduint64идентификатор рассылки
idsarray of uint64идентификаторы коммуникаций
tostringномер получателя
operation_idstringидентификатор уведомления (для SMS — message_id, для звонка ещё не реализовано)
date_tostringдата отправки уведомления RFC-3339 / ISO-8601, от которой продолжать выборку
date_fromstringдата отправки уведомления RFC-3339 / ISO-8601, до которой начинать выборку
limituint32лимит выводимых данных
offsetuint32номер строки, с которой начинать выборку (начинается с 0)

Выходные параметры

ПараметрТипОписание
campaign_iduint64идентификатор рассылки
call_list_iduint64идентификатор списка получателей
itemsHistoryItemпараметры коммуникации
limituint32лимит выводимых данных
offsetuint32номер строки, с которой начинается выборка (начинается с 0)
totaluint64количество коммуникаций

HistoryItem

ПараметрТипОписание
idstringидентификатор коммуникации
tostringномер получателя
fromstringномер/имя получателя
timezoneuint32часовой пояс получателя (по умолчанию 3 — UTC+3)
operation_idstringидентификатор уведомления (для SMS — message_id, для звонка ещё не реализовано)
datestringдата отправки уведомления
statusenum CallListStatusстатус коммуникации

CallListStatus

ПараметрТипОписание
1enumчерновик
2enumвыполняется
3enumостановлена пользователем
4enumв очереди
5enumначата
6enumзавершено
7enumнеуспешно
8enumнедостаточно средств для отправки уведомления
10enumотменена пользователем

Примеры

Входные параметры:

{
    "campaign_id": 129886921253588992
}

Выходные параметры:

{
    "campaign_id": "129886921253588992",
    "call_list_id": "129886921245200384",
    "items": [
        {
            "id": "129928904844120064",
            "to": "79991112233",
            "from": "Exolve",
            "timezone": 3,
            "operation_id": "603251350989474631",
            "date": "2026-01-22T15:23:55.356227Z",
            "status": "2"
        },
        {
            "id": "129928904844120065",
            "to": "79995556677",
            "timezone": 6,
            "operation_id": "603251350989474632",
            "date": "2026-01-22T15:27:33.356227Z",
            "status": "6"
        }
    ],
    "limit": 3000,
    "total": "2"
}

Возможные ошибки

КодСтатусПример сообщенияОписание
400Bad Requesttoken is emptyв запросе не передан API-ключ
400Bad Requestcouldn’t parse incoming jwt token: couldn’t parse token: invalid character ‘[character]’ looking for beginning of valueневалидный API-ключ
404Not Foundcouldn’t get info from campaign by id = [id]: campaign not foundв приложении не найдена рассылка с указанным ID
400Bad Requestinvalid GetHistoryRequest.CampaignId: value must be greater than 0поле campaign_id и его значение отсутствуют в запросе
400Bad Requestinvalid character ‘[character]’ looking for beginning of valueневалидное значение в поле campaign_id
400Bad Requestinvalid value for uint64 type: ‘[value]’невалидное или пустое значение в поле campaign_id с типом uint64
401Unauthorizedinvalid tokenневалидный API-ключ
404Not FoundNot Foundнекорректный URL-адрес запроса