Метод GetHistory
Примените этот метод для просмотра всех коммуникаций в рассылке по заданным параметрам (если параметры не указаны, выводятся все коммуникации в рамках рассылки). Для этого выполните POST-запрос с входными параметрами к точке подключения, указанными ниже.
Точка подключения:
POST: https://api.exolve.ru/campaign/v1/GetHistory
Авторизация
Передайте следующие Заголовки HTTP для успешной авторизации.
| Имя | Тип | Описание |
|---|---|---|
| Authorization | string | API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения |
Входные параметры
Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.
| Параметр | Тип | Описание |
|---|---|---|
| campaign_id | uint64 | идентификатор рассылки |
| ids | array of uint64 | идентификаторы коммуникаций |
| to | string | номер получателя |
| operation_id | string | идентификатор уведомления (для SMS — message_id, для звонка ещё не реализовано) |
| date_to | string | дата отправки уведомления RFC-3339 / ISO-8601, от которой продолжать выборку |
| date_from | string | дата отправки уведомления RFC-3339 / ISO-8601, до которой начинать выборку |
| limit | uint32 | лимит выводимых данных |
| offset | uint32 | номер строки, с которой начинать выборку (начинается с 0) |
Выходные параметры
| Параметр | Тип | Описание |
|---|---|---|
| campaign_id | uint64 | идентификатор рассылки |
| call_list_id | uint64 | идентификатор списка получателей |
| items | HistoryItem | параметры коммуникации |
| limit | uint32 | лимит выводимых данных |
| offset | uint32 | номер строки, с которой начинается выборка (начинается с 0) |
| total | uint64 | количество коммуникаций |
HistoryItem
| Параметр | Тип | Описание |
|---|---|---|
| id | string | идентификатор коммуникации |
| to | string | номер получателя |
| from | string | номер/имя получателя |
| timezone | uint32 | часовой пояс получателя (по умолчанию 3 — UTC+3) |
| operation_id | string | идентификатор уведомления (для SMS — message_id, для звонка ещё не реализовано) |
| date | string | дата отправки уведомления |
| status | enum CallListStatus | статус коммуникации |
CallListStatus
| Параметр | Тип | Описание |
|---|---|---|
| 1 | enum | черновик |
| 2 | enum | выполняется |
| 3 | enum | остановлена пользователем |
| 4 | enum | в очереди |
| 5 | enum | начата |
| 6 | enum | завершено |
| 7 | enum | неуспешно |
| 8 | enum | недостаточно средств для отправки уведомления |
| 10 | enum | отменена пользователем |
Примеры
Входные параметры:
{
"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"
}
Возможные ошибки
| Код | Статус | Пример сообщения | Описание |
|---|---|---|---|
| 400 | Bad Request | token is empty | в запросе не передан API-ключ |
| 400 | Bad Request | couldn’t parse incoming jwt token: couldn’t parse token: invalid character ‘[character]’ looking for beginning of value | невалидный API-ключ |
| 404 | Not Found | couldn’t get info from campaign by id = [id]: campaign not found | в приложении не найдена рассылка с указанным ID |
| 400 | Bad Request | invalid GetHistoryRequest.CampaignId: value must be greater than 0 | поле campaign_id и его значение отсутствуют в запросе |
| 400 | Bad Request | invalid character ‘[character]’ looking for beginning of value | невалидное значение в поле campaign_id |
| 400 | Bad Request | invalid value for uint64 type: ‘[value]’ | невалидное или пустое значение в поле campaign_id с типом uint64 |
| 401 | Unauthorized | invalid token | невалидный API-ключ |
| 404 | Not Found | Not Found | некорректный URL-адрес запроса |