GetFileInfo

Метод GetFileInfo

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

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

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

Авторизация

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

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

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

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

Параметр Тип Описание
campaign_id uint64 идентификатор рассылки
file_id uint64 идентификатор загруженного файла

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

Параметр Тип Описание
id uint64 идентификатор загруженного файла
name string наименование загруженного файла
status enum FileStatus статус загрузки файла
amount_contacts uint64 количество загруженных контактов (значение передаётся только в статусе FILE_STATUS_VERIFIED)

FileStatus

Параметр Тип Описание
1 enum идёт загрузка файла
2 enum файл загружен
3 enum файл в стадии валидации
4 enum ошибка валидации (ошибки в полях number/timezone, доступно скачивание файла с ошибками)
5 enum ошибка загрузки файла (неверный формат файла, некорректные заголовки)
6 enum файл загружен, валидация завершена
7 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-ключ
400 Bad Request invalid GetFileInfoRequest.CampaignId: value must be greater than 0 поле campaign_id и его значение отсутствуют в запросе
400 Bad Request invalid GetFileInfoRequest.FileId: value must be greater than 0 поле file_id и его значение отсутствуют в запросе
400 Bad Request invalid character ‘[character]’ looking for beginning of value невалидное или пустое значение в одном из полей
400 Bad Request invalid value for uint64 type: ‘[value]’ невалидное или пустое значение в одном из полей с типом uint64
400 Bad Request invalid character " after object key:value pair в запросе пропущена запятая в одном из параметров

Примеры

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

{
    "campaign_id": 129931120807677952,
    "file_id": 130798251019812864
}

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

{
    "id": "130798251019812864",
    "name": "contacts.csv",
    "status": "3",
    "amount_contacts": "2"
}

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