GetHistory

Метод 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 номер получателя
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 номер получателя
timezone uint32 часовой пояс получателя (по умолчанию 3 - UTC+3)
status enum CallListStatus статус коммуникации

CallListStatus

Параметр Тип Описание
CALL_LIST_STATUS_DRAFT enum черновик
CALL_LIST_STATUS_IS_PROGRESS enum в процессе выполнения
CALL_LIST_STATUS_IS_STOP enum остановлена пользователем
CALL_LIST_STATUS_IS_QUEUE enum в очереди
CALL_LIST_STATUS_IS_RUN enum начата
CALL_LIST_STATUS_IS_FINISHED enum закончена
CALL_LIST_STATUS_FAILED enum неуспешна
CALL_LIST_STATUS_PROHIBITED enum недостаточно средств для выполнения коммуникации
CALL_LIST_STATUS_EXTERNAL enum ошибка отправки на сервисе
CALL_LIST_STATUS_REMOTELY enum отменена пользователем

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

Код Статус Пример сообщения Описание
404 Not Found Not Found некорректный URL-адрес запроса
401 Unauthorized invalid token невалидный API-ключ
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

Примеры

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

{
    "campaign_id": 129886921253588992
}

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

{
    "campaign_id": "129886921253588992",
    "call_list_id": "129886921245200384",
    "items": [
        {
            "id": "129928904844120064",
            "to": "79991112233",
            "timezone": 3,
            "status": "CALL_LIST_STATUS_IS_PROGRESS"
        },
        {
            "id": "129928904844120065",
            "to": "79995556677",
            "timezone": 3,
            "status": "CALL_LIST_STATUS_IS_FINISHED"
        }
    ],
    "limit": 3000,
    "total": "2"
}

Содержание статьи